Update the TFA settings

PUT /api/2.0/settings/tfaapp

Request

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

Authorization

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

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

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

typeinteger

TFA type (None, Sms, or App)

trustedIpsarray of string

List of trusted IP addresses

mandatoryUsersarray of string

List of users required for the TFA verification

mandatoryGroupsarray of string

List of groups required for the TFA verification

Examples

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

curl --request PUT \
  --url https://example.com/api/2.0/settings/tfaapp \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

True if an operation is successful

401

Unauthorized