Skip to main content

Validate password reset URL ticket of a user

The endpoint provides functionality for validating a password reset URL ticket of an already existing user.

The password reset URL sent to the user contains a urlPrefix depending on the customer, and a password reset URL ticket that you can use for validation. Example password reset URL:

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

The required values are the instanceId of the customer and the ticket of the user.

For authorization, a JWT is required.

HTTP request

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

Parameters

ParameterInDescription
instanceId UUIDpathRequired The ID of the customer instance
ticketbodyRequired The password reset URL ticket of the user

Request body

Parameters

ParameterInDescription
ticket StringbodyRequired The URL Ticket value

Example

{
"ticket": "H%2ED2dLDaXTi16RWk5C2oOA~sT83MMdj9kd_LkM_kQLrm_cq3lQ%2ENjcOy%2EweGirQUQcO6G8HXe8ydsb04rxyWQBWoewYBlxTn%2ECZ0h7RqcIH_6yf_Kf_TxxlJxl54vDg36A"
}

HTTP response

On success

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

Parameters

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

Example

{
"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 JWT.

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

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