List supported SCIM resource types
GET /scim/v2/{endpointKey}/ResourceTypes
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
endpointKey | path · string (pattern ^[0-9a-f]{48}$) | yes |
Errors: 401, 404, 429 — see errors.
SCIM provisioning
API reference descriptions are provided in English to preserve the exact published contract.
Get one supported SCIM resource type
GET /scim/v2/{endpointKey}/ResourceTypes/{resourceTypeId}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
endpointKey | path · string (pattern ^[0-9a-f]{48}$) | yes | |
resourceTypeId | path · "User" | "Group" | yes |
Errors: 401, 404, 429 — see errors.
List supported SCIM schemas
GET /scim/v2/{endpointKey}/Schemas
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
endpointKey | path · string (pattern ^[0-9a-f]{48}$) | yes |
Errors: 401, 404, 429 — see errors.
Get one supported SCIM schema
GET /scim/v2/{endpointKey}/Schemas/{schemaId}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
endpointKey | path · string (pattern ^[0-9a-f]{48}$) | yes | |
schemaId | path · string (max 256 chars) | yes |
Errors: 401, 404, 429 — see errors.
Get SCIM service-provider configuration
GET /scim/v2/{endpointKey}/ServiceProviderConfig
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
endpointKey | path · string (pattern ^[0-9a-f]{48}$) | yes |
Errors: 401, 404, 429 — see errors.
List SCIM Users or Groups. Dual pagination: RFC 7644 startIndex/count for SCIM compliance, or the platform keyset cursor/count; every page carries nextCursor (null on the last page) so a client may continue by cursor from either mode. startIndex and cursor are mutually exclusive.
GET /scim/v2/{endpointKey}/{resourceType}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
startIndex | query · integer (1–1000000) | ||
count | query · integer (0–100) | ||
cursor | query · string (max 2048 chars) | ||
filter | query · string (max 2048 chars) | ||
endpointKey | path · string (pattern ^[0-9a-f]{48}$) | yes | |
resourceType | path · "Users" | "Groups" | yes |
Errors: 400, 401, 429 — see errors.
Create a SCIM User or Group
POST /scim/v2/{endpointKey}/{resourceType}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
endpointKey | path · string (pattern ^[0-9a-f]{48}$) | yes | |
resourceType | path · "Users" | "Groups" | yes |
Errors: 400, 401, 404, 409, 412, 428, 429 — see errors.
Get one SCIM User or Group
GET /scim/v2/{endpointKey}/{resourceType}/{id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
endpointKey | path · string (pattern ^[0-9a-f]{48}$) | yes | |
resourceType | path · "Users" | "Groups" | yes | |
id | path · string (uuid) | yes |
Errors: 401, 404, 429 — see errors.
Replace a SCIM User or Group
PUT /scim/v2/{endpointKey}/{resourceType}/{id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
endpointKey | path · string (pattern ^[0-9a-f]{48}$) | yes | |
resourceType | path · "Users" | "Groups" | yes | |
id | path · string (uuid) | yes |
Errors: 400, 401, 404, 409, 412, 428, 429 — see errors.
Patch a SCIM User or Group
PATCH /scim/v2/{endpointKey}/{resourceType}/{id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
endpointKey | path · string (pattern ^[0-9a-f]{48}$) | yes | |
resourceType | path · "Users" | "Groups" | yes | |
id | path · string (uuid) | yes |
Errors: 400, 401, 404, 409, 412, 428, 429 — see errors.
Delete a SCIM User or Group
DELETE /scim/v2/{endpointKey}/{resourceType}/{id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
endpointKey | path · string (pattern ^[0-9a-f]{48}$) | yes | |
resourceType | path · "Users" | "Groups" | yes | |
id | path · string (uuid) | yes |
Errors: 400, 401, 404, 409, 412, 428, 429 — see errors.