Stytch · Schema

api_webauthn_v1_RegisterStartRequest

Request type

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name	Type	Description
user_id	string	The `user_id` of an active user the Passkey or WebAuthn registration should be tied to. You may use an `external_id` here if one is set for the user.
domain	string	The domain for Passkeys or WebAuthn. Defaults to `window.location.hostname`.
user_agent	string	The user agent of the client.
authenticator_type	string	The requested authenticator type of the Passkey or WebAuthn device. The two valid values are platform and cross-platform. If no value passed, we assume both values are allowed.
return_passkey_credential_options	boolean	If true, the `public_key_credential_creation_options` returned will be optimized for Passkeys with `residentKey` set to `"required"` and `userVerification` set to `"preferred"`.
override_id	string
override_name	string
override_display_name	string
use_base64_url_encoding	boolean	If true, values in the `public_key_credential_creation_options` will be base64 URL encoded. Set this option to true when using built-in browser methods like `navigator.credentials.create` and `navigat

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_webauthn_v1_RegisterStartRequest",
  "title": "api_webauthn_v1_RegisterStartRequest",
  "type": "object",
  "properties": {
    "user_id": {
      "type": "string",
      "description": "The `user_id` of an active user the Passkey or WebAuthn registration should be tied to. You may use an `external_id` here if one is set for the user."
    },
    "domain": {
      "type": "string",
      "description": "The domain for Passkeys or WebAuthn. Defaults to `window.location.hostname`."
    },
    "user_agent": {
      "type": "string",
      "description": "The user agent of the client."
    },
    "authenticator_type": {
      "type": "string",
      "description": "The requested authenticator type of the Passkey or WebAuthn device. The two valid values are platform and cross-platform. If no value passed, we assume both values are allowed."
    },
    "return_passkey_credential_options": {
      "type": "boolean",
      "description": "If true, the `public_key_credential_creation_options` returned will be optimized for Passkeys with `residentKey` set to `\"required\"` and `userVerification` set to `\"preferred\"`.\n      "
    },
    "override_id": {
      "type": "string"
    },
    "override_name": {
      "type": "string"
    },
    "override_display_name": {
      "type": "string"
    },
    "use_base64_url_encoding": {
      "type": "boolean",
      "description": "If true, values in the `public_key_credential_creation_options` will be base64 URL encoded. Set this option to true when using built-in browser methods like `navigator.credentials.create` and `navigator.credentials.get`."
    }
  },
  "description": "Request type",
  "required": [
    "user_id",
    "domain"
  ]
}