Resetting passwords

Enable users to reset their forgotten passwords.

How it works

Submit an email address to the API for lookup. Upon success, an email is sent to the user containing a tokened link back to your reset password page for submission with the new password.

Prerequisites

Your application must have a reset URL defined in the dashboard settings. This URL serves as the base endpoint for the link included in the email sent to the user.

Lookup email address

Provide an email address to receive a system-generated email containing instructions for resetting a password.

Request

POST /v1/auth/forgot-password
{
  "email": "jdoe@acmecorp.com"
}

Response

Upon success, an email is sent to the user with instructions containing a tokened link to your reset password page.

The response contains FYI data.

{
  "user_ids: [
    "usr_1234567890",
    ...
  ]
}

Upon error, the API will respond with an error object.

// error object
{
  "error": {
   ...
  }
}

Reset password

The link in the reset password email includes a token that needs to be submitted with the new password.

var token = new URLSearchParams(window.location.hash).get('token');

Request

POST /v1/auth/reset-password
{
  "token": token,
  "password": password,
  "confirm": confirm
}

Response

Upon success, the API will respond with the User object, and you can begin the user log in process.

// user object
{
  "id": "usr_1234567890"
  ...
}

Upon error, the API will respond with an error object.

// error object
{
  "error": {
   ...
  }
}