SG Developers Reset applicants password
Reset applicants password
If you want to offer your applicants a password recovery functionality use the /resetPassword endpoint directly for the second step of that process – resetting the applicants password. In the step before the applicant has successfully requested a ‘lost password’ link. Things like validating against a password policy have to be done by yourself.
Request with tokens
By sending the following POST-request, you can reset the password:
|
1 2 |
curl -i -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -X POST "https://api.softgarden.io/api/rest/v2/frontend/resetPasswordLink?email={password}" |
with TOKEN being either a client access token or a user access token. It is used to determine the validity of this request. The {password} query parameter declares the new password of the applicant.
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/resetPasswordLink?email={password}" |
{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 |
|---|---|---|---|
| password | The new password of the applicant. | String | n/a |
Response values
| Upon | Returned value | Description |
|---|---|---|
| success | true | If the password was reset successfully. |
| failure | false | When an error appears while processing your request, e.g. user access token is invalid. |
| failure | 500 – INTERNAL SERVER ERROR | When an error appears while processing your request. |
| authorization error | 401 / 403 | See here for details. |