Class MfaWebAuthnPlatformEnrollment

constructor

• new MfaWebAuthnPlatformEnrollment(): MfaWebAuthnPlatformEnrollment

  Initializes a new instance of the MfaWebAuthnPlatformEnrollment class.

  Returns MfaWebAuthnPlatformEnrollment

  Throws

  If the Universal Login Context is not available or if the screen name in the context does not match MfaWebAuthnPlatformEnrollment.screenIdentifier.

screen

StaticscreenIdentifier

refuseEnrollmentOnThisDevice

• refuseEnrollmentOnThisDevice(payload?: Classes.CustomOptions): Promise<void>

  Allows the user to refuse WebAuthn platform enrollment on the current device.

  Parameters

  • Optionalpayload: Classes.CustomOptions

    Optional custom parameters to be sent with the request.

  Returns Promise<void>

  A promise that resolves upon successful submission of the refusal action.

reportBrowserError

• reportBrowserError(payload: Classes.ReportBrowserErrorOptions): Promise<void>

  Reports a browser-side error encountered during the WebAuthn navigator.credentials.create() operation.

  Parameters

  • payload: Classes.ReportBrowserErrorOptions

    An object containing the error (with name and message properties from the browser's WebAuthn API error) and any other custom options.

  Returns Promise<void>

  A promise that resolves upon successful submission of the error report.

  Throws

  Throws an error if the form submission fails.

snoozeEnrollment

• snoozeEnrollment(payload?: Classes.CustomOptions): Promise<void>

  Allows the user to choose to snooze the WebAuthn platform enrollment.

  Parameters

  • Optionalpayload: Classes.CustomOptions

    Optional custom parameters to be sent with the request.

  Returns Promise<void>

  A promise that resolves upon successful submission of the snooze action.

submitPasskeyCredential

• submitPasskeyCredential(
      payload?: Classes.SubmitPasskeyCredentialOptions,
  ): Promise<void>

  Initiates the WebAuthn platform credential creation process using the public key options available on this.screen.publicKey and submits the resulting credential to the server. This method internally calls createPasskeyCredentials (which wraps navigator.credentials.create()).

  Parameters

  • Optionalpayload: Classes.SubmitPasskeyCredentialOptions

    Optional custom parameters to be sent to the server along with the created credential.

  Returns Promise<void>

  A promise that resolves when the credential is successfully created and submitted.

  Throws

  Throws an error if this.screen.publicKey is not available, if createPasskeyCredentials fails (e.g., user cancellation, hardware issues), or if the submission to the server fails.

  Example

  // Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment
  try {
    await sdk.submitPasskeyCredential(); // No need to pass publicKey explicitly
    // On success, Auth0 handles redirection.
  } catch (error) {
    console.error('Passkey enrollment failed:', error);
    if (error.name && error.message) { // Check if it looks like a WebAuthn error
      await sdk.reportBrowserError({ error: { name: error.name, message: error.message } });
    }
  }
  Copy