Skip to content

Begin passkey sign-in

POST
/api/v1/account/passkeys/login/begin
curl --request POST \
--url http://127.0.0.1:8080/api/v1/account/passkeys/login/begin \
--header 'Origin: example'

Usernameless: the authenticator supplies the account. 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.

Origin
required
string

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
Examplegenerated
{
"publicKey": {}
}

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
Examplegenerated
{
"code": "example",
"detail": "example",
"status": 1,
"title": "example",
"type": "example"
}

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
Examplegenerated
{
"code": "example",
"detail": "example",
"status": 1,
"title": "example",
"type": "example"
}