Interface ResetPasswordMfaWebAuthnPlatformChallengeMembers

screen

continueWithPasskey

• continueWithPasskey(
      options?: ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions,
  ): Promise<void>

  Initiates the WebAuthn platform authenticator challenge by calling navigator.credentials.get() using the challenge options provided in screen.publicKey. If successful, it submits the resulting credential assertion to Auth0 with action: "default".

  Parameters

  • Optionaloptions: ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions

    Optional parameters for the verification process, such as rememberDevice (if screen.showRememberDevice is true) and other custom options.

  Returns Promise<void>

  A promise that resolves when the verification attempt is submitted. A successful operation typically results in a redirect.

  Throws

  Throws an error if screen.publicKey is missing, if navigator.credentials.get() fails (e.g., user cancellation NotAllowedError), or if the form submission to Auth0 fails. If navigator.credentials.get() fails with a DOMException, it's recommended to catch that error and call reportBrowserError.

  Example

  // Assuming 'sdk' is an instance of ResetPasswordMfaWebAuthnPlatformChallenge
  try {
    await sdk.continueWithPasskey({
      rememberDevice: true // if user checked the box and sdk.screen.showRememberDevice is true
    });
    // On success, Auth0 handles redirection.
  } catch (error) {
    console.error("Platform authenticator verification failed:", error);
    // If it's a WebAuthn API error (DOMException), report it
    if (error instanceof DOMException && error.name && error.message) {
      await sdk.reportBrowserError({ error: { name: error.name, message: error.message } });
    }
    // Check sdk.transaction.errors for server-side validation messages if the page reloads.
  }
  Copy

reportBrowserError

• reportBrowserError(
      options: ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions,
  ): Promise<void>

  Reports a browser-side error that occurred during the navigator.credentials.get() API call. This is used to inform Auth0 about issues like user cancellation, timeout, or unsupported hardware. It submits the error details with action: "showError::{errorDetailsJsonString}".

  Parameters

  • options: ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions

    Contains the error object (with name and message from the WebAuthn API DOMException) and any custom options.

  Returns Promise<void>

  A promise that resolves when the error report is submitted.

  Throws

  If the form submission fails (e.g., network error).

  Example

  // Assuming 'sdk' is an instance of ResetPasswordMfaWebAuthnPlatformChallenge
  // and 'webAuthnError' is a DOMException from a failed navigator.credentials.get() call.
  try {
    await sdk.reportBrowserError({
      error: { name: webAuthnError.name, message: webAuthnError.message }
    });
    // Auth0 may re-render the page or redirect based on the error.
  } catch (submitError) {
    console.error("Failed to report WebAuthn browser error:", submitError);
  }
  Copy

tryAnotherMethod

• tryAnotherMethod(
      options?: ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions,
  ): Promise<void>

  Allows the user to opt-out of the WebAuthn platform challenge and select a different MFA method. This action submits action: "pick-authenticator" to Auth0, which should navigate the user to an MFA factor selection screen for the password reset flow.

  Parameters

  • Optionaloptions: ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions

    Optional. Any custom parameters to be sent with the request.

  Returns Promise<void>

  A promise that resolves when the 'pick-authenticator' action is submitted.

  Throws

  If the form submission fails.

  Example

  // Assuming 'sdk' is an instance of ResetPasswordMfaWebAuthnPlatformChallenge
  try {
    await sdk.tryAnotherMethod();
    // On success, Auth0 handles redirection to MFA selection.
  } catch (error) {
    console.error("Failed to switch MFA method:", error);
  }
  Copy