Reset password

Request

Resets a user's password

Bodyapplication/jsonrequired

reset_tokenstringrequired

Valid reset_token generated from the password login call or by initiating a password reset flow

new_passwordstringrequired

The new password

redirect_uristring

Redirect URI for redirecting the client after a successful password change

resourcestring

Resource to access after successful password change

require_mfaboolean

Require multi-factor authentication for this authentication request.

Default:false

Example:true

curl -i -X POST \
  https://api.sbx.transmitsecurity.io/cis/v1/auth/password/reset \
  -H 'Content-Type: application/json' \
  -d '{
    "reset_token": "string",
    "new_password": "string",
    "redirect_uri": "string",
    "resource": "string",
    "require_mfa": true
  }'

Responses

Bodyapplication/json

messagestringread-onlyrequired

Example:"Password changed successfully"

urlstringread-onlyrequired

URL to start the authorization flow with the new password

emailstringread-onlyrequired

User email to which the notification will be sent

Response

{
  "message": "Password changed successfully",
  "url": "string",
  "email": "string"
}