api:auth:reset
Table of Contents
API : Authentication Request Password Reset
Introduction
This API is used by an un-authenticated user, who has forgotten her password, to request a password reset.
If 2-factor authentication is not used, and the e-mail address exists, an e-mail with a reset link will be sent to the users e-mail address.
Request
| URL | https://api.telecomx.dk/auth/reset | |
|---|---|---|
| Method | POST/GET | |
| Body/Query | username | E-mail address of the account to reset a reset link for. |
| method | Where to send the request to: EMAIL - for the users e-mail address (default) SMS for the users mobile phone, with fallback to email. |
|
Query example
{
username: 'donald@duck.com',
method: 'EMAIL'
}
Response
| JSON object | ||
|---|---|---|
| Property | Type | Description |
| success | Boolean | True on success |
| method | String | How the link was sent: EMAIL or SMS. |
Example
{ success: true, method: 'EMAIL' }
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | account | Account disabled |
| 403 | username | Employee is using 2-factor authentication |
| 403 | time | A password reset requests already exists, try again in 30 minutes. |
| 500 | internal_error | Internal server error |
api/auth/reset.txt · Last modified: 2025/02/03 20:40 by Per Møller