@auth0/auth0-acul-react - v1.9.0
    Preparing search index...

    Interface MfaLoginOptionsMembers

    Interface defining the available methods and properties for the mfa-login-options screen

    interface MfaLoginOptionsMembers {
        branding: BrandingMembers;
        client: ClientMembers;
        countryCodes?: CountryCodesMembers;
        experiment?: ExperimentMembers | null;
        organization: OrganizationMembers;
        prompt: PromptMembers;
        tenant: TenantMembers;
        transaction: TransactionMembers;
        user: UserMembers;
        untrustedData: UntrustedDataMembers;
        getErrors(): Error[];
        changeLanguage(options: LanguageChangeOptions): Promise<void>;
        screen: ScreenMembersOnMfaLoginOptions;
        enroll(payload: LoginEnrollOptions): Promise<void>;
        returnToPrevious(payload?: CustomOptions): Promise<void>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    branding client countryCodes? experiment? organization prompt tenant transaction user untrustedData screen

    Methods

    getErrors changeLanguage enroll returnToPrevious

    Properties

    branding: BrandingMembers
    client: ClientMembers
    countryCodes?: CountryCodesMembers

    Optional on the interface so existing implementors of BaseMembers (e.g. test mocks) keep compiling. Always populated at runtime by the BaseContext constructor.

    experiment?: ExperimentMembers | null

    The active Experiment Center experiment for the current screen, or null when none is active (or the screen has not opted in via context_configuration).

    Optional on the interface so existing implementors of BaseMembers (e.g. test mocks) keep compiling. Always populated at runtime by the BaseContext constructor.

    organization: OrganizationMembers
    prompt: PromptMembers
    tenant: TenantMembers
    transaction: TransactionMembers
    user: UserMembers
    untrustedData: UntrustedDataMembers
    screen: ScreenMembersOnMfaLoginOptions

    Methods

    • Returns Error[]

    • Continues the login process with the selected MFA factor

      Parameters

      Returns Promise<void>

      const mfaLoginOptions = new MfaLoginOptions();
      await mfaLoginOptions.enroll({
        action: 'push-notification'
      });

    • Returns to the previous screen in the authentication flow

      Parameters

      Returns Promise<void>

      const mfaLoginOptions = new MfaLoginOptions();
      await mfaLoginOptions.returnToPrevious();

    Settings

    Member Visibility

    On This Page

    Properties
    Methods