Skip to main content

Test LDAP Connection

This API tests the connection to the LDAP server using the saved LDAP configuration.

Endpoint Details

URL/v1/ldap/test-connection
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,
"message": "Connection successful"
}

Field Descriptions

FieldTypeDescription
successBooleanIndicates whether the connection test was successful
messageStringMessage describing the result of the connection test

info
  • A valid Bearer Token is required to access this endpoint.
  • The test uses the LDAP configuration that has already been saved.