Reset Password

Updates the user's password to the new password provided in the request. Calling this API will revoke the user's active auth sessions and refresh tokens.

Note, this API can be called in three distinct ways.

  1. The first way is from a password reset email containing a verification link. With this approach, the emailAuthCode field must be provided in the request body.
  2. The second way is from a password reset email containing an OTP. With this approach, the requestCode and verificationCode fields must be provided in the request body.
  3. The third way is from a password reset link. With this approach, the passwordResetCode field must be provided in the request body.

Several responses can be returned from this API. Please refer to the result response field description to see the different types of responses that can be returned.

Required Permissions

Below is the list of required permissions needed to interact with this API. For each permission, the allowed permission boundaries are also specified.

PermissionBoundaryDescription
password-reset-workflow:executeApplicationThe subject can perform this operation for requests associated with the application to which the subject belongs.

Language
Credentials
Bearer
JWT
URL
Click Try It! to start a request and see the response here!