Interface MfaWebAuthnRoamingEnrollmentMembers

screen

enroll

• enroll(payload: CustomOptions): Promise<void>

  Initiates the WebAuthn credential creation and submits the result to the server. This corresponds to the user interacting with the FIDO Security Keys prompt.

  Parameters

  • payload: CustomOptions

    Optional custom options to include with the request.

  Returns Promise<void>

  Example

  import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment';
  
  const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment();
  try {
    // This will trigger the browser's WebAuthn prompt
    const credential = await navigator.credentials.create({ publicKey: webauthnEnrollment.screen.data.passkey.public_key });
    // You would typically serialize the credential response here
    const response = JSON.stringify(credential);
    await webauthnEnrollment.enroll({ response });
  } catch (error) {
    console.error('WebAuthn enrollment failed:', error);
    // Handle the error, e.g., show an error message to the user or submit the error details
    // await webauthnEnrollment.showError({ error: { name: error.name, message: error.message } });
  }
  Copy

showError

• showError(payload: ShowErrorOptions): Promise<void>

  Submits details about a WebAuthn browser error to the server. This is used when the browser's WebAuthn API encounters an error.

  Parameters

  • payload: ShowErrorOptions

    The options containing the error details.

  Returns Promise<void>

  Example

  import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment';
  
  const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment();
  // Example error handler for the browser's WebAuthn API call
  const handleError = async (error: any) => {
    console.error('WebAuthn error:', error);
    await webauthnEnrollment.showError({
      error: {
        name: error.name,
        message: error.message,
        // Include other relevant error properties if available
      },
    });
  };
  // ... use handleError in your WebAuthn API call's catch block
  Copy

tryAnotherMethod

• tryAnotherMethod(
      payload?: MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions,
  ): Promise<void>

  Allows the user to try another MFA method. This corresponds to the "Try Another Method" button.

  Parameters

  • Optionalpayload: MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions

    Optional custom options to include with the request.

  Returns Promise<void>

  Example

  import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment';
  
  const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment();
  await webauthnEnrollment.tryAnotherMethod();
  Copy