Skip to main content

Disable LDAP Configuration

This API disables the LDAP configuration, stopping the system from authenticating users against the LDAP directory server.

Endpoint Details

URL/v1/ldap/disable
MethodPOST
AuthorizationBearer Token

Request Headers

HeaderTypeDescription
Content-TypeStringMust be application/json

Response

Here is an example response after the request has been successfully processed:

Response
{
"success": true
}

Field Descriptions

FieldTypeDescription
successBooleanIndicates whether the LDAP configuration was successfully disabled

info
  • A valid Bearer Token is required to access this endpoint.
  • Once disabled, the system no longer authenticates users against the LDAP directory server.
  • After a successful request, the enabled field of the LDAP configuration is set to false.
  • The configuration itself is preserved and can be enabled again at any time.