Difference between revisions of "RecoverPasswordLink"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Create a link to recover user's password. The link is sent to the user's e-mail. |Parameters= {{Api_Parameter| ParamName=deviceType |ParamType=in...") |
(No difference)
|
Latest revision as of 20:10, 3 June 2014
Description
Create a link to recover user's password. The link is sent to the user's e-mail.
Parameters
- deviceType (int, required)
- The device type code (see DeviceType enumeration to know the list of device types allowed)
- 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 link.
Returns
Returns a JSON object containing a boolean information about if is possible or not recover the password link.
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content": true
}
Exceptions
Caching
This method is not cached.
Known issues
None
Version history
API Version Number | Change description | Changes author |
---|---|---|
1.0 | Initial method design | Harley Cabral |