MultiFactorConfig interface

Interface representing a multi-factor configuration. This can be used to define whether multi-factor authentication is enabled or disabled and the list of second factor challenges that are supported.

Signature:

export interface MultiFactorConfig

Properties

Property Type Description
factorIds AuthFactorType[] The list of identifiers for enabled second factors. Currently only ‘phone’ is supported.
providerConfigs MultiFactorProviderConfig[] A list of multi-factor provider configurations. MFA providers (except phone) indicate whether they're enabled through this field.
state MultiFactorConfigState The multi-factor config state.

MultiFactorConfig.factorIds

The list of identifiers for enabled second factors. Currently only ‘phone’ is supported.

Signature:

factorIds?: AuthFactorType[];

MultiFactorConfig.providerConfigs

A list of multi-factor provider configurations. MFA providers (except phone) indicate whether they're enabled through this field.

Signature:

providerConfigs?: MultiFactorProviderConfig[];

MultiFactorConfig.state

The multi-factor config state.

Signature:

state: MultiFactorConfigState;