Start registering a passkey for an end user (headless)
POST /v1/users/{user}/passkeys/registration_options: Start registering a passkey for an end user (headless).
POST /
For native and server-driven apps. Returns WebAuthn creation options bound to the hosted sign-in relying party (RP ID signin.<domain>). The ceremony is accepted from the sign-in origin and from the environment’s native_app_origins (WebAuthn Level 3 §5.8.1: android:apk-key-hash origins; iOS apps listed as ios:<team>.<bundle> are served in the sign-in host’s webcredentials association and convey the sign-in origin). Expires in 5 minutes.
- Scope
users:write- Auth
- Secret key (
sk_…) - Since
- 1.0
Path parameters
Section titled “Path parameters”userstring Required
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Responses
Section titled “Responses”- 200 OK WebAuthnOptions
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 404 Code: resource_not_found (also returned for other tenants’ IDs); a path no endpoint serves answers route_not_found. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
Errors share one shape; see the error code catalogue.
curl -X POST \ "https://api.ohauthcat.com/v1/users/usr_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/passkeys/registration_options" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY"const response = await fetch("https://api.ohauthcat.com/v1/users/usr_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/passkeys/registration_options", { method: "POST", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, },});const data = await response.json();import osimport requests
response = requests.post( "https://api.ohauthcat.com/v1/users/usr_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/passkeys/registration_options", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},)data = response.json(){ "public_key": {}}