Sign in
scim

Create a new SCIM configuration for an organization

Each organization can have at most one SCIM configuration. Creating a config for an organization that already has one will result in a 409 Conflict error.

The response includes the SCIM bearer token which is only shown once. Store it securely - it cannot be retrieved again.

post/admin/v1/organizations/{org_slug}/scim-config

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /admin/v1/organizations/{org_slug}/scim-config
  • Auth: HTTP bearer

Path parameters

org_slugstring required

Organization slug

Request body

create_usersboolean

Whether to create new users when they don't exist (default: true)

deactivate_deletes_userboolean

Whether deactivating a user deletes them entirely (default: false)

default_org_rolestring

Default role for new users in the organization (default: "member")

default_team_idstring uuid nullable

Default team to add new users to (optional)

default_team_rolestring

Default role for new users in the default team (default: "member")

enabledboolean

Whether SCIM provisioning is enabled (default: true)

revoke_api_keys_on_deactivateboolean

Whether to revoke all API keys when user is deactivated (default: true)

sync_display_nameboolean

Whether to sync display name from SCIM on updates (default: true)

Response

SCIM config created with bearer token

tokenstring required

The raw SCIM bearer token (only shown once at creation time!) Format: "scim_<random_base64>" (e.g., "scim_Abc123XyzDef456...")

Changes

No recorded changes to this operation across all 1 revision of this API.