Example
Properties
Screen-specific properties and data, including WebAuthn challenge options and remember device preference.
Methods
Promise<void>
Reports a specific WebAuthn API error (from
navigator.credentials.get()) to Auth0.
This method should be used when verify() (or a manual navigator.credentials.get() call) fails due to
a browser-side WebAuthn issue (e.g., user cancellation NotAllowedError, timeout).
It submits the error details with action: "showError::{errorDetailsJsonString}" and an empty response.A promise that resolves when the error report is submitted.Throws
Throws an error if the form submission fails (e.g., network error, invalid state).Example
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.A promise that resolves when the ‘pick-authenticator’ action is submitted.Throws
Throws an error if the form submission fails.Example
Promise<void>
Initiates the WebAuthn platform authenticator challenge.
This method internally calls
navigator.credentials.get() using the challenge options
provided in screen.publicKey.
If successful, it submits the resulting credential to Auth0 with action: "default".If navigator.credentials.get() fails (e.g., user cancellation, timeout, or other WebAuthn API errors),
it’s recommended to call reportBrowserError with the error details.A promise that resolves when the verification attempt is submitted.
A successful operation typically results in a redirect.Throws
Throws an error ifscreen.publicKey is missing,
if navigator.credentials.get() fails with an unexpected error not handled by getPasskeyCredentials,
or if the form submission to Auth0 fails.Example