Jump to top
Edit Page

MultiFactorUser

interface

The entry point for most multi-factor operations.

Properties

enrolledFactors

</>

Returns the user's enrolled factors.

enrolledFactors: MultiFactorInfo[];

Methods

enroll

</>

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.

enroll(assertion: MultiFactorAssertion, displayName?: undefined | string): Promise<void>;

getSession

</>

Return the session for this user.

getSession(): Promise<MultiFactorSession>;