Bureaucrats, editor
132
edits
Changes
Jump to navigation
Jump to search
RecoverPasswordHash (view source)
Revision as of 09:56, 16 September 2015
, 09:56, 16 September 2015Created 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..."
{{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 by the token. The hash parameter is introduced in order to improve data integrity.
|Parameters=
{{Api_Parameter|
ParamName=instanceId
|ParamType=int
|ParamRequired=required
|ParamDescription=The id of the instance (OB) for the current environment. This ID might vary depending on the environment.
}}
{{Api_Parameter|
ParamName=userName
|ParamType=String
|ParamRequired=required
|ParamDescription=E-mail from the user that wants to recover the password.
}}
{{Api_Parameter|
ParamName=deviceType
|ParamType=int
|ParamRequired=required
|ParamDescription=The device type code (see #DeviceTypeCodes enumeration to know the list of device types allowed)
}}
{{Api_Parameter|
ParamName=hash
|ParamType=string
|ParamRequired=required
|ParamDescription=Parameter used to preserve confidentiality.
}}
|Returns=
|Cache=
This method is not cached.
|KnownIssues=
None
|VersionHistory=
|SeeAlso=
* [[RecoverPassword]]
* [[RecoverPasswordLink]]
}}
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=
{{Api_Parameter|
ParamName=instanceId
|ParamType=int
|ParamRequired=required
|ParamDescription=The id of the instance (OB) for the current environment. This ID might vary depending on the environment.
}}
{{Api_Parameter|
ParamName=userName
|ParamType=String
|ParamRequired=required
|ParamDescription=E-mail from the user that wants to recover the password.
}}
{{Api_Parameter|
ParamName=deviceType
|ParamType=int
|ParamRequired=required
|ParamDescription=The device type code (see #DeviceTypeCodes enumeration to know the list of device types allowed)
}}
{{Api_Parameter|
ParamName=hash
|ParamType=string
|ParamRequired=required
|ParamDescription=Parameter used to preserve confidentiality.
}}
|Returns=
|Cache=
This method is not cached.
|KnownIssues=
None
|VersionHistory=
|SeeAlso=
* [[RecoverPassword]]
* [[RecoverPasswordLink]]
}}
