XPM

Update Password

Path:

PATCH auth/password

This endpoint is to reset the account password by using the reset password link sent to the user's email. Currently, we do not insist on any rigid password formats, so user can use their own choice of password, which is easier to remember.

Headers

Content-Typeapplication/json

Consumes

  • application/json

Produces

  • application/json

Parameters

Type: Body

Name: Reset token ID, system generated user ID, and the new password.

Required: true

Sample Request

{
"resetToken": "5ebd67b985fe410008041954",
"userId": "5e20f4f530d2b70008bb8738",
"newPassword": "Password12345!"
}

Response

HTTP Code : 200 Message : OK

Description: You will see this message when the user's password has been successfully changed.

Sample

{
"_id": "5e97947d3cb8553c0e43d87f",
"isActive": {
"status": true
},
"registrationDate": "2020-04-15T22:34:22.429Z",
"expiryDate": "2070-04-15T22:34:22.429Z",
"roles": [
"5de1646f8c6352091d944f1c"
],
"name": {
"first": "John",
"middle": "A",
"last": "Doe"
},
"phone": [
{
"_id": "5e97947d3cb8553c0e43d880",
"number": "123456789",
"countryCode": "+1",
"extension": "1234",
"kind": "mobile",
"id": "5e97947d3cb8553c0e43d880"
}
],
"email": "johndoe@fabric.inc",
"extra": {
"resetPassword": "requested"
},
"registrationSite": "abcde.com",
"account": "5e97947d3cb8553c0e43d87e",
"userId": 90,
"address": [],
"provider": [
{
"registrationDate": "2020-04-15T22:34:22.429Z",
"isActive": true,
"_id": "5e97947d3cb8553c0e43d881",
"name": "LOCAL",
"lastLoginDate": "2020-04-16T04:28:33.560Z",
"id": "5e97947d3cb8553c0e43d881"
}
],
"createdAt": "2020-04-15T23:10:53.773Z",
"updatedAt": "2020-04-16T04:59:53.755Z",
"__v": 0
}

HTTP Code : 404 Message : Not Found

Description: You'll see this error when the system user ID and/or rest token ID is incorrect.

Sample

{
"code": "USER_NOT_FOUND",
"message": "User not found."
}

Changelog

  • Last updated - July 2020