Request Reset Password
The request reset password request sends an email to the specified email if it’s present in the provisioning addresses of the user.
The userspace parameter is typically selected by the program, and not by the user, and is not changed during the program’s lifetime.
A good practice is to choose a userspace name that is unique for the device on which the program is running, for example:
iphone-<username>
Having such a name helps to analyze server information.
Resource
POST /me/request_reset_password
Parameters
None
Response
None
Context
Authorization |
Guest |
Errors
HTTP code | Xelion code | Description |
---|---|---|
400 |
10002 |
no user name specified |
10003 |
no email specified |
|
401 |
10206 |
the email address or username you entered does not exist |
10207 |
something went wrong while sending the pin |
|
500 |
11000 |
A server error occurred. See error message for more information. |
Example
Request
POST https://xelion.nl/api/v1/master/me/request_reset_password
Payload
{
"userName": "arnon",
"email": "arnon@xelion.com",
"userSpace": "iphone-arnon"
}