config properties mfa

Version

v1.2.1

mfa Type

object (mfa)

mfa Properties

Property	Type	Required	Nullable	Defined by
acquire_on_login	boolean	Required	cannot be null	Config
acquire_on_registration	boolean	Required	cannot be null	Config
enabled	boolean	Required	cannot be null	Config
optional	boolean	Required	cannot be null	Config
security_keys	object	Optional	cannot be null	Config
totp	object	Optional	cannot be null	Config

acquire_on_login

acquire_on_login configures if users are prompted creating an MFA credential on login.

acquire_on_login

• is required

• cannot be null

acquire_on_login Type

boolean

acquire_on_registration

acquire_on_registration configures if users are prompted creating an MFA credential on registration.

acquire_on_registration

• is required

• cannot be null

acquire_on_registration Type

boolean

acquire_on_registration Default Value

The default value is:

true

enabled

enabled determines whether multi-factor-authentication is enabled.

enabled

• is required

• cannot be null

enabled Type

boolean

enabled Default Value

The default value is:

true

optional

optional determines whether users must create an MFA credential when prompted. The MFA credential cannot be deleted if multi-factor-authentication is required (optional: false).

optional

• is required

• cannot be null

optional Type

boolean

optional Default Value

The default value is:

true

security_keys

security_keys configures security key settings for multi-factor-authentication

security_keys

• is optional

• cannot be null

security_keys Type

object (security_keys)

totp

totp configures the TOTP (Time-Based One-Time-Password) method for multi-factor-authentication.

totp

• is optional

• cannot be null

totp Type

object (totp)