voxel.hapi.users.reset_password

Request to reset users password.

Parameters

username (required)
The name the user will use to login to Voxel's web portal. Leave blank to create a hAPI-only user.
email (required)
The email address of the user.

Example Response

<?xml version="1.0"?>
 <rsp stat="ok">
    <result>Your password reset link is sent to your email account.</result>
 </rsp>

Notes

User should call this method with already registered username and email address using secured https endpoint. If the user information does match a valid user account then a email will be sent to users email account with request confirmation link. User has to confirm the password user request using the link in the email. Once this is done, password with be reset and another email will be sent to user containing new password.

Method Specific Error Codes

115: Unknown user
The passed in user information does not match to any valid user.
500: Method must be accessed via an SSL endpoint
This method may only be accessed from an SSL-enabled hAPI endpoint.

Rate Limits

Averaging Rate Limiter (Requests per period)
No more than 15 calls per Day.
This limit is per calling IP address.
Averaging Rate Limiter (Requests per period)
No more than 4 calls per Day.
This limit is per IP address per username.