Documentation Index

Fetch the complete documentation index at: https://learn.servitly.com/llms.txt

Use this file to discover all available pages before exploring further.

Initiate password reset procedure

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 tenant (e.g. acme).

Body parameters

The target email address to which the reset password link must be sent.

object
email
string Required

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

Responses
204

Reset successfully 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 exceeded.

object
message
string

The error response.

ExampleAPI call rate limit exceeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error