Remove

POST v1/active_directory_memberships/id/actions/remove

Description

Leaves the Active Directory domain.

Normal Response Codes

200

HTTP Error Codes

400 401 403 404 409 500 503

Detail Codes

SM_invalid_arg_value

SM_invalid_path_variable

SM_invalid_query_param

SM_malformed_url

SM_missing_arg

SM_no_action_found

SM_no_method_for_URL_pattern

SM_no_operation_found

SM_no_path_found

SM_unexpected_arg

SM_unexpected_child

SM_unexpected_query_param

SM_unknown

SM_version_name

Request

Parameter Type JSON Type Description Mandatory
id NsObjectID string ID of the active directory. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. true
user NsDomainUser string Name of the Activer Directory user with the privilege to leave the domain. Active Directory username. String up to 104 printable characters. Example: 'joe-91'. true
password NsDomainPassword string Password for the Active Directory user. Active Directory user password. String up to 255 printable characters. Example: 'password-91'. true
force NsBoolean boolean Use this option when there is an error when leaving the domain. Possible values: 'true', 'false'. false

JSON Request


            
                
        
         

Response

Type:

JSON Response