Rename a passkey

PATCH

/api/v1/auth/passkeys/{id}

curl --request PATCH \
  --url https://example.com/api/v1/auth/passkeys/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example" }'

Renames a passkey. It requires a signed-in User with the account scope. It can return 401 if the session is missing or expired, 403 if access is denied and 429 if the request limit is reached. Route: /api/v1/auth/passkeys/{id}. Inputs: id. Do not automatically replay this operation after an uncertain result.

Authorizations

• installationBearer
• browserSession

Parameters

Path Parameters

id

required

string

URL-safe base64 credential id from GET /auth/passkeys

Request Body^required

Media typeapplication/json

object

name

required

string

Example^generated

{
  "name": "example"
}

Responses

200

Media typeapplication/json

object

created_at

required

integer format: int64

id

required

string

last_used_at

integer | null format: int64

name

required

string

Example^generated

{
  "created_at": 1,
  "id": "example",
  "last_used_at": 1,
  "name": "example"
}

429

Too many requests

Media typeapplication/json

object

code

required

string

message

required

string

Example^generated

{
  "code": "example",
  "message": "example"
}