Up - API Reference - Home
Request a password reset.
Note: resetting a forgotten password is a two-step process; this is the first step that initiates the action, the second step completes it, see
/api/reset_password.
POST /api/reset_password_request
{
"username_or_email": "<your-username-or-email-here>"
}
username_or_email is either a username or an email address. A username is case-sensitive, an email address is not.
{
"success": true,
"result": {
"validation_code": "<validation-code>",
"usernames": ["<username-for-username_or_email>"],
},
"data": {}
}
Also, an email is sent to the associated email address. This email contains a 6-character verification code. This one-time code is valid for 15 minutes. Both validation and verification codes must be submitted in step 2.
validation_code is one of the codes that must be submitted in the completion step - the other code is sent via email.
usernames a list of usernames that can be used for the password reset.
The list of usernames will have a single name in the majority of cases; however, an email address may be used for more than one account, so in those cases more than one username will be returned, and a choice must be made to complete step 2.
400 Bad request - missing parameters (only the first is reported)
422 Unprocessable entity - user not found