REST API Reference Version 5.2.1.0Search

Update

PUT v1/active_directory_memberships/id

Description

Updates the Active Directory configuration.

Normal Response Codes

200

HTTP Error Codes

400 401 403 404 409 500 503

Request

Parameter Type JSON Type Description Mandatory Deprecated
id NsObjectID string Identifier for the Active Directory Domain. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. false  
description NsDescription string Description for the Active Directory Domain. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. false  
netbios NsNetbiosName string Netbios name for the Active Directory domain. Netbios name for the Active Directory. Example: 'corp'. false  
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. false  
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'. false  
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. false  
enabled NsBoolean boolean Active Directory authentication is currently enabled. Possible values: 'true', 'false'. false  

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