api:employee:resetauthenticatorkey
Table of Contents
API : Employee Reset Authenticator Key
Introduction
This request will remove the authenticator key for using 2FA on the specified employee.
Manager and up may call this API to clear the key on behalf of the user, so that the next login by the user will prompt for creation of a new key.
Request
| URL | https://api.telecomx.dk/employee/EMPLOYEE_ID/authenticatorkey/reset | |
|---|---|---|
| Method | POST | |
| Access level | MANAGER or OWNER who belongs to the customer, RESELLER who owns the customer or ADMIN. | |
| Param | EMPLOYEE_ID | Id of the employee (24 hex-char string) |
Request example
POST https://api.telecomx.dk/employee/1234567890ABCDEF1234578/authenticatorkey/reset
Response
| Json object | ||
|---|---|---|
| success | Boolean | True on success. |
Example
{ success: true }
Errors
| Error code | Message | Description |
|---|---|---|
| 404 | id | Employee not found |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/employee/resetauthenticatorkey.txt · Last modified: 2021/09/03 08:57 by Per Møller