MultiFactorConfig interface
Stay organized with collections
Save and categorize content based on your preferences.
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
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;
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-04-06 UTC.
[null,null,["Last updated 2023-04-06 UTC."],[],[],null,["# MultiFactorConfig interface\n\nInterface 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.\n\n**Signature:** \n\n export interface MultiFactorConfig \n\nProperties\n----------\n\n| Property | Type | Description |\n|------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| [factorIds](./firebase-admin.auth.multifactorconfig.md#multifactorconfigfactorids) | [AuthFactorType](./firebase-admin.auth.md#authfactortype)\\[\\] | The list of identifiers for enabled second factors. Currently only 'phone' is supported. |\n| [providerConfigs](./firebase-admin.auth.multifactorconfig.md#multifactorconfigproviderconfigs) | [MultiFactorProviderConfig](./firebase-admin.auth.multifactorproviderconfig.md#multifactorproviderconfig_interface)\\[\\] | A list of multi-factor provider configurations. MFA providers (except phone) indicate whether they're enabled through this field. |\n| [state](./firebase-admin.auth.multifactorconfig.md#multifactorconfigstate) | [MultiFactorConfigState](./firebase-admin.auth.md#multifactorconfigstate) | The multi-factor config state. |\n\nMultiFactorConfig.factorIds\n---------------------------\n\nThe list of identifiers for enabled second factors. Currently only 'phone' is supported.\n\n**Signature:** \n\n factorIds?: AuthFactorType[];\n\nMultiFactorConfig.providerConfigs\n---------------------------------\n\nA list of multi-factor provider configurations. MFA providers (except phone) indicate whether they're enabled through this field.\n\n**Signature:** \n\n providerConfigs?: MultiFactorProviderConfig[];\n\nMultiFactorConfig.state\n-----------------------\n\nThe multi-factor config state.\n\n**Signature:** \n\n state: MultiFactorConfigState;"]]