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

Identity and sessions

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

Get organization authentication policy

GET/v1/accounts/{AC}/identity/auth-policy

identity.authPolicy.listSDK operation getV1AccountsByAcIdentityAuthPolicy

Replace organization authentication policy

PUT/v1/accounts/{AC}/identity/auth-policy

identity.authPolicy.updateSDK operation putV1AccountsByAcIdentityAuthPolicy

Request body

  • autoDisableInactiveApiKeysbooleanRequired
  • expectedVersioninteger (1–)Required
  • mfaRequiredForAllRolesbooleanRequired
  • passwordLoginEnabledbooleanRequired
  • recoveryRevokesMfabooleanRequired
  • sessionAbsoluteTimeoutHoursinteger (1–2160)Required
  • sessionIdleTimeoutMinutesinteger (15–1440)Required
  • ssoEnforcedbooleanRequired
  • stepUpTokenstring (max 256 chars)Required

List the signed-in user's MFA credentials

GET/v1/accounts/{AC}/identity/mfa/credentials

identity.mfa.credentials.listSDK operation getV1AccountsByAcIdentityMfaCredentials

Parameters

  • limitinteger (1–100)query
  • cursorstring (max 2048 chars)query

Revoke one MFA credential

DELETE/v1/accounts/{AC}/identity/mfa/credentials/{credentialId}

identity.mfa.credentials.deleteSDK operation deleteV1AccountsByAcIdentityMfaCredentialsByCredentialid

Parameters

  • credentialIdstring (uuid)Required

Request body

  • stepUpTokenstring (max 256 chars)Required

List admitted MFA methods for the signed-in member

GET/v1/accounts/{AC}/identity/mfa/enrollment-options

identity.mfa.enrollmentOptions.listSDK operation getV1AccountsByAcIdentityMfaEnrollmentOptions

Parameters

  • providerKeystring (pattern ^[a-z0-9][a-z0-9_-]*$, max 64 chars)queryRequired

Start WebAuthn or TOTP enrollment

POST/v1/accounts/{AC}/identity/mfa/enrollments

identity.mfa.enrollmentsSDK operation postV1AccountsByAcIdentityMfaEnrollments

Request body

  • methodenumRequired

    WEBAUTHNTOTP

  • providerKeystring (pattern ^[a-z0-9][a-z0-9_-]*$, max 64 chars)Required
  • displayNamestring (max 128 chars)

Complete WebAuthn or TOTP enrollment

POST/v1/accounts/{AC}/identity/mfa/enrollments/{enrollmentId}/complete

identity.mfa.enrollments.completeSDK operation postV1AccountsByAcIdentityMfaEnrollmentsByEnrollmentidComplete

Parameters

  • enrollmentIdstring (uuid)Required

Request body

  • ceremonyRefstring (max 1024 chars)Required
  • responsestring (max 32768 chars)Required

Replace recovery codes and return the new codes once

POST/v1/accounts/{AC}/identity/mfa/recovery-codes/rotate

identity.mfa.recoveryCodes.rotateSDK operation postV1AccountsByAcIdentityMfaRecoveryCodesRotate

Request body

  • stepUpTokenstring (max 256 chars)Required

List the signed-in user's factors and start a WebAuthn step-up ceremony

POST/v1/accounts/{AC}/identity/mfa/verification-options

identity.mfa.verificationOptionsSDK operation postV1AccountsByAcIdentityMfaVerificationOptions

Request body

  • actionstring (max 256 chars)Required

List organization identity providers

GET/v1/accounts/{AC}/identity/providers

identity.providers.listSDK operation getV1AccountsByAcIdentityProviders

Parameters

  • limitinteger (1–100)query
  • cursorstring (max 2048 chars)query

Stage an identity provider configuration

POST/v1/accounts/{AC}/identity/providers

identity.providers.createSDK operation postV1AccountsByAcIdentityProviders

Request body

  • protocolenumRequired

    OIDCSAMLSCIMWEBAUTHNTOTP

  • providerKeystring (pattern ^[a-z0-9][a-z0-9_-]*$, max 64 chars)Required
  • publicConfigobjectRequired
  • reasonstring (max 2000 chars)Required
  • stepUpTokenstring (max 256 chars)Required
  • credentialRefstring (max 512 chars)

Verify and activate an identity provider

POST/v1/accounts/{AC}/identity/providers/{providerId}/activate

identity.providers.activateSDK operation postV1AccountsByAcIdentityProvidersByProvideridActivate

Parameters

  • providerIdstring (uuid)Required

Request body

  • reasonstring (max 2000 chars)Required
  • stepUpTokenstring (max 256 chars)Required

Issue or rotate the SCIM bearer token

POST/v1/accounts/{AC}/identity/providers/{providerId}/scim-token

identity.providers.scimTokenSDK operation postV1AccountsByAcIdentityProvidersByProvideridScimToken

Issues the bearer token a directory uses to call this SCIM provider's endpoint. The token is returned once and only its SHA-256 is stored; issuing again rotates it, revoking the previous token immediately. Requires an IDENTITY_PROVIDER_CHANGE step-up grant.

Parameters

  • providerIdstring (uuid)Required

Request body

  • reasonstring (max 2000 chars)Required
  • stepUpTokenstring (max 256 chars)Required

Revoke the SCIM bearer token

POST/v1/accounts/{AC}/identity/providers/{providerId}/scim-token/revoke

identity.providers.scimToken.revokeSDK operation postV1AccountsByAcIdentityProvidersByProvideridScimTokenRevoke

Revokes the provider's live SCIM bearer token; directory requests fail at once. Requires an IDENTITY_PROVIDER_CHANGE step-up grant.

Parameters

  • providerIdstring (uuid)Required

Request body

  • reasonstring (max 2000 chars)Required
  • stepUpTokenstring (max 256 chars)Required

Suspend an identity provider

POST/v1/accounts/{AC}/identity/providers/{providerId}/suspend

identity.providers.suspendSDK operation postV1AccountsByAcIdentityProvidersByProvideridSuspend

Deprovisioning: the provider stops backing sign-in, MFA or SCIM at once, every browser session it authenticated is revoked, and it can be re-verified and activated later.

Parameters

  • providerIdstring (uuid)Required

Request body

  • reasonstring (max 2000 chars)Required
  • stepUpTokenstring (max 256 chars)Required

Exchange verified MFA or a one-use recovery code for a step-up token

POST/v1/accounts/{AC}/identity/step-up

identity.stepUpSDK operation postV1AccountsByAcIdentityStepUp

Parameters

  • limitinteger (1–100)query
  • cursorstring (max 2048 chars)query

Request body

  • actionstring (max 256 chars)Required

    The action the grant is for, exactly as a STEP_UP_REQUIRED refusal names it in details[path=stepUpAction] (for example API_KEY_CREATE, API_KEY_ROTATE, WEBHOOK_ENDPOINT_CREATE, WEBHOOK_URL_CHANGE, WEBHOOK_SECRET_ROTATE, WEBHOOK_ENDPOINT_REENABLE). A grant for another name is not accepted. Step-up is for people signed in to the console; an API key with webhooks:write manages webhook endpoints without it.

  • assertionstring (max 32768 chars)Required
  • methodenumRequired

    WEBAUTHNTOTPRECOVERY_CODE

  • challengestring (max 256 chars)
  • providerKeystring (pattern ^[a-z0-9][a-z0-9_-]*$, max 64 chars)

Reset all MFA factors for a user

POST/v1/accounts/{AC}/identity/users/{userSid}/mfa/reset

identity.users.mfa.resetSDK operation postV1AccountsByAcIdentityUsersByUsersidMfaReset

Parameters

  • userSidstring (US… SID)Required

Request body

  • stepUpTokenstring (max 256 chars)Required

Revoke every active browser session for a user

POST/v1/accounts/{AC}/identity/users/{userSid}/sessions/revoke-all

identity.users.sessions.revokeAllSDK operation postV1AccountsByAcIdentityUsersByUsersidSessionsRevokeAll

Parameters

  • userSidstring (US… SID)Required

Request body

  • stepUpTokenstring (max 256 chars)Required

List active role bindings in the account scope

GET/v1/accounts/{AC}/role-bindings

roleBindings.listSDK operation getV1AccountsByAcRoleBindings

Parameters

  • limitinteger (1–100)query
  • cursorstring (max 2048 chars)query

Create an immutable role binding

POST/v1/accounts/{AC}/role-bindings

roleBindings.createSDK operation postV1AccountsByAcRoleBindings

Request body

  • principalRefstring (max 128 chars)Required
  • principalTypeenumRequired

    USERAPI_KEY

  • rolestring (max 64 chars)Required
  • scopeKindenumRequired

    ORGANIZATIONACCOUNTSUBACCOUNTINBOX

  • stepUpTokenstring (max 256 chars)Required
  • environmentenum

    livesandboxboth

  • expiresAtstring (date-time)
  • inboxSidstring (IB… SID)

Revoke an immutable role binding

DELETE/v1/accounts/{AC}/role-bindings/{bindingId}

roleBindings.deleteSDK operation deleteV1AccountsByAcRoleBindingsByBindingid

Parameters

  • bindingIdstring (uuid)Required

Request body

  • reasonstring (max 1000 chars)Required
  • stepUpTokenstring (max 256 chars)Required

List authoritative customer roles and permissions

GET/v1/accounts/{AC}/roles

roles.listSDK operation getV1AccountsByAcRoles

Parameters

  • limitinteger (1–100)query
  • cursorstring (max 2048 chars)query

Discover the API key's account and region

GET/v1/me

me.listSDK operation getV1Me