List all configured domains

Request:

Method:

GET

URI Path(s):

/api/v1/directory/domains

Request Headers:

n/a

Query Parameters:

ListRequestParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/directory/domains

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

DirectoryDomainListResults+

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
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	List of Directory Domains	array of DirectoryDomain (Abstract type: pass one of the following concrete types) DirectoryAdDomain	Required Maximum items: 500
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "sort_ascending": true, "sort_by": "display_name", "result_count": 1, "results": [ { "resource_type": "DirectoryAdDomain", "description": "Active directory domain nimbustest.com", "id": "876f66eb-64c1-4b0c-9489-ae8c6ebfcc32", "display_name": "NIMBUS TEST", "ldap_servers": [ { "resource_type": "DirectoryLdapServer", "id": "a8dacae0-6e4f-46b6-a962-eeeea7a3ea37", "display_name": "nimbus ldap test", "protocol": "LDAP", "port": 389, "host": "10.192.210.96", "thumbprint": "3b1f4f3b636569d648a3092fc5b5b00fe4f6ec6abd34de86ae657f4bba22913e", "_last_modified_user": "admin", "_last_modified_time": 1531939962738, "_system_owned": false, "_create_user": "admin", "_create_time": 1531939962738, "_protection": "NOT_PROTECTED", "_revision": 0 } ], "name": "nimbustest.com", "sync_settings": { "delta_sync_interval": 100 }, "base_distinguished_name": "DC=nimbustest,DC=com", "netbios_name": "NIMBUSTEST", "_last_modified_user": "admin", "_last_modified_time": 1531939962695, "_system_owned": false, "_create_user": "admin", "_create_time": 1531936487738, "_protection": "NOT_PROTECTED", "_revision": 2 } ] }

List all configured domains

Request:

ListRequestParameters (schema)

Example Request:

Successful Response:

DirectoryDomainListResults (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: