[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Test LDAP

Description

Tests that custom LDAP settings are valid, and that the system can use them to search for a user or group

Request

Request

URL

URL


post
https://{api_host}/cloudapi/1.0.0/ldap/test
Copy

Query Parameters

Query Parameters

string
username Optional

Username to use when testing LDAP search


Request Body

Request Body

LdapSettings of type(s) application/json Required

LDAP Settings to use for testing connection

{
	"authenticationMechanism": "SIMPLE",
	"connectorType": "ACTIVE_DIRECTORY",
	"groupAttributes": {
		"backLinkIdentifier": "string",
		"groupName": "string",
		"membership": "string",
		"membershipIdentifier": "string",
		"objectClass": "string",
		"objectIdentifier": "string"
	},
	"groupSearchBase": "string",
	"hostName": "string",
	"isGroupSearchBaseEnabled": false,
	"isSsl": false,
	"isSslAcceptAll": false,
	"maxResults": 0,
	"maxUserGroups": 0,
	"pageSize": 0,
	"pagedSearchDisabled": false,
	"password": "string",
	"port": 0,
	"realm": "string",
	"searchBase": "string",
	"useExternalKerberos": false,
	"userAttributes": {
		"email": "string",
		"fullName": "string",
		"givenName": "string",
		"groupBackLinkIdentifier": "string",
		"groupMembershipIdentifier": "string",
		"objectClass": "string",
		"objectIdentifier": "string",
		"surname": "string",
		"telephone": "string",
		"userName": "string"
	},
	"userName": "string"
}
string
authenticationMechanism Optional

Possible values are: SIMPLEKERBEROSM5DIGESTNTLM


string
connectorType Optional

Possible values are: ACTIVE_DIRECTORYOPEN_LDAP


groupAttributes Optional

Defines how a group is imported from LDAP.


string
groupSearchBase Optional

string
hostName Optional

boolean
isGroupSearchBaseEnabled Optional

boolean
isSsl Optional

boolean
isSslAcceptAll Optional

integer
maxResults Optional

integer
maxUserGroups Optional

integer
pageSize Optional

boolean
pagedSearchDisabled Optional

string
password Optional

integer
port Optional

string
realm Optional

string
searchBase Optional

boolean
useExternalKerberos Optional

userAttributes Optional

Defines how LDAP attributes are used when importing a user.


string
userName Optional
Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns LdapTestResult of type(s) application/json;version=36.3
{
	"connectionTest": {
		"error": {
			"message": "string",
			"minorErrorCode": "string",
			"stackTrace": "string"
		},
		"successful": false
	},
	"settingsTest": [
		{
			"attribute": "USER_OBJECT_IDENTIFIER",
			"attributeValue": "string",
			"result": "string",
			"successful": false
		}
	]
}
connectionTest Optional

Provides LDAP connection test results


settingsTest Optional

Provides test attribute, result, and success boolean

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"authenticationMechanism":"SIMPLE","connectorType":"ACTIVE_DIRECTORY","groupAttributes":{"backLinkIdentifier":"string","groupName":"string","membership":"string","membershipIdentifier":"string","objectClass":"string","objectIdentifier":"string"},"groupSearchBase":"string","hostName":"string","isGroupSearchBaseEnabled":false,"isSsl":false,"isSslAcceptAll":false,"maxResults":0,"maxUserGroups":0,"pageSize":0,"pagedSearchDisabled":false,"password":"string","port":0,"realm":"string","searchBase":"string","useExternalKerberos":false,"userAttributes":{"email":"string","fullName":"string","givenName":"string","groupBackLinkIdentifier":"string","groupMembershipIdentifier":"string","objectClass":"string","objectIdentifier":"string","surname":"string","telephone":"string","userName":"string"},"userName":"string"}' https://{api_host}/cloudapi/1.0.0/ldap/test


[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Feedback

Was this page helpful?