Third-party authentication lets you register new users outside iCompleat using API, & can eliminate the need for multiple login accounts if a customer exists in another system.
iCompleat creates the start of an authentication process by providing a secret token which, coupled with a tenantID, creates a user in iCompleat.
Follow these steps to set up third party authentication.
- On the homepage, click Configuration.
- Click Manage users.
- Click Configure Authentication Options.
- Authentication options for the company appear.
Click Use a third-party application for user registration.
- An Authentication Endpoint URL & 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.
- (Optional) Switch on the Create user toggle to create a new user (the user can't already exist as a user in iCompleat). This is based on their email address.
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 & use the POST method to add the user to your company.
The tenant ID & 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” & 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 & permissions. Once this is done, the new user is fully operational & 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.