REST API Reference Version 3.1.0.0Search

Test_user

POST v1/active_directory_memberships/id/actions/test_user

Description

Tests whether the user exist in the Active Directory. If the user is present, then the user's group and role information is reported.

Normal Response Codes

200

HTTP Error Codes

400 401 404 409 500 503

Detail Error Codes

Request

Parameter Type JSON Type Description Mandatory
id NsObjectID string ID of the Active Directory. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. true
name NsUserName string Name of the Active Directory user. String of up to 80 alphanumeric characters, beginning with a letter. For Active Directory users, it can include backslash (\), dash (-), period (.), underscore (_) and space. Example: 'user1', 'companydomain\user1'. true

JSON Request

Response

Parameter Type JSON Type Description
user_info NsADTestUserReturn object Active Directory domain user information. Active Directory user details.

JSON Response