JSON API » user » user/password/lost
Sends a user their web password reset link via email.
Input parameters
Does not require authentication.
| Name | Type | Description | Required | Default value |
|---|---|---|---|---|
| username | String | User name. | Yes, unless email is specified. | |
| String | Email address. | Yes, unless username is specified. | ||
| web_base | String | Base URL for password reset link. | Yes, unless rate plan custom setting is set. | Rate plan custom setting. |
| path | String | URL path for password reset link. | No | "/user/password/update/" |
Either the username or email must be specified. If both are specified, the username is used.
Responses
| Code | Description |
|---|---|
| 204 | If the person exists, an email was sent. If not, no action was taken. |
| 400 | Invalid input parameters specified. Check the key and message fields for more details. |
| 500 | An error occurred within the server. Check the key and message fields for more details. |
Data returned
No data is returned.
Example: With username
http://enswitch.example.com/api/json/user/password/lost/?username=user@example.com{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] ] }
Change history
| Version | Changes |
|---|---|
| 3.13 | Function added. |