Sign in

v13

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-04237161688.6 KB
SCIM Directories

Rotate a SCIM directory's API key

Generates a new API key for the SCIM directory and returns it in the api_key field. This is the only way to obtain the key after creation, so make sure to update it in your identity provider. The previous key remains valid for a short grace period before it expires.

post/scim_directories/{scim_directory_id}/rotate_api_key

Path parameters

scim_directory_idstring required

The ID of the SCIM directory whose API key to rotate

Response

A SCIM directory

object'scim_directory' required

String representing the object's type. Always "scim_directory".

idstring required

Unique identifier for the SCIM directory.

namestring required

A human-friendly name for the SCIM directory.

enterprise_connection_idstring nullable

The ID of the associated enterprise connection.

endpoint_urlstring required

The SCIM endpoint URL for this directory.

providerstring required

The identity provider for this SCIM directory.

enabledboolean required

Whether the SCIM directory is enabled.

group_role_mapping_enabledboolean required

Whether group-to-role mapping is enabled for this SCIM directory.

attribute_mappingobject required

Mapping of user attributes to the SCIM attribute paths they are extracted from.

api_keystring nullable

The API key for authenticating SCIM requests. Only returned when the directory is created or the key is rotated.

created_atinteger required

Unix timestamp when the SCIM directory was created.

updated_atinteger required

Unix timestamp when the SCIM directory was last updated.