Begin passkey registration

POST

/api/v1/account/passkeys/register/begin

curl --request POST \
  --url http://127.0.0.1:8080/api/v1/account/passkeys/register/begin \
  --header 'Authorization: Bearer <token>' \
  --header 'X-CSRF-Token: example'

• A local instance on its default listener.

Requests a discoverable, user-verified credential. Requires recent authentication. Browser session authentication and CSRF apply to protected mutations. Recent authentication means a session created within five minutes. WebAuthn challenges are one-use, browser-bound and expire after five minutes. Public sign-in requires the configured Origin header. Responses must not be cached.

Authorizations

• bearerToken
• browserSession

Parameters

Header Parameters

X-CSRF-Token

required

string

Responses

200

Completed.

Media typeapplication/json

object

publicKey

required

WebAuthn PublicKeyCredentialCreationOptions or PublicKeyCredentialRequestOptions, as the browser API takes them.

object

key

additional properties

any

key

additional properties

any

Example^generated

{
  "publicKey": {}
}

401

No valid session or API token (authentication-required), or the credential sent is invalid (invalid-credentials).

Media typeapplication/problem+json

object

code

required

string

detail

required

string

status

required

integer format: int64

title

required

string

type

required

string

key

additional properties

any

Example^generated

{
  "code": "example",
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

default

Authentication, policy, rate, or protocol validation failure.

Media typeapplication/problem+json

object

code

required

string

detail

required

string

status

required

integer format: int64

title

required

string

type

required

string

key

additional properties

any

Example^generated

{
  "code": "example",
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}