v4

latestOpenAPI 3.1.1Apache 2.02026-07-31107278570.4 KB

Disable a directory

Stops synchronization of users and groups from a specified directory within an organization. This operation prevents further updates from the connected Directory provider

patch/api/v1/organizations/{organization_id}/directories/{id}:disable

Path parameters

organization_idstring required

A unique identifier for the organization. The value must begin with 'org_' and be between 1 and 32 characters long

idstring required

A unique identifier for a directory within the organization. The value must begin with 'dir_' and be between 1 and 32 characters long

Response

Successfully disabled the directory

enabledboolean

Specifies the directory's state after the toggle operation. A value of true indicates that the directory is enabled and actively synchronizing users and groups. A value of false means the directory is disabled, halting synchronization

error_messagestring

Contains a human-readable error message if the toggle operation encountered an issue. If the operation was successful, this field will be empty

Example response

{
  "enabled": true,
  "error_message": "The directory is already enabled"
}