Allows you to test a single LDAP object before storing it, making sure it connects successfully. Send only a single object, not an array of objects. Pass a test_cn property with a valid CN to query.
Definition
POST https://CLUSTER.DOMAIN/listener/appservices/admin/settings/ldap HTTP/1.1
Example Request
curl \
-H "Content-Type: application/json" \
-H "Authorization: Bearer TOKEN" \
-X POST \
-d '{
"base_dn": "ou=Users,DC=ldap,DC=web,DC=com",
"email_field": "mail",
"encryption": "tls",
"member_of_field": "memberOf",
"name": "my LDAP updated server",
"name_field": "name",
"port": 389,
"search_pass": "password",
"search_user": "cn=ab123456,ou=Users,DC=ldap,DC=web,DC=com",
"server": "ldap.web.com",
"test_cn": "cn=ab123456,ou=Users,DC=ldap,DC=web,DC=com",
"validate_ssl": false
}' \
-i \
https://CLUSTER.DOMAIN/listener/appservices/admin/settings/ldap
Example Response
HTTP/1.1 200 OK Content-Type: application/json
{
"base_dn": "ou=Users,DC=ldap,DC=web,DC=com",
"email_field": "mail",
"encryption": "tls",
"member_of_field": "memberOf",
"name": "my LDAP updated server",
"name_field": "name",
"port": 389,
"search_pass": "password",
"search_user": "cn=ab123456,ou=Users,DC=ldap,DC=web,DC=com",
"server": "ldap.web.com",
"validate_ssl": false
}
Response Codes
| Code | Description |
|---|---|
| 200 | Successfully connected to LDAP. |
| 400 | Could not connect to LDAP settings. |
| 401 | Authorization header not found. |