1. Help Center
  2. ++ SSO and User Provisioning

User Provisioning via SCIM

Do you want to automatically create your users via an API ? Then, you must use our SCIM documentation! This page will give you tools and tips to create your users with SCIM.

SCIM Documentation : here

 

The SCIM API of SRXP is available in the link above. It will be necessary to guide you during the implementation to automate your user provisioning. 

 

When and why would you use this API ?

If you want to automate your user management and directly link it with your HR management tool (or other tools), then you will need to build a connection to SRXP to do this management. 

 

What is important?

Creating a new user (or updating a user) will only be possible, if the API call is authenticated with the credential of an existing user, with Administrator right, and if there is enough place available in the subscription. 

 

How to do?

POST to the following URL and complete <customerId> with the customer ID of your company.

POST - https://portal.srxp.com/api/1/customers/<customerId>/scim/2

You can use the following structure as a base to add your user. 

Do not forget to complete the field in , with the information of the user. For more details, please refer to the SCIM Documentation

{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:ietf:params:scim:schemas:extension:srxp:2.0:ApproverEmail"
],
"password": "<Password>",
"userName": "<userName>",
"externalId": "<externalid>",
"name": {
"familyName": "<family_name>",
"givenName": "<first_name>"
},
"emails": [{
"primary": true,
"type": "work",
"value": "<email>"
}],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"division": "<Establishment>"
},
"userType": "<JobTitle>",
"active": false,
"roles": [
"is_approver",
"is_exporter",
"is_reporter"
],
"urn:ietf:params:scim:schemas:extension:srxp:2.0:ApproverEmail": {
"approverEmail": "<approverEmailThatMustExists>"
},
"urn:ietf:params:scim:schemas:extension:srxp:2.0:FreeFieldOne": {
"freeFieldOne": "<freeFieldOne>"
},
"urn:ietf:params:scim:schemas:extension:srxp:2.0:FreeFieldTwo": {
"freeFieldTwo": "<freeFieldTwo>"
},
"urn:ietf:params:scim:schemas:extension:srxp:2.0:FreeFieldThree": {
"freeFieldThree": "<freeFieldThree>"
}
}

After creating a user, the API will return an ID. 

Save this ID to update the user in the future.