Skip to content
Kapten
Esc
↑↓navigate↵open⌘Jpreview

Rename a passkey

Renames one of the caller’s passkeys.

PATCH/passkeys/{passkeyId}
Authorization
AuthorizationBearer token (JWT) · headerrequired

An access token issued by this service (RFC 9068), in the Authorization header as Bearer <token>.

Path parameters
passkeyIdstring<uuid>required
Request body
requiredapplication/json
namestringrequired

1 to 64 characters, trimmed.

Responses
200

The renamed passkey.

idstring<uuid>required
namestringrequired

Defaults to the provider's name, or "Passkey" when it is unknown.

providerstring

The passkey provider (password manager, platform or security key), known from its AAGUID; absent when the provider does not say.

syncedbooleanrequired

The passkey can sync across the provider's devices (backup eligible). Otherwise it is bound to one device or security key.

backed_upbooleanrequired

The passkey was synced when it was last used (backup state).

transportsstring[]required

How the browser reaches the authenticator (internal, hybrid, usb, nfc, ble).

created_atstring<date-time>required
last_used_atstring<date-time>

Absent until the passkey first signs in.

default

The request failed.

errorstringrequired

Stable machine-readable code.

Allowed:invalid_requestunauthorizedforbiddennot_foundconflictgoneunavailableinternal
messagestringrequired

Human-readable explanation.

Request
curl -X PATCH 'https://auth.kapten.io/passkeys/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string"
}'
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "provider": "string",
  "synced": true,
  "backed_up": true,
  "transports": [
    "string"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "last_used_at": "2019-08-24T14:15:22Z"
}

Was this page helpful?