Class MfaWebAuthnRoamingEnrollment

constructor

• new MfaWebAuthnRoamingEnrollment(): MfaWebAuthnRoamingEnrollment

  Creates an instance of MfaWebAuthnRoamingEnrollment screen manager.

  Returns MfaWebAuthnRoamingEnrollment

screen

StaticscreenIdentifier

enroll

• enroll(payload: Classes.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: Classes.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();
  // Assuming you have obtained the WebAuthn credential response (e.g., from navigator.credentials.create)
  const credentialResponse = { /* ... serialized credential ... */ };
  await webauthnEnrollment.enroll({ response: JSON.stringify(credentialResponse) });
  Copy

showError

• showError(payload: Classes.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: Classes.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();
  await webauthnEnrollment.showError({
    error: {
      name: 'NotAllowedError',
      message: 'The operation either timed out or was not allowed.',
    },
  });
  Copy

tryAnotherMethod

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

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

  Parameters

  • Optionalpayload: Classes.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