PATCH
/scim_directories/{scim_directory_id}Update a SCIM directory
Updates the configuration of a SCIM directory. Supply only the settings you want to change; attribute_mapping entries are merged, and setting a key to null removes it from the mapping.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
scim_directory_idstringrequired
The ID of the SCIM directory to update.
SCIM directory settings to update; omit fields you want to leave unchanged.
namestringoptional
A human-friendly name for the directory.
enabledbooleanoptional
Whether the directory is enabled.
providerstringoptional
The identity provider for this directory.
attribute_mappingobjectoptional
Attribute-to-SCIM-path entries to merge into the directory's attribute mapping.
Set a key to `null` to remove it from the mapping.
group_role_mapping_enabledbooleanoptional
Whether group-to-role mapping is enabled for this directory.
200Returns the updated directory configuration, including its identifier, name, provider, settings, attribute mappings, and timestamps.
objectstringrequired
String representing the object's type. Always "scim_directory".
idstringrequired
Unique identifier for the directory.
namestringrequired
A human-friendly name for the directory.
enterprise_connection_idstringoptional
The ID of the associated enterprise connection.
endpoint_urlstringrequired
The SCIM endpoint URL for this directory.
providerstringrequired
The identity provider for this directory.
enabledbooleanrequired
Whether the directory is enabled.
group_role_mapping_enabledbooleanrequired
Whether group-to-role mapping is enabled for this directory.
attribute_mappingobjectrequired
Mapping of user attributes to the SCIM attribute paths they are extracted from.
custom_attributesarray<object>optional
Custom attributes to map from the IdP to the user's profile via SCIM provisioning. Requires the custom attributes feature to be enabled for the instance.
api_keystringoptional
The API key for authenticating SCIM requests. Only returned when the directory is created or the key is rotated.
created_atintegerrequired
Unix timestamp when the directory was created.
updated_atintegerrequired
Unix timestamp when the directory was last updated.
400Returned when the request is not successful.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
401Returned when authentication is invalid.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
403Returned when authorization is invalid.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
404Returned when the directory is not found.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
422Returned when request parameters are invalid.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
Error handling
A 400 indicates the request was not successful, a 401 indicates invalid authentication, a 403 indicates invalid authorization, a 404 indicates the directory was not found, and a 422 indicates invalid request parameters. The scim_directory_id path parameter must identify an existing directory. All body fields are optional; attribute_mapping values are strings, and setting a key to null removes it.