NSX-T Data Center REST API

Update a directory domain (Deprecated)

Update to any field in the directory domain will trigger a full sync Deprecated:
Use the following Policy API -
PUT /policy/api/v1/infra/firewall-identity-stores/<firewall-identity-store-id>

Request:

Method:

PUT

URI Path(s):

/api/v1/directory/domains/{domain-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

DirectoryAdDomain+

DirectoryAdDomain (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
base_distinguished_name	Directory domain base distinguished name Each active directory domain has a domain naming context (NC), which contains domain-specific data. The root of this naming context is represented by a domain's distinguished name (DN) and is typically referred to as the NC head.	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
event_log_servers	Event Log server of directory domain Directory domain Event Log server's information including host, name, protocol and so on.	array of DirectoryEventLogServer	Readonly Maximum items: 50
id	Unique identifier of this resource	string	Sortable
ldap_servers	LDAP server of directory domain Directory domain LDAP servers' information including host, name, port, protocol and so on.	array of DirectoryLdapServer	Required Maximum items: 50
name	Directory domain name Directory domain name which best describes the domain. It could be unique fqdn name or it could also be descriptive. There is no unique contraint for domain name among different domains.	string	Required
netbios_name	Directory domain NETBIOS name NetBIOS names can contain all alphanumeric characters except for the certain disallowed characters. Names can contain a period, but names cannot start with a period. NetBIOS is similar to DNS in that it can serve as a directory service, but more limited as it has no provisions for a name hierarchy and names are limited to 15 characters. The netbios name is case insensitive and is stored in upper case regardless of input case.	string	Required
resource_type	Must be set to the value DirectoryAdDomain	string	Required Enum: DirectoryAdDomain
selective_sync_settings	SelectiveSync settings SelectiveSync settings toggle the SelectiveSync feature and selected OrgUnits. If this is not specified, SelectiveSync is disabled by default.	SelectiveSyncSettings
sync_settings	Directory domain sync settings Each domain sync settings can be changed using this object. It is not required since there are default values used if there is no specification for this object.	DirectoryDomainSyncSettings
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

PUT https://<nsx-mgr>/api/v1/directory/domains/e38b4362-0638-4bbe-89ad-c76cd9b3167d { "resource_type": "DirectoryAdDomain", "description": "Active directory domain nimbustest.com", "display_name": "NIMBUS TEST", "base_distinguished_name": "DC=nimbustest,DC=com", "netbios_name": "NIMBUSTEST", "name": "nimbustest.com", "ldap_servers": [ { "resource_type": "DirectoryAdLdapServer", "display_name": "nimbus ldap test", "host": "10.192.210.96", "username": "dummy", "password": "dummy", "thumbprint": "3b1f4f3b636569d648a3092fc5b5b00fe4f6ec6abd34de86ae657f4bba22913e", "port": 389, "protocol": "LDAP" } ], "sync_settings": { "delta_sync_interval": 100 }, "selective_sync_settings": { "enabled": true, "selected_org_units": [ "OU=OU11,OU=OU1,DC=nimbustest,DC=com", "OU=OU21,OU=OU1,DC=nimbustest,DC=com" ] } "_revision": 1 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

DirectoryAdDomain+

DirectoryAdDomain (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
base_distinguished_name	Directory domain base distinguished name Each active directory domain has a domain naming context (NC), which contains domain-specific data. The root of this naming context is represented by a domain's distinguished name (DN) and is typically referred to as the NC head.	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
event_log_servers	Event Log server of directory domain Directory domain Event Log server's information including host, name, protocol and so on.	array of DirectoryEventLogServer	Readonly Maximum items: 50
id	Unique identifier of this resource	string	Sortable
ldap_servers	LDAP server of directory domain Directory domain LDAP servers' information including host, name, port, protocol and so on.	array of DirectoryLdapServer	Required Maximum items: 50
name	Directory domain name Directory domain name which best describes the domain. It could be unique fqdn name or it could also be descriptive. There is no unique contraint for domain name among different domains.	string	Required
netbios_name	Directory domain NETBIOS name NetBIOS names can contain all alphanumeric characters except for the certain disallowed characters. Names can contain a period, but names cannot start with a period. NetBIOS is similar to DNS in that it can serve as a directory service, but more limited as it has no provisions for a name hierarchy and names are limited to 15 characters. The netbios name is case insensitive and is stored in upper case regardless of input case.	string	Required
resource_type	Must be set to the value DirectoryAdDomain	string	Required Enum: DirectoryAdDomain
selective_sync_settings	SelectiveSync settings SelectiveSync settings toggle the SelectiveSync feature and selected OrgUnits. If this is not specified, SelectiveSync is disabled by default.	SelectiveSyncSettings
sync_settings	Directory domain sync settings Each domain sync settings can be changed using this object. It is not required since there are default values used if there is no specification for this object.	DirectoryDomainSyncSettings
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "resource_type": "DirectoryAdDomain", "description": "Active directory domain nimbustest.com", "id": "876f66eb-64c1-4b0c-9489-ae8c6ebfcc32", "name": "nimbustest.com", "display_name": "NIMBUS TEST", "base_distinguished_name": "DC=nimbustest,DC=com", "netbios_name": "NIMBUSTEST", "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 } ], "sync_settings": { "delta_sync_interval": 100 }, "selective_sync_settings": { "enabled": true, "selected_org_units": [ "OU=OU11,OU=OU1,DC=nimbustest,DC=com", "OU=OU21,OU=OU1,DC=nimbustest,DC=com" ] } "_last_modified_user": "admin", "_last_modified_time": 1531939962695, "_system_owned": false, "_create_user": "admin", "_create_time": 1531936487738, "_protection": "NOT_PROTECTED", "_revision": 2 }

Required Permissions:

crud

Feature:

directory_service

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