SCIM provisioning
API reference descriptions are provided in English to preserve the exact published contract.
- GETList supported SCIM resource types
ResourceTypes.list - GETGet one supported SCIM resource type
ResourceTypes.retrieve - GETList supported SCIM schemas
Schemas.list - GETGet one supported SCIM schema
Schemas.retrieve - GETGet SCIM service-provider configuration
ServiceProviderConfig.list - GETList 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.
getScimV2ByEndpointkeyByResourcetype - POSTCreate a SCIM User or Group
post - GETGet one SCIM User or Group
getScimV2ByEndpointkeyByResourcetypeById - PUTReplace a SCIM User or Group
put - PATCHPatch a SCIM User or Group
patch - DELETEDelete a SCIM User or Group
delete
List supported SCIM resource types
GET/scim/v2/{endpointKey}/ResourceTypes
ResourceTypes.listSDK operation getScimV2ByEndpointkeyResourcetypes
Parameters
endpointKeystring (pattern ^[0-9a-f]{48}$)Required
Get one supported SCIM resource type
GET/scim/v2/{endpointKey}/ResourceTypes/{resourceTypeId}
ResourceTypes.retrieveSDK operation getScimV2ByEndpointkeyResourcetypesByResourcetypeid
Parameters
endpointKeystring (pattern ^[0-9a-f]{48}$)RequiredresourceTypeIdenumRequiredUserGroup
List supported SCIM schemas
GET/scim/v2/{endpointKey}/Schemas
Schemas.listSDK operation getScimV2ByEndpointkeySchemas
Parameters
endpointKeystring (pattern ^[0-9a-f]{48}$)Required
Get one supported SCIM schema
GET/scim/v2/{endpointKey}/Schemas/{schemaId}
Schemas.retrieveSDK operation getScimV2ByEndpointkeySchemasBySchemaid
Parameters
endpointKeystring (pattern ^[0-9a-f]{48}$)RequiredschemaIdstring (max 256 chars)Required
Get SCIM service-provider configuration
GET/scim/v2/{endpointKey}/ServiceProviderConfig
ServiceProviderConfig.listSDK operation getScimV2ByEndpointkeyServiceproviderconfig
Parameters
endpointKeystring (pattern ^[0-9a-f]{48}$)Required
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}
getScimV2ByEndpointkeyByResourcetypeSDK operation getScimV2ByEndpointkeyByResourcetype
Parameters
endpointKeystring (pattern ^[0-9a-f]{48}$)RequiredresourceTypeenumRequiredUsersGroupsstartIndexinteger (1–1000000)querycountinteger (0–100)querycursorstring (max 2048 chars)queryfilterstring (max 2048 chars)query
Create a SCIM User or Group
POST/scim/v2/{endpointKey}/{resourceType}
postSDK operation postScimV2ByEndpointkeyByResourcetype
Parameters
endpointKeystring (pattern ^[0-9a-f]{48}$)RequiredresourceTypeenumRequiredUsersGroups
Get one SCIM User or Group
GET/scim/v2/{endpointKey}/{resourceType}/{id}
getScimV2ByEndpointkeyByResourcetypeByIdSDK operation getScimV2ByEndpointkeyByResourcetypeById
Parameters
endpointKeystring (pattern ^[0-9a-f]{48}$)RequiredresourceTypeenumRequiredUsersGroupsidstring (uuid)Required
Replace a SCIM User or Group
PUT/scim/v2/{endpointKey}/{resourceType}/{id}
putSDK operation putScimV2ByEndpointkeyByResourcetypeById
Parameters
endpointKeystring (pattern ^[0-9a-f]{48}$)RequiredresourceTypeenumRequiredUsersGroupsidstring (uuid)Required
Patch a SCIM User or Group
PATCH/scim/v2/{endpointKey}/{resourceType}/{id}
patchSDK operation patchScimV2ByEndpointkeyByResourcetypeById
Parameters
endpointKeystring (pattern ^[0-9a-f]{48}$)RequiredresourceTypeenumRequiredUsersGroupsidstring (uuid)Required
Delete a SCIM User or Group
DELETE/scim/v2/{endpointKey}/{resourceType}/{id}
deleteSDK operation deleteScimV2ByEndpointkeyByResourcetypeById
Parameters
endpointKeystring (pattern ^[0-9a-f]{48}$)RequiredresourceTypeenumRequiredUsersGroupsidstring (uuid)Required