Reset password

PreviousRemove a device from a user NextRevokes roles to a user

Last updated 2 months ago

Was this helpful?

Resets the user's password from the reset password token.

post

Header parameters

BrandUrlstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Body

This is the model class for ResetPassword.

emailAddressstring · email · min: 1Required

This represents the email of the user.

Example: example@jframework.io

tokenstring · min: 1Required

This represents the token of the user.

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9

newPasswordstring · min: 1Required

This represents the new password of the user.

Example: newpassword

Responses

200

The request was successful.

application/json

400

Your token was invalid.

application/json

404

The user was not found in the database.

application/json

429

The user has exceeded the rate limit.

application/json

post

POST /api/users/reset-password HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "emailAddress": "example@jframework.io",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
  "newPassword": "newpassword"
}

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": true,
  "errors": []
}