Resets user password

  • 1 minute(s) read
Prev Next
Post
/identity/users/resetPassword

To invoke this API it is required to obtain a token through the forgotPassword API.
In the event that the password provided does not meet the minimum security criteria, the error message regarding failed validation is returned in the response with code 204.

Security
HTTP
Type bearer
Body parameters

The new password to set.

object
newPassword
string

The new password to set which must be at least 8 characters long and must contain at least: one lower case letter, one upper case letter and one number.

newPasswordConfirmation
string

The new password to set again.

token
string

The secure token provided through the URL received within the reset password email.

Examplec7be1078-01b8-4621-a1ef-ae0f1ae7d15a
Responses
204

Reset password succeeded.

400

Bad request or invalid password.

object
message
string

The validation error message.

ExampleYour password must be 8 characters or longer an....
401

User not authenticated.

object
message
string

The error response.

ExampleUser not authenticated
403

User not authorized.

object
message
string

The error response.

ExampleUser not authorized
429

API call rate limit exeeded.

object
message
string

The error response.

ExampleAPI call rate limit exeeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error