Use the following APIs to generate a password recovery link and reset the password.

Forgot Password

Header
If the user exists in multiple organizations, pass the request header x-org-domain-name.
API
/api/users/forgot-password
Description

This API takes the user name as input and generates a password recovery link. If the user name is valid, an email with the password recovery link is sent to the user. The link is valid for 15 minutes.

Method
POST
Required Parameters
Name Description
username

string

User name.
Input Example
{
    "username":""
}
Response
{ }

Reset Password

API
/api/users/reset-password
Description

This API resets the password for the given user name.

Method
POST
Required Parameters
Name Description
password

string

New password.
Input Example
{
    "password":""
}
Response
{ }