Create passkey registration options

POST

/api/admin/me/passkeys/options

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/me/passkeys/options \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "rp_id": "admin.test.authrim.com", "device_name": "MacBook Pro" }'

Generate WebAuthn registration options and store a short-lived challenge for the current admin user.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Create WebAuthn registration options for the current admin.

Media type application/json

object

rp_id

required

string

device_name

string

Example

{
  "rp_id": "admin.test.authrim.com",
  "device_name": "MacBook Pro"
}

Responses

200

Passkey registration options.

Media type application/json

object

options

required

object

key

additional properties

challenge_id

required

string

Example

{
  "options": {
    "challenge": "challenge",
    "rp": {
      "id": "admin.test.authrim.com",
      "name": "Authrim Admin"
    },
    "user": {
      "id": "...",
      "name": "[email protected]",
      "displayName": "[email protected]"
    },
    "pubKeyCredParams": []
  },
  "challenge_id": "challenge_123"
}

default

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"
}