This article explains how to use the Assure Customer API (a secure RESTful API that enables automated integration with Assure) to create, update, deactivate, and delete user accounts in Assure. It covers what the API can and cannot do, the minimum required fields, optional fields and their defaults, password management options, what is out of scope, and the steps to set up the API. The Customer API functionality must be enabled by Evotix before use and requires a level of technical expertise. This article applies to the User Management area of Assure.
Overview
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.
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.
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.
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.
- 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
API Methods Reference
| Operation | HTTP Verb | Endpoint |
|---|---|---|
| Create user | POST | /v1/user |
| Partial update (specific fields only) | PATCH | /v1/user/{username} |
| Delete user | DELETE | /v1/user/{username} |
/v1/user/{username} API method with the DELETE verb. The user to be deleted is identified by their login username supplied via the {username} path parameter
AI Metadata
- Product Area: Assure - User Management, Customer API
- User Role: Technical Administrator (IT function), Assure System Administrator; requires API access enabled by Evotix
- Tags: Customer API, User Management, REST API, RESTful API, create user, update user, deactivate user, delete user, API integration, ETL, Org Unit, External ID, Supervisor Privilege, Insights+, AssureGO+, Person Register, SSO, password reset
- Version/Region: All Assure versions; all regions
-
Important Synonyms:
- Customer API = Assure Customer API = RESTful API
- Organisational Unit = Org Unit = Default Unit
- CDM = Customer Development Manager
- CSM = Customer Success Manager
- Insights+ = Insights Plus
- AssureGO+ = AssureGO Plus
- Person Register = Linked Person Record = People Register
- Deactivate = Make Not Current
- Suggested Embedding Keywords: Assure Customer API user management, create user API Assure, update user API Assure, deactivate user Assure API, delete user Assure API, API key Assure user, Assure REST API users, automate user creation Assure, External ID org unit Assure, Insights+ access API, Supervisor Privilege API Assure, password reset API Assure, AssureGO+ user type API
- Relevant Modules and Cross-Module Implications: This article is scoped to the User Management area of Assure. Users created or updated via the Customer API interact with Organisational Configuration (External IDs must be configured on Organisational Units before use), the Person Register (a Linked Person Record can be assigned via the API), and Insights+ (access level is settable via the API but defaults to none). Dashboard configuration is not managed by the API and must be applied manually in Assure. If SSO is in use, the email-based password setup flow is bypassed. This article does not cover the SCIM API (a separate integration method) or the Org Unit Management API.