Validate an LDAP user password

Validates the LDAP password of a user.

Request

POST
/GmaApi/users/{gtwayUUID}/checkPassword

Example cURL request

# curl -v -X POST -H "Authorization: Bearer
644d0ac0-908f-485a-ac8d-b5bb99f200d7" -d "password=core1234"
https://hostname/GmaApi/users/68567181-2cf1-4b2b-bc10-6d6f05afb8e7/checkPassword

Resource URI

https://hostname/GmaApi/users/{gtwayUUID}/checkPassword

Authorization header

For information about obtaining an access token, see Request an access token.

Request parameters

Table 1. Path parameters
Parameter	Type	Required	Description
gtwayUUID	String	Yes	The gtwayUUID of the user to check the password for. The password is validated by the gtwayUUID. Note: You can use the `GET /GmaApi/users/{username}` method to retrieve the gtwayUUID of a user.

Table 2. Request body parameters
Parameter	Type	Required	Description
password	String	Yes	The password to validate.

Example response

{"status":"success"}

Response parameters

Table 3. Response parameters
Parameter	Description
status	Returns whether the request was successful. Returns an error when the request is unsuccessful. For more information about errors, see Errors.