NSX-T Data Center REST API

Probe an LDAP identity source

Verify that the configuration of an LDAP identity source is correct before actually creating the source.

Request:

Method:

POST

URI Path(s):

/policy/api/v1/aaa/ldap-identity-sources?action=probe_identity_source

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

ActiveDirectoryIdentitySource+

ActiveDirectoryIdentitySource (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
alternative_domain_names	Additional domains to be directed to this identity source After parsing the "user@domain", the domain portion is used to select the LDAP identity source to use. Additional domains listed here will also be directed to this LDAP identity source. In Active Directory these are sometimes referred to as Alternative UPN Suffixes.	array of string
base_dn	DN of subtree for user and group searches The subtree of the LDAP identity source to search when locating users and groups.	string	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
domain_name	Authentication domain name The name of the authentication domain. When users log into NSX using an identity of the form "user@domain", NSX uses the domain portion to determine which LDAP identity source to use.	string	Required
id	Unique identifier of this resource	string	Sortable
ldap_servers	LDAP servers for this identity source The list of LDAP servers that provide LDAP service for this identity source. Currently, only one LDAP server is supported.	array of IdentitySourceLdapServer	Maximum items: 3
resource_type	Must be set to the value ActiveDirectoryIdentitySource	string	Required Enum: ActiveDirectoryIdentitySource, OpenLdapIdentitySource
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

OpenLdapIdentitySource+

OpenLdapIdentitySource (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
alternative_domain_names	Additional domains to be directed to this identity source After parsing the "user@domain", the domain portion is used to select the LDAP identity source to use. Additional domains listed here will also be directed to this LDAP identity source. In Active Directory these are sometimes referred to as Alternative UPN Suffixes.	array of string
base_dn	DN of subtree for user and group searches The subtree of the LDAP identity source to search when locating users and groups.	string	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
domain_name	Authentication domain name The name of the authentication domain. When users log into NSX using an identity of the form "user@domain", NSX uses the domain portion to determine which LDAP identity source to use.	string	Required
id	Unique identifier of this resource	string	Sortable
ldap_servers	LDAP servers for this identity source The list of LDAP servers that provide LDAP service for this identity source. Currently, only one LDAP server is supported.	array of IdentitySourceLdapServer	Maximum items: 3
resource_type	Must be set to the value OpenLdapIdentitySource	string	Required Enum: ActiveDirectoryIdentitySource, OpenLdapIdentitySource
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

POST /policy/api/v1/aaa/ldap-identity-sources?action=probe { "resource_type": "ActiveDirectoryIdentitySource", "display_name": "Airius LDAP", "domain_name": "airius.com", "base_dn": "CN=Users, DC=airius, DC=com", "ldap_servers": [ "url": "ldap://ldap-vip01.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:

LdapIdentitySourceProbeResults+

LdapIdentitySourceProbeResults (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
results	Probe results Probe results for all probed LDAP servers.	array of IdentitySourceLdapServerProbeResult

Example Response:

200 OK { "results": [ "url": "ldap://ldap-vip01.corp.airius.com", "result": "FAILURE", "errors": [ "INVALID_CREDENTIALS" ] ] }

Required Permissions:

read

Feature:

users_configuration

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable