Use API to authenticate and register iCompleat users with existing login credentials

Third Party authentication is a great solution if you and your team hold login credentials in an existing system.

It's really easy to authenticate and register your users using iCompleat API. iCompleat creates the start of an authentication process by providing a secret token which, coupled with a tenantID, creates a user in iCompleat.

In this guide, we show you how to set up third party authentication with iCompleat API, including examples in Postman.

Set up third party authentication with API

1. On the homepage, click Configuration.
2. Click Users.
3. Click Configure Authentication Options.
4. Authentication options for the company appear.
   Click Use a third-party application for user registration.
5. An Authentication Endpoint URL and a Shared Secret token appear.
   iCompleat provides a 'Body' data sample. This can be used in a custom integration, enabling you to register users from data sources like a web form or database.
6. (Optional) Switch on the Create user toggle to create a new user.

   The user can't already exist as a user in iCompleat.

Example (using Postman)

Using the body data provided in iCompleat, we’re using the Postman API application to test this feature.

Simply populate the body data and use the POST method to add the user to your company.

The tenant ID and shared secret should be kept confidential to prevent any data breaches.

Once sent, if the user already exists, this will return a result of “true” and generate a URL which, once entered into a browser, will instantly log in the user.

If this is a new user, they'll be added to iCompleat, but won't have any permissions. You'll need to go into their profile in iCompleat & assign them a company, as well as roles and permissions. Once this is done, the new user is fully operational and ready to use iCompleat.

An admin user who manages the account will have to set up the right permissions for the new user in order for them to begin using iCompleat.

 Still got questions? Comment below and let us know how we can improve this article.