unlinkTfaApp
StringWrapper unlinkTfaApp(TfaRequestDto)
PUT /api/2.0/settings/tfaappnewapp
Unlink the TFA application
Detaches the authenticator application from an account, so that the account has to link a new one before it can sign in again. id has to name an existing account: an empty or unknown value is refused. Passing the caller's own ID resets their own credential and returns the activation link they should follow next; passing another member's ID is allowed for the portal owner only, and every other caller, a DocSpace administrator included, is refused. The account has to have an application linked and the authenticator method has to be enabled on the portal, otherwise the call answers 405, and a terminated account is refused. The call is destructive: the account's backup codes are dropped together with the credential and all of its sessions are signed out. For another member the portal also emails them that their TFA was reset, and the answer is then an empty string. The portal-wide policy is not touched, so TFA stays required and the account sets up an application again through GET api/2.0/settings/tfaapp/confirm; lift the requirement for everyone with PUT api/2.0/settings/tfaapp.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| TfaRequestDto | body | TfaRequestDto | [optional] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | The activation link when the caller reset their own application, or an empty string when another member's was reset | StringWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 400 | The request body cannot be read, type is null, an empty string or a string that is neither a number nor built from the names None, Sms and App, or a trustedIps entry is not a single address, an inclusive range or a CIDR block, although this call reads only id | - | - |
| 403 | The caller is not the portal owner, the account cannot be resolved from id, or the account is terminated | - | - |
| 405 | The authenticator method is not enabled on this portal, or the account has no application linked | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 500 | Internal Server Error. | ErrorApiResponse | - |
| 502 | Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
| 503 | Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
Return type
Authorization
Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId
HTTP request headers
- Content-Type: application/json
- Accept: application/json