[{"label":"Latest (v36.3)","version":"latest"},{"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

Search LDAP Users

Description

Searches LDAP for given user(s)

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/ldap/search/user
Copy

Query Parameters

Query Parameters

string
q Optional

String to search for via LDAP


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns array of User of type(s) application/json;version=36.3
{
	"alertEmail": "string",
	"alertEmailPrefix": "string",
	"delayAfterPowerOnSeconds": 0,
	"deployedVMQuota": 0,
	"description": "string",
	"email": "string",
	"enabled": false,
	"external": false,
	"fullname": "string",
	"im": "string",
	"inSync": false,
	"locked": false,
	"nameInSource": "string",
	"orgEntityRef": {
		"id": "string",
		"name": "string"
	},
	"phoneNumber": "string",
	"roleEntityRef": {
		"id": "string",
		"name": "string"
	},
	"roleInherited": false,
	"sourceEntityRef": {
		"id": "string",
		"name": "string"
	},
	"storedVMQuota": 0,
	"username": "string"
}
string
alertEmail Optional

string
alertEmailPrefix Optional

integer
delayAfterPowerOnSeconds Optional

integer
deployedVMQuota Optional

The deployed VM quota for this user. Defaults to 0 which means unlimited. This property is deprecated in 35.0. Use user quotas API.


string
description Optional

string
email Optional

boolean
enabled Optional

boolean
external Optional

string
fullname Optional

string
im Optional

boolean
inSync Optional

boolean
locked Optional

string
nameInSource Optional

orgEntityRef Optional

Entity reference used to describe VCD entities


string
phoneNumber Optional

roleEntityRef Optional

Entity reference used to describe VCD entities


boolean
roleInherited Optional

sourceEntityRef Optional

This field is under accelerated deprecation and will be removed next release.


integer
storedVMQuota Optional

The stored VM quota for this user. Defaults to 0 which means unlimited. This property is deprecated in 35.0. Use user quotas API.


string
username Optional

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/ldap/search/user


[{"label":"Latest (v36.3)","version":"latest"},{"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?