Skip to main content

TfaSettingsDto

One two-factor authentication method the portal offers, with the portal-wide state of that method.

NameTypeDescriptionNotes
idStringWhich method this entry describes: sms for a code sent by text message, app for a code from an authenticator application. It is the value PUT api/2.0/settings/tfaapp takes as its type, and no other value ever appears here.[required] [example: app] [nullable]
titleStringThe label for the method in the portal language, meant for a button or a radio option. It is not stable enough to branch on - match id for that.[required] [example: Authenticator app] [nullable]
enabledBooleanWhether this method is the portal's current policy. At most one entry can have it set, and none has it while the portal challenges nobody. It says nothing about the caller's own account, which may be exempt through trustedIps or forced through mandatoryUsers.[required] [example: true]
availableBooleanWhether the method could be switched on at all. For sms it is false until the installation has a working SMS provider, so a method can be offered here and still be impossible to enable; for app it is always true.[required] [example: true]
trustedIpsListThe addresses that skip the challenge, each either a single address, a from-to pair or a CIDR range. It is empty when no address is exempt, which means every account is challenged.[optional] [example: [192.0.2.0/24]] [nullable]
mandatoryUsersList (uuid)The accounts that are challenged even from a trusted address, by user ID. Empty means the exemption in trustedIps holds for everyone.[optional] [example: [00000000-0000-0000-0000-000000000000]] [nullable]
mandatoryGroupsList (uuid)The groups whose members are challenged even from a trusted address, by group ID, with the same reading of an empty list as mandatoryUsers.[optional] [example: [00000000-0000-0000-0000-000000000000]] [nullable]