Update the TFA settings

PUT /api/2.0/settings/tfaapp

Request

Updates the two-factor authentication settings with the parameters specified in the request.

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.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

TFA settings request parameters

typeone of

.enum of string

[None - None, Sms - Sms, App - App]

Can be one of: None, Sms, App.

.enum of integer

[0 - None, 1 - Sms, 2 - App]

Can be one of: 0, 1, 2.

idstringformat: uuid

User ID

trustedIpsarray of string

List of trusted IP addresses

mandatoryUsersarray of string

List of users who must use the TFA verification

mandatoryGroupsarray of string

List of groups who must use the TFA verification

Examples

PUT /api/2.0/settings/tfaapp HTTP/1.1
Accept: application/json
Content-Length: 230
Content-Type: application/json
Host: example.com

{
  "id": "79ec6dcd-4617-4b7f-9ff1-6c3becf00e33",
  "trustedIps": [
    "some text"
  ],
  "mandatoryUsers": [
    "75a5f745-f697-4418-b38d-0fe0d277e258"
  ],
  "mandatoryGroups": [
    "75a5f745-f697-4418-b38d-0fe0d277e258"
  ]
}

curl --request PUT \
  --url https://example.com/api/2.0/settings/tfaapp \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "79ec6dcd-4617-4b7f-9ff1-6c3becf00e33",
  "trustedIps": [
    "some text"
  ],
  "mandatoryUsers": [
    "75a5f745-f697-4418-b38d-0fe0d277e258"
  ],
  "mandatoryGroups": [
    "75a5f745-f697-4418-b38d-0fe0d277e258"
  ]
}'

Responses

200

True if the operation is successful

401

Unauthorized

405

SMS settings are not available/TFA application settings are not available