SG Developers Sending a ‘lost password’ link via email
Sending a ‘lost password’ link via email
If you want to offer your applicants a password recovery functionality use the /lostPasswordLink endpoint directly for the first step of that process – sending an ‘lost password’ link to the applicants email address. That link will lead him to the page where he can reset the password to a new one in a second step.
Request with tokens
By sending the following POST-request, you can ask for the link:
|
1 2 |
curl -i -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -X POST https://api.softgarden.io/api/rest/v2/frontend/lostPasswordLink?email={email}&url={url} |
with TOKEN being either a client access token or a user access token. It is used to determine the validity of this request. The both query parameters {email} and {url} are the email address of the applicant who lost his password and the URL of the page, where he can reset his password.
Request with basic authorization
As an alternative, you can use here the basic authorization method. Just write
|
1 2 |
curl -i -u "{clientId}:" -H "Content-Type: application/json" -X POST "https://api.softgarden.io/api/rest/v2/frontend/lostPasswordLink?email={email}&url={url}" |
{clientId} is the ID for your application to develop given to you by softgarden. The colon seen in the example is obligatory.
Path parameters
– none –
Query parameters
| Name | Description | Data Type | Default Value |
|---|---|---|---|
| The email address of the applicant who lost his password. | String | n/a | |
| url | The URL of the page, where the password can be reset. It will be contained in the email, which is send to the applicant. | String | n/a |
Response values
| Upon | Returned value | Description |
|---|---|---|
| failure | 500 – INTERNAL SERVER ERROR | When an error appears while processing your request, e.g. the email address was invalid. |
| authorization error | 401 / 403 | See here for details. |
You won’t get any feedback if your request succeeds.