Skip to content
Authrim

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

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
Media type application/json
object
device_name
string
<= 100 characters
Example generated
{
  "device_name": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “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

Section titled “400 ”

Error response.

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

Stable Authrim error category that can be provided to support.

string
/^AR[0-9]{6}$/
error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

401

Section titled “401 ”

Error response.

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

Stable Authrim error category that can be provided to support.

string
/^AR[0-9]{6}$/
error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

403

Section titled “403 ”

Error response.

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

Stable Authrim error category that can be provided to support.

string
/^AR[0-9]{6}$/
error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}