Initiate password reset procedure

  • 1 minute(s) read
Prev Next
Post
/identity/users/forgotPassword

When invoked, the user receives an email with a password reset URL to be followed.
For instance:
https://acme.servitly.com/password-reset/c7be1078-01b8-4621-a1ef-ae0f1ae7d15a

Note that the last part of the URL (c7be1078-01b8-4621-a1ef-ae0f1ae7d15a) represents the token required by the resetPassword and validateUserPassword API.
The token has a duration of 1 hour.
For security reasons wrong email addresses are ignored, and the API does not fail.

Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired

The name of the target tenant (e.g. acme).

Body parameters

The target email where to send the reset password link.

object
email
string Required

The address of the user to whom the password reset email should be sent.

Responses
204

Reset successful triggered.

400

Request data not valid.

object
message
string

The error response.

ExampleBad request
401

User not authenticated.

object
message
string

The error response.

ExampleUser not authenticated
403

User not authorized.

object
message
string

The error response.

ExampleUser not authorized
429

API call rate limit exeeded.

object
message
string

The error response.

ExampleAPI call rate limit exeeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error