Skip to content
Authrim

Start authenticated-user Direct Auth passkey registration.

POST
/api/v1/auth/direct/passkey/register/start
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/v1/auth/direct/passkey/register/start \
  --header 'Content-Type: application/json' \
  --data '{ "display_name": "MacBook Pro", "authenticator_type": "platform" }'

Creates WebAuthn registration options for adding a passkey to the current Direct Auth session user.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
client_id
string
display_name
string
authenticator_type
string
Allowed values: platform cross-platform any
resident_key
string
Allowed values: required preferred discouraged
user_verification
string
Allowed values: required preferred discouraged
Example 
{
  "display_name": "MacBook Pro",
  "authenticator_type": "platform"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
challenge_id
required
string
options
required

WebAuthn options generated by @simplewebauthn/server.

object
key
additional properties
Example 
{
  "challenge_id": "challenge_123",
  "options": {
    "challenge": "challenge",
    "rpId": "auth.example.com",
    "allowCredentials": [],
    "userVerification": "required"
  }
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}