Class MfaWebAuthnPlatformChallenge

constructor

• new MfaWebAuthnPlatformChallenge(): MfaWebAuthnPlatformChallenge

  Initializes a new instance of the MfaWebAuthnPlatformChallenge class. It retrieves the necessary context (screen, transaction, etc.) from the global universal_login_context.

  Returns MfaWebAuthnPlatformChallenge

  Throws

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

screen

StaticscreenIdentifier

reportBrowserError

• reportBrowserError(
      options: Classes.MfaWebAuthnPlatformChallengeReportErrorOptions,
  ): Promise<void>

  Reports a browser-side error encountered during the WebAuthn navigator.credentials.get() operation. This method should be called when verify() fails due to a WebAuthn API error (e.g., user cancellation). It sends the error details to the server with a specific action format.

  Parameters

  • options: Classes.MfaWebAuthnPlatformChallengeReportErrorOptions

    Contains the error object (with name and message properties from the browser's WebAuthn API DOMException) and any other custom options. The error object will be JSON stringified and embedded in the action parameter.

  Returns Promise<void>

  A promise that resolves when the error report is successfully submitted.

  Throws

  Throws an error if the form submission fails (e.g., network issue, invalid state).

tryAnotherMethod

• tryAnotherMethod(
      options?: Classes.MfaWebAuthnPlatformChallengeTryAnotherMethodOptions,
  ): 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.

  Parameters

  • Optionaloptions: Classes.MfaWebAuthnPlatformChallengeTryAnotherMethodOptions

    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

  Throws an error if the form submission fails (e.g., network error, invalid state).

verify

• verify(options?: Classes.VerifyPlatformAuthenticatorOptions): Promise<void>

  Initiates the WebAuthn platform authenticator challenge. Internally, this method retrieves the challenge options from this.screen.publicKey, calls navigator.credentials.get() (via the getPasskeyCredentials utility), and then submits the resulting credential assertion to the Auth0 server.

  Parameters

  • Optionaloptions: Classes.VerifyPlatformAuthenticatorOptions

    Optional parameters for the verification. This can include rememberDevice if this.screen.showRememberDevice is true, and any other custom key-value pairs to be sent in the form submission.

  Returns Promise<void>

  A promise that resolves when the credential submission is initiated. A successful operation typically results in a server-side redirect.

  Throws

  Throws an error if this.screen.publicKey is not available (indicating missing challenge options), if getPasskeyCredentials (and thus navigator.credentials.get()) fails (e.g., user cancellation, no authenticator found, hardware error), or if the final form submission to Auth0 fails. It's crucial to catch errors from this method. WebAuthn API errors (like NotAllowedError) should ideally be reported using this.reportBrowserError().