Back to Firebase Js Sdk

MultiFactorInfo interface

docs-devsite/auth.multifactorinfo.md

12.12.11.8 KB
Original Source

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

MultiFactorInfo interface

A structure containing the information of a second factor entity.

<b>Signature:</b>

typescript
export interface MultiFactorInfo 

Properties

PropertyTypeDescription
displayNamestring | nullThe user friendly name of the current second factor.
enrollmentTimestringThe enrollment date of the second factor formatted as a UTC string.
factorId(typeof FactorIdMap<!-- -->)[keyof typeof FactorIdMap<!-- -->]The identifier of the second factor.
uidstringThe multi-factor enrollment ID.

MultiFactorInfo.displayName

The user friendly name of the current second factor.

<b>Signature:</b>

typescript
readonly displayName?: string | null;

MultiFactorInfo.enrollmentTime

The enrollment date of the second factor formatted as a UTC string.

<b>Signature:</b>

typescript
readonly enrollmentTime: string;

MultiFactorInfo.factorId

The identifier of the second factor.

<b>Signature:</b>

typescript
readonly factorId: (typeof FactorIdMap)[keyof typeof FactorIdMap];

MultiFactorInfo.uid

The multi-factor enrollment ID.

<b>Signature:</b>

typescript
readonly uid: string;