Rename one current user's passkey.

PATCH

/api/account/passkeys/{id}

Code sample: Shell / cURL

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

Updates the display name of a passkey owned by the authenticated Account Page user.

Authorizations

• accountSessionCookie

Parameters

Path Parameters

id

required

string

Request Body ^required

Media type application/json

object

device_name

required

string

<= 100 characters

Example ^generated

{
  "device_name": "example"
}

Responses

200

Account Page passkey response.

Media type application/json

object

passkey

required

object

id

required

string

device_name

required

string | null

aaguid

required

Display-only WebAuthn authenticator AAGUID. Do not use for trust decisions.

string | null

provider

required

One of:

object

object

aaguid

required

string

name

required

string | null

icon_dark

required

Display-only data URI icon for dark backgrounds when available.

string | null

icon_light

required

Display-only data URI icon for light backgrounds when available.

string | null

known

required

boolean

null

null

created_at

required

integer

last_used_at

required

integer | null

Example ^generated

{
  "passkey": {
    "id": "example",
    "device_name": "example",
    "aaguid": "example",
    "provider": {
      "aaguid": "example",
      "name": "example",
      "icon_dark": "example",
      "icon_light": "example",
      "known": true
    },
    "created_at": 1,
    "last_used_at": 1
  }
}

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

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

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

404

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