Skip to main content
The MfaWebAuthnPlatformChallenge screen class provides methods associated with the mfa-webauthn-platform-challenge screen.
MfaWebAuthnPlatformChallenge

​
Constructors

Create an instance of MfaWebAuthnPlatformChallenge screen
Example
import MfaWebAuthnPlatformChallenge from "@auth0/auth0-acul-js/mfa-webauthn-platform-challenge";

const mfaWebAuthnPlatformChallengeManager = new MfaWebAuthnPlatformChallenge();

​
Properties

​
branding
Provides branding-related configurations, such as branding theme and settings.
​
client
Provides client-related configurations, such as id, name, and logoUrl.
​
organization
Provides information about the user’s organization, such as organization id and name.
​
prompt
Contains data about the current prompt in the authentication flow.
​
screen
Contains details specific to the mfa-webauthn-platform-challenge screen, including its configuration and context.
​
tenant
Contains data related to the tenant, such as id and associated metadata.
​
transaction
Provides transaction-specific data, such as active identifiers and flow states.
​
untrustedData
Handles untrusted data passed to the SDK, such as user input during login.
​
user
Details of the active user, including username, email, and roles.

​
Methods

​
getErrors
This method retrieves the array of transaction errors from the context, or an empty array if none exist.
​
reportBrowserError
(options ?)
This method 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. Returns a promise that resolves when the error report is successfully submitted.
Example
import MfaWebAuthnPlatformChallenge from "@auth0/auth0-acul-js/mfa-webauthn-platform-challenge";
const sdk = new MfaWebAuthnPlatformChallenge();

await sdk.reportBrowserError( {
  error: 'message'
});
​
options
OPTIONAL
Contains the error object (with name and message properties from the browser’s WebAuthn API DOMException) and any other custom options.
​
tryAnotherMethod
(options ?)
This method 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. Returns a promise that resolves when the ‘pick-authenticator’ action is submitted.
Example
import MfaWebAuthnPlatformChallenge from "@auth0/auth0-acul-js/mfa-webauthn-platform-challenge";
const sdk = new MfaWebAuthnPlatformChallenge();

await sdk.tryAnotherMethod();
​
options
OPTIONAL
Optional custom parameters to be sent with the request.
​
verify
(options ?)
This method initiates the WebAuthn platform authenticator challenge. Returns a promise that resolves when the credential submission is initiated.
Example
import MfaWebAuthnPlatformChallenge from "@auth0/auth0-acul-js/mfa-webauthn-platform-challenge";
const sdk = new MfaWebAuthnPlatformChallenge();

await sdk.verify();
​
options
OPTIONAL
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.