Skip to main content

View password reset URL ticket details

The endpoint provides detailed information on a password reset URL ticket of an already existing user, based on the unique user identifier.

The required values are the userExtId retrieved upon user creation, and the instanceId of the customer.

For authorization, a JWT is required.

HTTP request

GET https://${instanceId}.id.nevis.cloud/nevis/api/v1/users/${userExtId}/url-ticket

Parameters

ParameterInDescription
instanceId UUIDpathRequired The ID of the customer instance
userExtId UUIDpathRequired The ID of the given user

HTTP response

On success

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

Parameters

ParameterInDescription
personifiedLink StringbodyThe default urlPrefix and the hashed value of the URL Ticket
stateName EnumbodyThe state of the URL Ticket
created StringbodyThe date of the URL Ticket creation
lastModified StringbodyThe date of the last URL Ticket modification;
Initially equals the creation date
version IntegerbodyThe version of the URL Ticket, used for optimistic locking
validity Object
- from String
- to String
bodyThe start and end date of the URL ticket's validity period

Example

{
"personifiedLink": "https://idcloud-customer.com/account/pwreset/?x=6mQrI36AFVWyRTfv3KEEmETenxNtR4",
"stateName": "active",
"created": "2021-11-30T14:18:18Z",
"lastModified": "2021-11-30T14:18:18Z",
"validity": {
"from": "2001-01-02T00:00:00Z",
"to": "2031-01-12T00:00:00Z"
},
"version": 1
}

On missing user

HTTP/1.1 404 is returned if no user is found with the given userExtId, with a detailed message.

Example

{
"errors": [
{
"code": "errors.noRecord",
"message": "A user with extId cdc891da-51ea-11ec-bf63-0242ac130002 doesn't exist on client with name Client-users"
}
]
}

On missing URL ticket

HTTP/1.1 404 is returned with a detailed message if no password reset URL ticket is found with the given userExtId.

Example

{
"errors": [
{
"code": "errors.noRecord",
"message": "No URL ticket credential found."
}
]
}

On failure

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

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