System Administration > Settings > User Management > LDAP Identity Sources

Test an LDAP server

Attempt to connect to an LDAP server and ensure that the server can be contacted using the given URL and authentication credentials.

Request:

Method:
POST
URI Path(s):
/api/v1/aaa/ldap-identity-sources?action=probe_ldap_server
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
IdentitySourceLdapServer+

Example Request:

POST /policy/api/v1/aaa/ldap-identity-sources/airius-ad?action=probe_ldap_server { "url": "ldap://dir01.corp.airius.com", "use_starttls": true, "certificate": "-----BEGIN CERTIFICATE----- <data> -----END CERTIFICATE-----", "bind_identity": "nsxint@airius.com", "password": "gSSs77w33yMp" }

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
IdentitySourceLdapServerProbeResult+

Example Response:

{ "url": "ldap://dir01.corp.airius.com", "result": "FAILURE", "errors": [ "SSL_HANDSHAKE_ERROR" ] }

Required Permissions:

crud

Feature:

users_configuration

Additional Errors: