SCIM reference
What the SCIM 2.0 endpoint accepts, which attributes it keeps, and how authentication works.
Endpoint
Section titled “Endpoint”https://{host}/scim/v2/{tenant}, where {host} is your environment’s address and {tenant} its identifier. We send you the exact value.
Authentication
Section titled “Authentication”A bearer token per environment. It is shown only once, when created. We can revoke it and create a new one at any time; a revoked token stops working immediately. A token only works for its own environment.
Resources
Section titled “Resources”| Resource | Operations |
|---|---|
| Users | Create, read, list, replace, update (PATCH), delete. Filter by userName eq "…". Pages of up to 200. |
| Groups | Create, read, list, update members (PATCH), delete. Filter by displayName or externalId. |
| Discovery | ServiceProviderConfig, ResourceTypes, Schemas |
Bulk operations and ETags are not supported.
User attributes
Section titled “User attributes”| SCIM attribute | Kept as |
|---|---|
userName | Email, in lowercase |
displayName, or name.givenName + name.familyName | Display name |
externalId | External ID |
active | Active or disabled. Booleans and the strings "true" / "false" are both accepted. |
Other attributes, such as phone numbers, addresses, language and time zone, are accepted and ignored. Custom schema extensions are not supported.
Effects
Section titled “Effects”active: false, or deleting the user, ends all of the user’s sessions.- A change in the members of the admin group recalculates the Admin role for the environment’s SCIM users.