Totp (Section)#

Path: /profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/totp

Parameters#

NameTypeRequiredDefaultDescription
algorithmenumerationoptionalsha1The algorithm used to produce the TOTP. This parameter is ignored by some implementations and defaults to SHA1.
allow-multiple-device-registrationbooleanoptionalfalseAllow multiple device registrations. Defaults to false.
allow-registration-during-loginbooleanoptionaltrue
auto-login-enabledbooleanoptionalfalseWhen active a login will be automatically performed after a successful registration.
auto-redirect-enabledbooleanoptionalfalseAuto-redirect to registration page if no TOTP device is already registered
clock-skewint32optional0Clock skew in seconds
delay-windowint32optional1The Delay window of the algorithm. Greater number means that a TOTP can be used for a period of time so many times longer than the interval (delay window * interval).
device-expirationint32optionalSet a device expiration in seconds from the time the device is activated, if not set devices never expires. If this is set, it is not possible to override in the template. Only one device can be active per account, registering a new device expires any previous ones.
device-typestringoptionalidsvr-totpThe device type (or vendor) that will be stored in the device store. This is used in registration as well as on the lookup of the devices the user has associated. If you only use one device type, it is suggested to leave this setting as is. Otherwise refer to the documentation on how this is used exactly.
digitsint32optional6Determines how long of a one-time passcode to display to the user. This parameter is ignored by some implementations and defaults to 6.
intervalint32optional30The interval of the TOTP device. This parameter is ignored by some implementations and defaults to 30 seconds.

Subsections#

NameTypeDescription
account-manager SectionNone
bucket SectionNone
key-distribution-settings OneOfNone

Was this helpful?