MultiFactorInfo class
Stay organized with collections
Save and categorize content based on your preferences.
Interface representing the common properties of a user-enrolled second factor.
Signature:
export declare abstract class MultiFactorInfo
Properties
| Property |
Modifiers |
Type |
Description |
| displayName |
|
string |
The optional display name of the enrolled second factor. |
| enrollmentTime |
|
string |
The optional date the second factor was enrolled, formatted as a UTC string. |
| factorId |
|
string |
The type identifier of the second factor. For SMS second factors, this is phone. For TOTP second factors, this is totp. |
| uid |
|
string |
The ID of the enrolled second factor. This ID is unique to the user. |
Methods
| Method |
Modifiers |
Description |
| toJSON() |
|
Returns a JSON-serializable representation of this object. |
MultiFactorInfo.displayName
The optional display name of the enrolled second factor.
Signature:
readonly displayName?: string;
MultiFactorInfo.enrollmentTime
The optional date the second factor was enrolled, formatted as a UTC string.
Signature:
readonly enrollmentTime?: string;
MultiFactorInfo.factorId
The type identifier of the second factor. For SMS second factors, this is phone. For TOTP second factors, this is totp.
Signature:
readonly factorId: string;
MultiFactorInfo.uid
The ID of the enrolled second factor. This ID is unique to the user.
Signature:
readonly uid: string;
MultiFactorInfo.toJSON()
Returns a JSON-serializable representation of this object.
Signature:
toJSON(): object;
Returns:
object
A JSON-serializable representation of this object.
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-07-12 UTC.
[null,null,["Last updated 2023-07-12 UTC."],[],[],null,["# MultiFactorInfo class\n\nInterface representing the common properties of a user-enrolled second factor.\n\n**Signature:** \n\n export declare abstract class MultiFactorInfo \n\nProperties\n----------\n\n| Property | Modifiers | Type | Description |\n|------------------------------------------------------------------------------------------|-----------|--------|-----------------------------------------------------------------------------------------------------------------------------|\n| [displayName](./firebase-admin.auth.multifactorinfo.md#multifactorinfodisplayname) | | string | The optional display name of the enrolled second factor. |\n| [enrollmentTime](./firebase-admin.auth.multifactorinfo.md#multifactorinfoenrollmenttime) | | string | The optional date the second factor was enrolled, formatted as a UTC string. |\n| [factorId](./firebase-admin.auth.multifactorinfo.md#multifactorinfofactorid) | | string | The type identifier of the second factor. For SMS second factors, this is `phone`. For TOTP second factors, this is `totp`. |\n| [uid](./firebase-admin.auth.multifactorinfo.md#multifactorinfouid) | | string | The ID of the enrolled second factor. This ID is unique to the user. |\n\nMethods\n-------\n\n| Method | Modifiers | Description |\n|----------------------------------------------------------------------------|-----------|------------------------------------------------------------|\n| [toJSON()](./firebase-admin.auth.multifactorinfo.md#multifactorinfotojson) | | Returns a JSON-serializable representation of this object. |\n\nMultiFactorInfo.displayName\n---------------------------\n\nThe optional display name of the enrolled second factor.\n\n**Signature:** \n\n readonly displayName?: string;\n\nMultiFactorInfo.enrollmentTime\n------------------------------\n\nThe optional date the second factor was enrolled, formatted as a UTC string.\n\n**Signature:** \n\n readonly enrollmentTime?: string;\n\nMultiFactorInfo.factorId\n------------------------\n\nThe type identifier of the second factor. For SMS second factors, this is `phone`. For TOTP second factors, this is `totp`.\n\n**Signature:** \n\n readonly factorId: string;\n\nMultiFactorInfo.uid\n-------------------\n\nThe ID of the enrolled second factor. This ID is unique to the user.\n\n**Signature:** \n\n readonly uid: string;\n\nMultiFactorInfo.toJSON()\n------------------------\n\nReturns a JSON-serializable representation of this object.\n\n**Signature:** \n\n toJSON(): object;\n\n**Returns:**\n\nobject\n\nA JSON-serializable representation of this object."]]
