Request Reset Password for User API
Does not require Authentication
This API is used to request reset password for user in forgot password link.
When request reset password for user is successful:
- System will send an email to user that contain a link to reset his/her password
- When that link is clicked, it will be redirected to web browser to set his/her new password
- That link will only valid for 12 hours only
URL
api/users/forgotpassword
Required parameter
- username «contains user email address, must be exist in database»
Optional parameter
- timezoneOffset «explanation see note at the bottom of this page»
- timezoneName «explanation see note at the bottom of this page»
Example JSON Payload
{
"username": "indr4_winata@yahoo.com",
"timezoneOffset": 420,
"timezoneName": "Asia/Jakarta"
}
Possible return HTTP status code
- 200
- 400
- 404
- 405
Return message
{
"status": "success",
"message": {
"email": "indr4_winata@yahoo.com",
"forgotPasswordDate": 1449742206,
"forgotPasswordKey": "5c5decd62228867d2e3c0a5c619659c9",
"forgotPasswordValidUntilDate": 1449785406,
"timezoneOffset": 420,
"timezoneName": "Asia/Jakarta",
"server_timezoneOffset": 600
}
}
Note:
"timezoneOffset" contains user time differences to UTC in minutes. For example, if it is 420, it means that it is UTC +7 hour (420 minutes / 60 minutes × 1 hour = 7 hour)
"timezoneName" contains user timezone name as mentioned in http://php.net/manual/en/timezones.php
To display valid until date, please convert it to use proper date depends on user timezone. To calculate it, please refer to API Documentation Home section API Standards