Create
POST v1/active_directory_memberships
Description
Joins with the Active Directory domain.
Normal Response Codes
201
HTTP Error Codes
400 401 404 409 500 503
Detail Error Codes
Request
| Parameter | Type | JSON Type | Description | Default | Mandatory | Deprecated |
|---|---|---|---|---|---|---|
| name | NsDomainName | string | Identifier for the Active Directory domain. Domain name for the Active Directory. Example: 'abc.corp'. | Yes | ||
| netbios | NsNetbiosName | string | Netbios name for the Active Directory domain. Netbios name for the Active Directory. Example: 'corp'. | The short form of the domain name | No | |
| server_list | NsActiveDirectoryServerList | string | List of IP addresses or names for the backup domain controller. Comma separated strings of up to 63 characters of hostname and/or ip addresses. Total length cannot exceed 255 characters. | '' | No | |
| computer_name | NsActiveDirectoryComputerName | string | The name of the computer account in the domain controller. Name of the computer account in Active Directory. Example: 'storage-array01'. | Last 15 characters of the array's group name | No | |
| organizational_unit | NsOrganizationalUnit | string | The location for the computer account. The location where the computer account has to be created. The value should be specified in fully distinguished name (DN) format. Reserved characters - comma, plus sign, double quote, backslash, left angle bracket, right angle bracket, semicolon, linefeed, carriage return, equals sign and forward slash must be escaped. Example: ou=ABC\, San Jose,dc=MY,dc=LOCAL. | 'Computers' | No | |
| user | NsDomainUser | string | Name of the Activer Directory user with Administrator's privilege. Active Directory username. String up to 255 printable characters. Example: 'joe-91'. | Yes | ||
| password | NsDomainPassword | string | Password for the Active Directory user. Active Directory user password. String up to 255 printable characters. Example: 'password-91'. | Yes | ||
| enabled | NsBoolean | boolean | Active Directory authentication is currently enabled. Possible values: 'true', 'false'. | true | No |
JSON Request
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | Identifier for the Active Directory Domain. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| description | NsDescription | string | Description for the Active Directory Domain. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. | |
| name | NsDomainName | string | Identifier for the Active Directory domain. Domain name for the Active Directory. Example: 'abc.corp'. | |
| netbios | NsNetbiosName | string | Netbios name for the Active Directory domain. Netbios name for the Active Directory. Example: 'corp'. | |
| computer_name | NsActiveDirectoryComputerName | string | The name of the computer account in the domain controller. Name of the computer account in Active Directory. Example: 'storage-array01'. | |
| organizational_unit | NsOrganizationalUnit | string | The location for the computer account. The location where the computer account has to be created. The value should be specified in fully distinguished name (DN) format. Reserved characters - comma, plus sign, double quote, backslash, left angle bracket, right angle bracket, semicolon, linefeed, carriage return, equals sign and forward slash must be escaped. Example: ou=ABC\, San Jose,dc=MY,dc=LOCAL. | |
| enabled | NsBoolean | boolean | Active Directory authentication is currently enabled. Possible values: 'true', 'false'. |
JSON Response