Sign in
scim

Update the SCIM configuration for an organization

patch/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 nullable

Update create users flag

deactivate_deletes_userboolean nullable

Update deactivate deletes user flag

default_org_rolestring nullable

Update default org role

default_team_idstring uuid nullable

Update default team (set to null to remove)

default_team_rolestring nullable

Update default team role

enabledboolean nullable

Update enabled flag

revoke_api_keys_on_deactivateboolean nullable

Update revoke API keys on deactivate flag

sync_display_nameboolean nullable

Update sync display name flag

Response

SCIM config updated

create_usersboolean required

Whether to create new users when they don't exist

created_atstring date-time required

When this config was created

deactivate_deletes_userboolean required

Whether deactivating a user deletes them entirely (vs just marking inactive)

default_org_rolestring required

Default role for new users in the organization

default_team_idstring uuid nullable

Default team to add new users to (optional)

default_team_rolestring required

Default role for new users in the default team

enabledboolean required

Whether SCIM provisioning is enabled

idstring uuid required

Unique identifier for this SCIM configuration

org_idstring uuid required

Organization this SCIM config belongs to (one config per org)

revoke_api_keys_on_deactivateboolean required

Whether to revoke all API keys when a user is deactivated via SCIM

sync_display_nameboolean required

Whether to sync display name from SCIM on updates

token_last_used_atstring date-time nullable

Last time the SCIM token was used for authentication

token_prefixstring required

Token prefix for identification (first 8 chars, like 'scim_xxxx') Note: token_hash is NOT included in the model - it's stored separately

updated_atstring date-time required

When this config was last updated

Changes

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