SCIM (AAD) Integration
Follow these steps to start SCIM connection with Engage.
1. Inform Engage Support that your company wants to utilise the SCIM connection.
2. Once Engage has activated the SCIM connection for your company you can generate a long lived secret token from your Engage portal.
To do that, you need to go to customer admin / organisation / companies / view and go to the SCIM User Provisioning tab. Click on the Generate Token button as below.
The tenant URL is https://portal.engagesolutions.app/scim
3. To start the SCIM intergation from Microsoft Entra ID (Azure AD), please follow the following steps:
a. Go to Enterprise applications
b. Create your own application
c. Enter name for the app and choose the option Integrate any other application you don't find in the gallery (Non-gallery)
d. Go to provisioning and select get started
e. Set Provisioning mode to automatic. Enter Tenant URL and secret token provided from Engage
4. The attribute mappings for Engage are as below:
Engage Records | Entra ID attributes |
Employee ID | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber OR urn:ietf:params:scim:schemas:extension:custom:2.0:User:employeeNumber This is primary matching field. Set Matching precedence to 1. Remove matching precedence for any other column |
Role and Job Title | title |
First Name | name.givenName |
Last Name | name.familyName |
Preferred Name | name.formatted |
username | |
Street Address | addresses[type eq "work"].streetAddress |
City | addresses[type eq "work"].locality |
State | addresses[type eq "work"].region |
Postcode | addresses[type eq "work"].postalCode |
Country | addresses[type eq "work"].country |
Mobile | phoneNumbers[type eq "work"].value |
Mobile Personal | phoneNumbers[type eq "mobile"].value |
Joining Date | startDate |
Branch ID | addresses[type eq "work"].formatted. Use the branch code from Engage |
Department | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department. Use Department code from Engage |
Cost Centre | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:costCenter |
Delivery Centre | deliverycenterId |
Manager | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager |
Employment Type | EmployeeType |
Status | active |
Once up and running, you can check your SCIM logs on Engage by going to :
https://portal.engagesolutions.app/employee/scim_logs
We hold all GET requests for seven days and POST, PATCH, DELETE requests for one month.
