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
- Accept
enum 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
- id
string
ID
- title
string
Title
- enabled
boolean
Specifies if the TFA settings are enabled or not
- avaliable
boolean
Specifies if the TFA settings are available or not
- trustedIps
array of string
List of trusted IP addresses
- mandatoryUsers
array of string
List of users who must use the TFA verification
- mandatoryGroups
array of string
List of groups who must use the TFA verification
401
Unauthorized