Reset Password

POST

/v1/users/reset-password

const url = 'https://example.com/api/v1/users/reset-password';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"password":"example","token":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/users/reset-password \
  --header 'Content-Type: application/json' \
  --data '{ "password": "example", "token": "example" }'

Consumes a single-use reset token and changes the user’s password. On success, all existing sessions for the user are revoked.

Request Body^required

Token + new password

application/json

object

password

required

string

>= 6 characters

token

required

string

>= 20 characters

Example ^generated

{
  "password": "example",
  "token": "example"
}

Responses

204

No Content

400

Invalid request body, password shorter than the minimum length, or token that is invalid / expired / already used

application/json

string

Example ^generated

example

403

Demo mode is enabled or local login is disabled

application/json

string

Example ^generated

example

500

Internal error while processing the request

application/json

string

Example ^generated

example

Reset Password

Request Body required

Example generated

Responses

204

400

Example generated

403

Example generated

500

Example generated

Request Body^required

Example ^generated

Example ^generated

Example ^generated

Example ^generated