Overview of User Management using the Assure Customer API
The Assure Customer API can be used to automate the processes of managing users in Assure. The API is accessed via the internet as a secure RESTful API which is widely supported by integration platforms, ETL tools, and all programming and scripting languages, so it can be easily set up to integrate with external systems. Making use of the Customer API requires a level of technical expertise so this is typically something that a company’s IT function would handle.
The API functionality must be enabled by the Evotix team before you can use it. Please contact your CDM (Customer Development Manager) or CSM (Customer Success Manager) should you be interested in procuring this feature.
HOW DOES IT WORK?
With the Customer API you can:
-
Create new users
-
Update existing users including deactivating users
-
Delete users
Each of these operations requires you to make a request to the Customer API. A detailed user guide and supporting API schema will be provided detailing the API methods and the information required to use them.
WHAT DETAILS HAVE TO BE PROVIDED?
The minimum required fields are:
-
Username
-
Full Name
-
Email - a valid email address is required. The User will receive an email with a link to set up their password, unless using SSO
-
Default Org Unit External ID - requires External IDs to be setup for your Organisation Units
Other fields that can be set and will be defaulted if not supplied:
-
Linked Person Record
-
Masked Org Unit External ID
-
Supervisor Privilege
-
Roles – multiple roles can be set up for various parts of the organisation hierarchy
-
Type of user – defaults to Assure and AssureGO+ user
-
Is Manager – defaults to not a manager
-
User Specific Timezone – defaults to your configured default timezone
-
Language – defaults to your configured default language
-
Date Format – defaults to DD/MM/YYYY
-
Insights+ access – defaults to none
-
Send Password Reset
-
Requires Password Change
When updating a user, you can also specify if a password reset should be sent to the user’s email. And you can specify whether the user must change their password when they next login to Assure.
OUT OF SCOPE
The following elements are currently out of scope:
-
Configuring dashboards to the user, these can be manually added via Assure once the user has been created.
SETTING UP THE API
-
Before you can get started you need to request access from Evotix through your Customer Development or Customer Success Manager.
-
You can create and manage your API authentication keys at any time in Assure. Check out this article for details API Key Management Article
-
Set up the Customer API. Access the user guide here Assure Customer API User Guide
-
Set up the User Management API. Access the user guide here Customer API User Guide – User Management API