Read

GET v1/active_directory_memberships

Query parameters

Parameter	Type
startRow	NsUnsignedLong
endRow	NsUnsignedLong
sortBy	NsString
iSortBy	NsString
pageSize	NsUnsignedInt
id	NsObjectID
description	NsDescription
name	NsDomainName
netbios	NsNetbiosName
computer_name	NsActiveDirectoryComputerName
organizational_unit	NsOrganizationalUnit
user	NsDomainUser
password	NsDomainPassword
enabled	NsBoolean

GET v1/active_directory_memberships/detail

Query parameters

Parameter	Type
startRow	NsUnsignedLong
endRow	NsUnsignedLong
sortBy	NsString
iSortBy	NsString
fields	NsCommaSeparatedList
pageSize	NsUnsignedInt
id	NsObjectID
description	NsDescription
name	NsDomainName
netbios	NsNetbiosName
computer_name	NsActiveDirectoryComputerName
organizational_unit	NsOrganizationalUnit
user	NsDomainUser
password	NsDomainPassword
enabled	NsBoolean

GET v1/active_directory_memberships/id

Query parameters

Parameter	Type
fields	NsCommaSeparatedList

Description

List the Active Directory Information.

Normal Response Codes

200 206

HTTP Error Codes

400 401 403 404 500 503

Detail Codes

SM_complex_type_query_param

SM_invalid_path_variable

SM_invalid_query_param

SM_malformed_url

SM_no_method_for_URL_pattern

SM_no_operation_found

SM_no_path_found

SM_start_row_beyond_end_row

SM_start_row_beyond_total_rows

SM_unexpected_query_param

SM_unsupported_query_operator

SM_version_name

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.
user	NsDomainUser	string	Name of the Activer Directory user with Administrator's privilege. Active Directory username. String up to 104 printable characters. Example: 'joe-91'.
password	NsDomainPassword	string	Password for the Active Directory user. Active Directory user password. String up to 255 printable characters. Example: 'password-91'.
enabled	NsBoolean	boolean	Active Directory authentication is currently enabled. Possible values: 'true', 'false'.

JSON Response