Skip to content
Authrim

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

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Request Body required

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

Responses

Section titled “ Responses ”

200

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

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

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

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

404

Section titled “404 ”

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