Skip to main content
ShowErrorOptions
Example
export interface ShowErrorOptions {
  /**
   * The error object captured from a failed `navigator.credentials.get()` call.
   * This should include at least `name` and `message` properties of the DOMException.
   * @type {WebAuthnErrorDetails}
   * @example { name: "NotAllowedError", message: "The operation was aborted by the user." }
   */
  error: WebAuthnErrorDetails;

  /**
   * Optional. If `true`, and if the screen context (`screen.showRememberDevice`)
   * indicates that remembering the device is an option, this signals the user's
   * intent to remember this browser/device.
   * @type {boolean | undefined}
   */
  rememberDevice?: boolean;
}

Properties

error
The error object from the WebAuthn API (navigator.credentials.get()) containing name and message of the DOMException.
rememberDevice?
boolean
Optional. If true and screen.showRememberDevice is also true, the SDK will include rememberBrowser=true in the form submission.