NSX-T Data Center Global Manager REST API

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):
/global-manager/api/v1/aaa/ldap-identity-sources?action=probe_ldap_server
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
IdentitySourceLdapServer+

Example Request:

{ "url": "ldap://dir01.corp.airius.com", "use_starttls": true, "certificate": "-----BEGIN CERTIFICATE----- <data> -----END CERTIFICATE-----", "bind_identity": "[email protected]", "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: