Difference between revisions of "RecoverPasswordHash"

From Gvp-public
Jump to navigation Jump to search
 
(3 intermediate revisions by one other user not shown)
Line 31: Line 31:
  
 
|Returns=
 
|Returns=
 +
Boolean value. True if the password has been reset, false otherwise.
 +
 +
|Exceptions=
 
<span style="color: #a11;">TO BE COMPLETED</span>
 
<span style="color: #a11;">TO BE COMPLETED</span>
  
 
|Cache=
 
|Cache=
<span style="color: #a11;">TO BE COMPLETED</span>
+
This method is not cached.
  
 
|KnownIssues=
 
|KnownIssues=

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


See also