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

    Interface MfaWebAuthnErrorMembers

    MfaWebAuthnErrorMembers

    interface MfaWebAuthnErrorMembers {
        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: ScreenMembersOnMfaWebAuthnError;
        tryAgain(payload?: CustomOptions): Promise<void>;
        usePassword(payload?: CustomOptions): Promise<void>;
        tryAnotherMethod(payload?: CustomOptions): Promise<void>;
        noThanks(payload?: CustomOptions): Promise<void>;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Methods

    getErrors changeLanguage tryAgain usePassword tryAnotherMethod noThanks

    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: ScreenMembersOnMfaWebAuthnError

    The screen object with MFA WebAuthn Error specific data structure.

    Methods

    • Returns Error[]

    • 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

      • Optionalpayload: CustomOptions

        Optional custom options to include with the request.

      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 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

      • Optionalpayload: CustomOptions

        Optional custom options to include with the request.

      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();

    • 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

      • Optionalpayload: CustomOptions

        Optional custom options to include with the request.

      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 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

      • Optionalpayload: CustomOptions

        Optional custom options to include with the request.

      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();

    Settings

    Member Visibility

    On This Page

    Properties
    Methods