Reset a Password
Reset the current user's password.
Summary
| Attribute | Value |
|---|---|
| Name | UserResetPassword |
| Functionality | Sets the user's password to a new value. Typically used in consequence of the user's manual interface with the payment pages, which has resulted in email-dispatch, and the user's subsequent click on a link in the email. |
| Endpoint | https://payments.mppglobal.com/interface/Mpp/eDeveloper/v8/eDeveloper.json.svc/UserResetPassword |
| HTTP Method | POST |
| Successful Response | 200 |
| SDK Status | Not featured |
Request Object
JSON
[javascript]
{
"UserPasswordResetInfo" : {
"Password" : "testP4ssword",
"LogUserIn" : true
}
}
[/javascript]
"UserPasswordResetInfo" : {
"Password" : "testP4ssword",
"LogUserIn" : true
}
}
[/javascript]
Request Parameters
| Parameter | Required | Data Type | Description |
|---|---|---|---|
| Password | Yes | String | The new password to be set for the user. |
| LogUserIn | No | Bool | Whether the user should be logged in automatically, following password-change. True means login occurs. If unset, value is system-interpreted as False. |
Response Object
The response to a UserResetPassword yields a UserPasswordReset object. For example:
JSON
[javascript]
{
“ClientUserId”: “testuser1”,
“GUID”: “503b6ba841334deea3b4537a2d73240f”
}
[/javascript]
“ClientUserId”: “testuser1”,
“GUID”: “503b6ba841334deea3b4537a2d73240f”
}
[/javascript]
Response Parameters
| Parameter | Can be null? | Data Type | Description |
|---|---|---|---|
| ClientUserId | Yes | String | The ClientUserId (if one exists) for the current user's account. |
| GUID | Yes | String | The X-SessionId for the user's current session, if one is indeed being used for client-side access. |