Skip to main content

Create password reset URL ticket for user

The endpoint provides functionality for creating a password reset URL ticket of an already existing user, and notifies the user via the relevant Email template.

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

For authorization, a JWT is required.

HTTP request

POST 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

Request body

The URL ticket can be created by calling the endpoint with an empty request body.

Parameters

ParameterInDescription
urlPrefix StringbodyOptional The base of the password reset link within the notification email
Default: https://<instance-id>.id.nevis.cloud/account/pwreset/?x=
stateName EnumbodyOptional The state of the URL Ticket
Default: active
Values: active,initial, tmp-locked, disabled, archived

Example

{
"urlPrefix": "https://my-company.com/?passwordReset=",
"stateName": "active"
}

HTTP response

On success

HTTP/1.1 201 is returned if the URL ticket is successfully created.

The response contains the following additional header, containing the userExtId of the user:

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

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.