Docs
Esc

Suggested

QuickstartGet started
Webhooks and signaturesMessaging
Create a messagemessages.create · POST /v1/accounts/{AC}/messages
RATE_LIMITED429 · Rate limit exceeded.
message.deliveredMessage resource
Contents

API reference

SCIM provisioning

API reference descriptions are provided in English to preserve the exact published contract.

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}$)Required
  • resourceTypeIdenumRequired

    UserGroup

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}$)Required
  • schemaIdstring (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}$)Required
  • resourceTypeenumRequired

    UsersGroups

  • startIndexinteger (1–1000000)query
  • countinteger (0–100)query
  • cursorstring (max 2048 chars)query
  • filterstring (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}$)Required
  • resourceTypeenumRequired

    UsersGroups

Get one SCIM User or Group

GET/scim/v2/{endpointKey}/{resourceType}/{id}

getScimV2ByEndpointkeyByResourcetypeByIdSDK operation getScimV2ByEndpointkeyByResourcetypeById

Parameters

  • endpointKeystring (pattern ^[0-9a-f]{48}$)Required
  • resourceTypeenumRequired

    UsersGroups

  • idstring (uuid)Required

Replace a SCIM User or Group

PUT/scim/v2/{endpointKey}/{resourceType}/{id}

putSDK operation putScimV2ByEndpointkeyByResourcetypeById

Parameters

  • endpointKeystring (pattern ^[0-9a-f]{48}$)Required
  • resourceTypeenumRequired

    UsersGroups

  • idstring (uuid)Required

Patch a SCIM User or Group

PATCH/scim/v2/{endpointKey}/{resourceType}/{id}

patchSDK operation patchScimV2ByEndpointkeyByResourcetypeById

Parameters

  • endpointKeystring (pattern ^[0-9a-f]{48}$)Required
  • resourceTypeenumRequired

    UsersGroups

  • idstring (uuid)Required

Delete a SCIM User or Group

DELETE/scim/v2/{endpointKey}/{resourceType}/{id}

deleteSDK operation deleteScimV2ByEndpointkeyByResourcetypeById

Parameters

  • endpointKeystring (pattern ^[0-9a-f]{48}$)Required
  • resourceTypeenumRequired

    UsersGroups

  • idstring (uuid)Required