Add User

 

Endpoint

Method

Endpoint

Method

/scim/Users

POST

 

Request-object:

{ "externalId": "<unique-identifier-in-source-system>", "userName": "<unique-email>", "active": <true|false>, "name": { "familyName": "<lastname>", "givenName": "<firstname>" } }



Property

Type

Required

 

Property

Type

Required

 

externalId

string

Yes

Id of entity in remote system.
Must be unique pr integration.

2 users with same externalid cannot exist at the same time for the same integration

userName

string

Yes

Username for user.
Must be an email.

Must be unique pr integration

active

boolean
Valid values: true | false

No

Activationstatus for account.
Defaults to false if not set

name.familyName

string

No

Lastname

name.givenName

string

No

Firstname

 

 

 

 



Sample-Request:

curl --location --request POST 'https://[API-URL]/scim/Users' \ --header 'Authorization: Bearer [AUTH-TOKEN]' \ --header 'Content-Type: application/json' \ --data-raw '{ "externalId": "16861ac5-deaa-4d66-a4cc-bc788965cc37", "userName": "username@domain.com", "active": true, "name": { "familyName": "Doe", "givenName": "John" } }'


Responses:

User registered

User registered

Statuscode

201

Response-body: The generated User

Sample-response:

{     "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {},     "active": true,     "meta": {         "resourceType": "User"     },     "name": {         "familyName": "Doe",         "givenName": "John"     },     "userName": "username@domain.com",     "externalId": "26861ac5-deaa-4d66-a4cc-bc788965cc37",     "id": "a3792aca-8f99-4d4b-a1f2-2b31e871b634",     "schemas": [] }

 

 





Conflict

Conflict

Statuscode

409

Response-body: Error-details

Sample-response: