Scim

Base URL: $BUSINESS_API

The object

idstring · required

Token identifier, used to revoke it.

tenant_idstring · required

Tenant whose directory the token can provision.

namestring · required

Label for the token.

last_used_atstring (date-time) · optional

When the token last authenticated a SCIM request.

expires_atstring (date-time) · optional

When the token stops working. Absent for tokens that never expire.

created_atstring (date-time) · required

When the token was issued.

The object
[
  {
    "id": "sct_01JD3X8Q7M2N4P5R6S7T8V9W0X",
    "tenant_id": "tenant_alpha",
    "name": "Ana Matsinhe",
    "last_used_at": "2026-11-19T09:30:00Z",
    "expires_at": "2026-11-19T09:30:00Z",
    "created_at": "2026-11-19T09:30:00Z"
  }
]

Show the tenant's SCIM directory tokens

Logs

GET /scim/tokens

Returns every SCIM directory token of the caller's tenant, newest first, as a plain array (not paged). Token secrets are never included: they are shown only once, when a token is created. Requires business:team:read.

Returns

200 SCIM tokens

Show attributes
idstring · required

Token identifier, used to revoke it.

tenant_idstring · required

Tenant whose directory the token can provision.

namestring · required

Label for the token.

last_used_atstring (date-time) · optional

When the token last authenticated a SCIM request.

expires_atstring (date-time) · optional

When the token stops working. Absent for tokens that never expire.

created_atstring (date-time) · required

When the token was issued.

Errors 401 · 403

Permissions business:team:read · Roles: admin, owner

curl -X GET "$BUSINESS_API/scim/tokens" \
  -H "Authorization: Bearer sk_test_..."
Response 200
[
  {
    "id": "sct_01JD3X8Q7M2N4P5R6S7T8V9W0X",
    "tenant_id": "tenant_alpha",
    "name": "Ana Matsinhe",
    "last_used_at": "2026-11-19T09:30:00Z",
    "expires_at": "2026-11-19T09:30:00Z",
    "created_at": "2026-11-19T09:30:00Z"
  }
]

Issue a SCIM directory token

Logs

POST /scim/tokens

Issue a SCIM directory token; the secret appears once in the response

Issues a bearer token that an identity provider uses to provision the caller's tenant through the SCIM API. The secret is returned only in this response; only its SHA-256 digest is stored, so a lost token must be revoked and replaced. name defaults to "Default SCIM Directory Sync"; expires_in_days 0 or omitted means it never expires. Requires business:team:manage. The issue is recorded in the audit log. Needs a person's session: API keys are refused with 403 and code api_key_not_allowed, whatever scopes they hold.

Body application/json

namestring · optional

Label for the token. Defaults to "Default SCIM Directory Sync".

expires_in_daysinteger · optional

Lifetime in days. 0 or omitted means the token never expires.

Returns

201 Token issued; the secret is shown only here

Show attributes
idstring · required

Token identifier, used to revoke it.

tenant_idstring · required

Tenant whose directory the token can provision.

namestring · required

Label for the token.

last_used_atstring (date-time) · optional

When the token last authenticated a SCIM request.

expires_atstring (date-time) · optional

When the token stops working. Absent for tokens that never expire.

created_atstring (date-time) · required

When the token was issued.

tokenstring · required

The bearer secret for the SCIM API. Shown only in this response; only its SHA-256 digest is stored, so it cannot be retrieved again.

Errors 400 · 401 · 403

Permissions business:team:manage · Roles: admin, owner

curl -X POST "$BUSINESS_API/scim/tokens" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Identity provider sync",
  "expires_in_days": 90
}'
Response 201
{
  "id": "sct_01JD3X8Q7M2N4P5R6S7T8V9W0X",
  "tenant_id": "tenant_alpha",
  "name": "Ana Matsinhe",
  "last_used_at": "2026-11-19T09:30:00Z",
  "expires_at": "2026-11-19T09:30:00Z",
  "created_at": "2026-11-19T09:30:00Z",
  "token": "scim_live_3f9a0c2e7b1d4f6a8c0e2b4d6f8a0c2e4b6d8f0a2c4e6b8d0f2a4c6e8b0d2f4a"
}

Revoke a SCIM directory token

Logs

DELETE /scim/tokens/{id}

Revokes the SCIM token with this id in the caller's tenant; SCIM requests that present it are refused from then on. The call is idempotent and returns 204 for an unknown id. Requires business:team:manage. The revocation is recorded in the audit log. Needs a person's session: API keys are refused with 403 and code api_key_not_allowed, whatever scopes they hold.

Parameters

idstring · path · required

Identifier of the SCIM token to revoke (sct_...).

Returns

204 Token revoked

Errors 401 · 403

Permissions business:team:manage · Roles: admin, owner

curl -X DELETE "$BUSINESS_API/scim/tokens/{id}" \
  -H "Authorization: Bearer sk_test_..."
Response 204

Token revoked