Official SCIM protocol: https://tools.ietf.org/html/rfc7644
Request SCIM configuration:
GET /SCIM/v2/ServiceProviderConfig
Request available resource types (with links to their schemas):
GET /SCIM/v2/ResourceTypes
Request (individual) resource type schemas:
GET /SCIM/v2/Schemas
Request schema for resource type User
:
GET /SCIM/v2/ResourceTypes/urn:ietf:params:scim:schemas:core:2.0:User
Request users with externalId "ABC123":
GET /SCIM/v2/Users?filter=externalId+eq+%22ABC123%22
Request groups named "Sales" without listing its members:
GET /SCIM/v2/Groups?excludedAttributes=members&filter=displayName+eq+%22Sales%22
Add a new user (managerId equals externalId):
POST /SCIM/v2/Users
{ "schemas": ["urn:scim:schemas:core:1.0", "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"], "userName": "scim_test", "externalId": "scim0001", "name": { "familyName": "Jones", "givenName": "Taylor" }, "emails": [ { "value": "jones@scim.com", "type": "work", "primary": true } ], "locale": "en_US", "active":true, "password":"t1meMa$heen", "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": { "employeeNumber": "701984", "costCenter": "4130", "organization": "Universal Studios", "division": "Theme Park", "department": "1000", "manager": { "managerId": "U0XE15NHQ", "displayName": "Mary Johnes" } } }
Partially edit a few user properties (deactivate, family name and email):
PATCH
/SCIM/v2/Users/6639add5-fa72-460b-afbd-a681bc6b579e
{ "schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"], "Operations":[ { "op":"replace", "path":"active", "value": "false" },{ "op":"replace", "path":"familyName", "value": "Janes" },{ "op":"replace", "path":"emails[email.type eq 'work']", "value": "jack@scim.com" } ] }
Update entire user profile:PUT /SCIM/v2/Users
{ "schemas": [ "urn:scim:schemas:core:1.0" ], "userName": "scim_test", "externalId": "scim0001", "name": { "familyName": "Janes" }, "active":false, "emails": [ { "value": "jack@scim.com", "type": "work", "primary": true } ] }
Delete a user:DELETE /SCIM/v2/Users/31c926dc-ae32-4df0-9b8f-f461a43586cc