Create passkey registration options.

POST

/api/account/passkeys/options

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/account/passkeys/options \
  --header 'Content-Type: application/json' \
  --cookie authrim_session=<authrim_session> \
  --data '{ "device_name": "example" }'

Starts a WebAuthn passkey registration ceremony for the authenticated Account Page user. Recent authentication and a valid browser Origin are required.

Authorizations

• accountSessionCookie

Request Body

Media type application/json

object

device_name

string

<= 100 characters

Example ^generated

{
  "device_name": "example"
}

Responses

200

Account Page passkey registration options response.

Media type application/json

object

options

required

object

key

additional properties

challenge_id

required

string

Example ^generated

{
  "options": {
    "additionalProperty": "example"
  },
  "challenge_id": "example"
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}