Password reset
The password reset functionality consists of two different routes, one for requesting the password reset and one for executing the password reset.
Requesting a password reset
Url
POST http://api.hr-technologies.com/v1/users/forgot-password
| Parameters |
Required |
Description |
Example |
| email |
required |
The email linked to the user account that should get a password reset mail |
rthompson@example.com |
Response
| Key |
Type(s) |
Description |
| message |
string |
Confirms that an email has been send |
Executing a password reset
Url
POST http://api.hr-technologies.com/v1/users/forgot-password
| Parameters |
Required |
Description |
| key |
required |
verification key linked to the user that requested the password reset |
| new_password |
required |
The new password |
| confirm_new_password |
required |
Confirmation of the new password |
Response
| Key |
Type |
Description |
| message |
string |
Confirms that an password was successfully changed |