Skip to main content

Verify password reset ticket

The endpoint provides functionality to verify the password reset ticket of a user.

The password reset URL sent to the user by email contains a urlPrefix, and a password reset ticket that you can use for verification. Example password reset URL:

https://idcloud-customer.com/account/pwreset/?x=H%2ED2dLDaXTi16RWk5C2oOA~sT83MMdj9kd_LkM_kQLrm_cq3lQ%2ENjcOy%2EweGirQUQcO6G8HXe8ydsb04rxyWQBWoewYBlxTn%2ECZ0h7RqcIH_6yf_Kf_TxxlJxl54vDg36A

HTTP request

POST https://$instanceId.id.nevis.cloud/nevis/api/v1/auth/url-ticket

Parameters

ParameterInTypeRequired / OptionalDescription
instanceIdpathstringrequiredThe ID of your Identity Cloud instance

Request body

ParametertypeRequired / OptionalDescription
ticketstringrequiredThe ticket value
Example request

Set the ticket value.

ticket=H%2ED2dLDaXTi16RWk5C2oOA~sT83MMdj9kd_LkM_kQLrm_cq3lQ%2ENjcOy%2EweGirQUQcO6G8HXe8ydsb04rxyWQBWoewYBlxTn%2ECZ0h7RqcIH_6yf_Kf_TxxlJxl54vDg36A
curl --request POST "https://$instanceId.id.nevis.cloud/nevis/api/v1/auth/url-ticket" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $accessKey" \
--data "{ \"ticket\" : \"$ticket\" }"

HTTP response

On success

HTTP/1.1 200 is returned if the password reset ticket is successfully validated.

ParameterInDescription
loginId StringbodyThe login ID (username) of the user
userState EnumbodyThe state of the user
extId UUIDbodyExternal ID of the user
Example response

{
"loginId": "[email protected]",
"userState": "active",
"extId": "4a5e7346-488b-46f9-914f-79ddb1131e0b"
}

On failure

HTTP/1.1 401 is returned if the authorization failed due to an invalid access key.

HTTP/1.1 422 is returned if invalid request content was given.

HTTP/1.1 500 is returned if an unexpected error occurred.