@auth0/auth0-acul-js - v1.10.0
    Preparing search index...

    Interface MfaWebAuthnErrorMembers

    MfaWebAuthnErrorMembers

    interface MfaWebAuthnErrorMembers {
        branding: Screens.BrandingMembers;
        client: Screens.ClientMembers;
        countryCodes?: Screens.CountryCodesMembers;
        experiment?: Screens.ExperimentMembers | null;
        organization: Screens.OrganizationMembers;
        prompt: Screens.PromptMembers;
        screen: Screens.ScreenMembersOnMfaWebAuthnError;
        tenant: Screens.TenantMembers;
        transaction: Screens.TransactionMembers;
        untrustedData: Screens.UntrustedDataMembers;
        user: Screens.UserMembers;
        changeLanguage(options: Screens.LanguageChangeOptions): Promise<void>;
        getErrors(): Screens.Error[];
        noThanks(payload?: Screens.CustomOptions): Promise<void>;
        tryAgain(payload?: Screens.CustomOptions): Promise<void>;
        tryAnotherMethod(payload?: Screens.CustomOptions): Promise<void>;
        usePassword(payload?: Screens.CustomOptions): Promise<void>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

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

    Methods

    changeLanguage getErrors noThanks tryAgain tryAnotherMethod usePassword

    Properties

    branding: Screens.BrandingMembers
    client: Screens.ClientMembers
    countryCodes?: Screens.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?: Screens.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: Screens.OrganizationMembers
    prompt: Screens.PromptMembers
    screen: Screens.ScreenMembersOnMfaWebAuthnError

    The screen object with MFA WebAuthn Error specific data structure.

    tenant: Screens.TenantMembers
    transaction: Screens.TransactionMembers
    untrustedData: Screens.UntrustedDataMembers
    user: Screens.UserMembers

    Methods

    • Allows the user to refuse adding a device or completing the WebAuthn step, effectively declining the current WebAuthn flow. This action is typically used in enrollment scenarios where the user decides not to proceed.

      Parameters

      Returns Promise<void>

      A promise that resolves when the action is successfully submitted.

      Throws an error if the submission fails.

      // Assuming 'sdk' is an instance of MfaWebAuthnError
      await sdk.noThanks();

    • Allows the user to attempt the previous WebAuthn operation again. This typically redirects the user back to the screen where the WebAuthn operation was initiated.

      Parameters

      Returns Promise<void>

      A promise that resolves when the action is successfully submitted.

      Throws an error if the submission fails.

      // Assuming 'sdk' is an instance of MfaWebAuthnError
      await sdk.tryAgain();

    • Allows the user to select a different MFA method if other factors are enrolled or available. This navigates the user to an authenticator selection screen.

      Parameters

      Returns Promise<void>

      A promise that resolves when the action is successfully submitted.

      Throws an error if the submission fails.

      // Assuming 'sdk' is an instance of MfaWebAuthnError
      await sdk.tryAnotherMethod();

    • Allows the user to opt for password-based authentication as an alternative, if configured. This is typically available if the primary authentication or a previous step involved a password.

      Parameters

      Returns Promise<void>

      A promise that resolves when the action is successfully submitted.

      Throws an error if the submission fails.

      // Assuming 'sdk' is an instance of MfaWebAuthnError
      await sdk.usePassword();

    Settings

    Member Visibility

    On This Page

    Properties
    Methods