Interface MultiFactorUser

The entry point for most multi-factor operations.

interface MultiFactorUser {
    enrolledFactors: MultiFactorInfo[];
    enroll(
        assertion: MultiFactorAssertion,
        displayName?: string,
    ): Promise<void>;
    getSession(): Promise<MultiFactorSession>;
    unenroll(option: string | MultiFactorInfo): Promise<void>;
}

Index

Methods

enroll getSession unenroll

Properties

enrolledFactors

Methods

enroll

enroll(assertion: MultiFactorAssertion, displayName?: string): Promise<void>
Enroll an additional factor. Provide an optional display name that can be shown to the user. The method will ensure the user state is reloaded after successfully enrolling a factor.
Parameters
- assertion: MultiFactorAssertion
- OptionaldisplayName: string
Returns Promise<void>
- Defined in auth/lib/index.d.ts:671

getSession

getSession(): Promise<MultiFactorSession>
Return the session for this user.

Returns Promise<MultiFactorSession>
- Defined in auth/lib/index.d.ts:665

unenroll

unenroll(option: string | MultiFactorInfo): Promise<void>
Unenroll a previously enrolled multi-factor authentication factor.
Parameters
- option: string | MultiFactorInfo
  The multi-factor option to unenroll.
Returns Promise<void>
- Defined in auth/lib/index.d.ts:677

Properties

enrolledFactors

enrolledFactors: MultiFactorInfo[]

Returns the user's enrolled factors.