Get the TFA settings

GET /api/2.0/settings/tfaapp

Request

Returns the current two-factor authentication settings.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Examples

GET /api/2.0/settings/tfaapp HTTP/1.1
Accept: application/json
Host: example.com
curl --request GET \
  --url https://example.com/api/2.0/settings/tfaapp \
  --header 'Accept: application/json'

Responses

200

TFA settings

idstring

ID

titlestring

Title

enabledboolean

Specifies if the TFA settings are enabled or not

avaliableboolean

Specifies if the TFA settings are available or not

trustedIpsarray of unknown

List of trusted IP addresses

mandatoryUsersarray of unknown

List of users who must use the TFA verification

mandatoryGroupsarray of unknown

List of groups who must use the TFA verification

401

Unauthorized

403

Forbidden

Get Help

  • If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).