Users

List Users

Authorizations:

query Parameters

count	string
startIndex	string
sortOrder	string
filter	string

Responses

Response samples

Content type

application/json

{"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 0,
"itemsPerPage": 0,
"startIndex": 0,
"Resources": [{"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"id": "60ad04c3fb3672005359a88b",
"externalId": "xxxxxxxxx",
"userName": "john.doe@example.com",
"name": {"givenName": "John",
"familyName": "Doe"
},
"active": true,
"meta": {"resourceType": "User",
"created": "2021-05-25T14:08:03.613Z",
"lastModified": "2021-05-25T14:08:03.613Z",
"location": ""
},
"displayName": "John Doe",
"profileUrl": "https://example.com/profile-url.png",
"title": "CEO",
"emails": [{"value": "john.doe@example.com",
"display": "john.doe@example.com",
"type": "work",
"primary": true
}
],
"phoneNumbers": [{"value": "+46000000000",
"type": "work",
"primary": true
}
],
"photos": [{"value": "https://example.com/profile-url.png",
"type": "photo"
}
],
"addresses": [{"streetAddress": "Street 1",
"locality": "Stockholm",
"region": "Stockholm County",
"postalCode": "12345",
"country": "SE",
"type": "home",
"primary": true
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {"employeeNumber": "100",
"costCenter": "CODE-1",
"organization": "AlexisHR",
"department": "Department 1",
"division": "Division 1",
"manager": {"value": "607e96e75673150031949100",
"$ref": "../Users/607e96e75673150031949100",
"displayName": "John's Manager"
}
},
"urn:ietf:params:scim:schemas:extension:alexis:2.0:User": {"team": ["Team 1"
],
"office": "Office 1",
"employmentType": "Permanent Employment",
"hireDate": "2022-10-24T15:34:21.011Z",
"endDate": "2022-10-24T15:34:21.011Z"
}
}
]
}

Create User

Authorizations:

bearer

Request Body schema: application/json

schemas required	Array of strings
externalId	string
userName required	string
required	object (SCIM2UserNameRequest)
active required	boolean
required	object (SCIM2MetaRequest)
displayName	string
profileUrl	string
title	string
required	Array of objects (SCIM2UserEmailRequest)
required	Array of objects (SCIM2UserPhoneNumberRequest)
required	Array of objects (SCIM2UserPhotoRequest)
required	Array of objects (SCIM2UserAddressRequest)
	object (SCIM2EnterpriseUserRequest)
	object (SCIM2AlexisUserRequest)

Responses

Request samples

Payload

Content type

application/json

{"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"externalId": "60ad04c3fb3672005359a88b",
"userName": "john.doe@example.com",
"name": {"givenName": "John",
"familyName": "Doe"
},
"active": true,
"meta": {"resourceType": "User",
"created": "2021-05-25T14:08:03.613Z",
"lastModified": "2021-05-25T14:08:03.613Z",
"location": ""
},
"displayName": "John Doe",
"profileUrl": "https://example.com/profile-url.png",
"title": "CEO",
"emails": [{"value": "john.doe@example.com",
"display": "john.doe@example.com",
"type": "work",
"primary": true
}
],
"phoneNumbers": [{"value": "+46000000000",
"type": "work",
"primary": true
}
],
"photos": [{"value": "https://example.com/profile-url.png",
"type": "photo"
}
],
"addresses": [{"streetAddress": "Street 1",
"locality": "Stockholm",
"region": "Stockholm County",
"postalCode": "12345",
"country": "SE",
"type": "home",
"primary": true
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {"costCenter": "CODE-1",
"organization": "AlexisHR",
"division": "Division 1",
"employeeNumber": "1",
"department": "Department 1",
"manager": {"value": "607e96e75673150031949100",
"$ref": "../Users/607e96e75673150031949100",
"displayName": "John's Manager"
}
},
"urn:ietf:params:scim:schemas:extension:alexis:2.0:User": {"team": ["Team 1"
],
"office": "Office 1",
"employmentType": "Permanent Employment",
"hireDate": "2022-10-24T15:34:21.011Z",
"endDate": "2022-10-24T15:34:21.011Z"
}
}

Response samples

Content type

application/json

{"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"id": "60ad04c3fb3672005359a88b",
"externalId": "xxxxxxxxx",
"userName": "john.doe@example.com",
"name": {"givenName": "John",
"familyName": "Doe"
},
"active": true,
"meta": {"resourceType": "User",
"created": "2021-05-25T14:08:03.613Z",
"lastModified": "2021-05-25T14:08:03.613Z",
"location": ""
},
"displayName": "John Doe",
"profileUrl": "https://example.com/profile-url.png",
"title": "CEO",
"emails": [{"value": "john.doe@example.com",
"display": "john.doe@example.com",
"type": "work",
"primary": true
}
],
"phoneNumbers": [{"value": "+46000000000",
"type": "work",
"primary": true
}
],
"photos": [{"value": "https://example.com/profile-url.png",
"type": "photo"
}
],
"addresses": [{"streetAddress": "Street 1",
"locality": "Stockholm",
"region": "Stockholm County",
"postalCode": "12345",
"country": "SE",
"type": "home",
"primary": true
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {"employeeNumber": "100",
"costCenter": "CODE-1",
"organization": "AlexisHR",
"department": "Department 1",
"division": "Division 1",
"manager": {"value": "607e96e75673150031949100",
"$ref": "../Users/607e96e75673150031949100",
"displayName": "John's Manager"
}
},
"urn:ietf:params:scim:schemas:extension:alexis:2.0:User": {"team": ["Team 1"
],
"office": "Office 1",
"employmentType": "Permanent Employment",
"hireDate": "2022-10-24T15:34:21.011Z",
"endDate": "2022-10-24T15:34:21.011Z"
}
}

Get User

Authorizations:

bearer

path Parameters

id

required

string

Responses

Response samples

Content type

application/json

{"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"id": "60ad04c3fb3672005359a88b",
"externalId": "xxxxxxxxx",
"userName": "john.doe@example.com",
"name": {"givenName": "John",
"familyName": "Doe"
},
"active": true,
"meta": {"resourceType": "User",
"created": "2021-05-25T14:08:03.613Z",
"lastModified": "2021-05-25T14:08:03.613Z",
"location": ""
},
"displayName": "John Doe",
"profileUrl": "https://example.com/profile-url.png",
"title": "CEO",
"emails": [{"value": "john.doe@example.com",
"display": "john.doe@example.com",
"type": "work",
"primary": true
}
],
"phoneNumbers": [{"value": "+46000000000",
"type": "work",
"primary": true
}
],
"photos": [{"value": "https://example.com/profile-url.png",
"type": "photo"
}
],
"addresses": [{"streetAddress": "Street 1",
"locality": "Stockholm",
"region": "Stockholm County",
"postalCode": "12345",
"country": "SE",
"type": "home",
"primary": true
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {"employeeNumber": "100",
"costCenter": "CODE-1",
"organization": "AlexisHR",
"department": "Department 1",
"division": "Division 1",
"manager": {"value": "607e96e75673150031949100",
"$ref": "../Users/607e96e75673150031949100",
"displayName": "John's Manager"
}
},
"urn:ietf:params:scim:schemas:extension:alexis:2.0:User": {"team": ["Team 1"
],
"office": "Office 1",
"employmentType": "Permanent Employment",
"hireDate": "2022-10-24T15:34:21.011Z",
"endDate": "2022-10-24T15:34:21.011Z"
}
}

Update User

Authorizations:

bearer

path Parameters

id

required

string

Request Body schema: application/json

schemas required	Array of strings
externalId	string
userName required	string
required	object (SCIM2UserNameRequest)
active required	boolean
required	object (SCIM2MetaRequest)
displayName	string
profileUrl	string
title	string
required	Array of objects (SCIM2UserEmailRequest)
required	Array of objects (SCIM2UserPhoneNumberRequest)
required	Array of objects (SCIM2UserPhotoRequest)
required	Array of objects (SCIM2UserAddressRequest)
	object (SCIM2EnterpriseUserRequest)
	object (SCIM2AlexisUserRequest)

Responses

Request samples

Payload

Content type

application/json

{"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"externalId": "60ad04c3fb3672005359a88b",
"userName": "john.doe@example.com",
"name": {"givenName": "John",
"familyName": "Doe"
},
"active": true,
"meta": {"resourceType": "User",
"created": "2021-05-25T14:08:03.613Z",
"lastModified": "2021-05-25T14:08:03.613Z",
"location": ""
},
"displayName": "John Doe",
"profileUrl": "https://example.com/profile-url.png",
"title": "CEO",
"emails": [{"value": "john.doe@example.com",
"display": "john.doe@example.com",
"type": "work",
"primary": true
}
],
"phoneNumbers": [{"value": "+46000000000",
"type": "work",
"primary": true
}
],
"photos": [{"value": "https://example.com/profile-url.png",
"type": "photo"
}
],
"addresses": [{"streetAddress": "Street 1",
"locality": "Stockholm",
"region": "Stockholm County",
"postalCode": "12345",
"country": "SE",
"type": "home",
"primary": true
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {"costCenter": "CODE-1",
"organization": "AlexisHR",
"division": "Division 1",
"employeeNumber": "1",
"department": "Department 1",
"manager": {"value": "607e96e75673150031949100",
"$ref": "../Users/607e96e75673150031949100",
"displayName": "John's Manager"
}
},
"urn:ietf:params:scim:schemas:extension:alexis:2.0:User": {"team": ["Team 1"
],
"office": "Office 1",
"employmentType": "Permanent Employment",
"hireDate": "2022-10-24T15:34:21.011Z",
"endDate": "2022-10-24T15:34:21.011Z"
}
}

Response samples

Content type

application/json

{"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"id": "60ad04c3fb3672005359a88b",
"externalId": "xxxxxxxxx",
"userName": "john.doe@example.com",
"name": {"givenName": "John",
"familyName": "Doe"
},
"active": true,
"meta": {"resourceType": "User",
"created": "2021-05-25T14:08:03.613Z",
"lastModified": "2021-05-25T14:08:03.613Z",
"location": ""
},
"displayName": "John Doe",
"profileUrl": "https://example.com/profile-url.png",
"title": "CEO",
"emails": [{"value": "john.doe@example.com",
"display": "john.doe@example.com",
"type": "work",
"primary": true
}
],
"phoneNumbers": [{"value": "+46000000000",
"type": "work",
"primary": true
}
],
"photos": [{"value": "https://example.com/profile-url.png",
"type": "photo"
}
],
"addresses": [{"streetAddress": "Street 1",
"locality": "Stockholm",
"region": "Stockholm County",
"postalCode": "12345",
"country": "SE",
"type": "home",
"primary": true
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {"employeeNumber": "100",
"costCenter": "CODE-1",
"organization": "AlexisHR",
"department": "Department 1",
"division": "Division 1",
"manager": {"value": "607e96e75673150031949100",
"$ref": "../Users/607e96e75673150031949100",
"displayName": "John's Manager"
}
},
"urn:ietf:params:scim:schemas:extension:alexis:2.0:User": {"team": ["Team 1"
],
"office": "Office 1",
"employmentType": "Permanent Employment",
"hireDate": "2022-10-24T15:34:21.011Z",
"endDate": "2022-10-24T15:34:21.011Z"
}
}

Patch User

Authorizations:

bearer

path Parameters

id

required

string

Request Body schema: application/json

schemas required	Array of strings
required	Array of SCIM2PatchAddReplaceOperationRequest (object) or SCIM2PatchRemoveOperationRequest (object)

Responses

Request samples

Payload

Content type

application/json

{"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"
],
"Operations": [{"op": "replace",
"path": "title",
"value": "COO"
}
]
}

Response samples

Content type

application/json

{"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"id": "60ad04c3fb3672005359a88b",
"externalId": "xxxxxxxxx",
"userName": "john.doe@example.com",
"name": {"givenName": "John",
"familyName": "Doe"
},
"active": true,
"meta": {"resourceType": "User",
"created": "2021-05-25T14:08:03.613Z",
"lastModified": "2021-05-25T14:08:03.613Z",
"location": ""
},
"displayName": "John Doe",
"profileUrl": "https://example.com/profile-url.png",
"title": "CEO",
"emails": [{"value": "john.doe@example.com",
"display": "john.doe@example.com",
"type": "work",
"primary": true
}
],
"phoneNumbers": [{"value": "+46000000000",
"type": "work",
"primary": true
}
],
"photos": [{"value": "https://example.com/profile-url.png",
"type": "photo"
}
],
"addresses": [{"streetAddress": "Street 1",
"locality": "Stockholm",
"region": "Stockholm County",
"postalCode": "12345",
"country": "SE",
"type": "home",
"primary": true
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {"employeeNumber": "100",
"costCenter": "CODE-1",
"organization": "AlexisHR",
"department": "Department 1",
"division": "Division 1",
"manager": {"value": "607e96e75673150031949100",
"$ref": "../Users/607e96e75673150031949100",
"displayName": "John's Manager"
}
},
"urn:ietf:params:scim:schemas:extension:alexis:2.0:User": {"team": ["Team 1"
],
"office": "Office 1",
"employmentType": "Permanent Employment",
"hireDate": "2022-10-24T15:34:21.011Z",
"endDate": "2022-10-24T15:34:21.011Z"
}
}

Delete User

Authorizations:

bearer

path Parameters

id

required

string

Responses

Response samples

Content type

application/json

{ }