Difference between revisions of "RecoverPasswordHash"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=RecoverPasswordHash is the new version of the deprecated method RecoverPassword. Generate a new password and send it to logged user in this time...") |
|||
| (5 intermediate revisions by one other user not shown) | |||
| Line 26: | Line 26: | ||
|ParamType=string | |ParamType=string | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription=Parameter used to preserve confidentiality. | + | |ParamDescription=Parameter used to preserve confidentiality sended to the user e-mail. |
}} | }} | ||
|Returns= | |Returns= | ||
| + | Boolean value. True if the password has been reset, false otherwise. | ||
| + | |Exceptions= | ||
| + | <span style="color: #a11;">TO BE COMPLETED</span> | ||
|Cache= | |Cache= | ||
| Line 40: | Line 43: | ||
|VersionHistory= | |VersionHistory= | ||
| − | + | <span style="color: #a11;">TO BE COMPLETED</span> | |
|SeeAlso= | |SeeAlso= | ||
Latest revision as of 13:33, 23 February 2016
Description
RecoverPasswordHash is the new version of the deprecated method RecoverPassword. Generate a new password and send it to logged user in this time by the token. The hash parameter is introduced in order to improve data integrity.
Parameters
- instanceId (int, required)
- The id of the instance (OB) for the current environment. This ID might vary depending on the environment.
- userName (String, required)
- E-mail from the user that wants to recover the password.
- deviceType (int, required)
- The device type code (see #DeviceTypeCodes enumeration to know the list of device types allowed)
- hash (string, required)
- Parameter used to preserve confidentiality sended to the user e-mail.
Returns
Boolean value. True if the password has been reset, false otherwise.
Exceptions
TO BE COMPLETED
Caching
This method is not cached.
Known issues
None
Version history
TO BE COMPLETED
