Skip to content

users_passkeys_get

Read ONE passkey of an end user by id — the name they gave it, its transports, the authenticator model's `aaguid`, whether it is `backedUp`, its sign counter and when it was last used.

Tool

users_passkeys_get

Read ONE passkey of an end user by id — the name they gave it, its transports, the authenticator model's `aaguid`, whether it is `backedUp`, its sign counter and when it was last used.

Read ONE passkey of an end user by id — the name they gave it, its transports, the authenticator model's `aaguid`, whether it is `backedUp`, its sign counter and when it was last used. The same shape users_passkeys_list returns per row. NO KEY MATERIAL IS EVER RETURNED: the public key is deliberately absent here as it is there. A credential id that belongs to another user answers 404 exactly like one that never existed.

Behavior

HTTP
GET /users/users/:userId/passkeys/:passkeyId

Arguments

Name
Type
Required
Description
userId
string
•
The end user the credential belongs to.
passkeyId
string
•
Which credential to read — the `id` from `users_passkeys_list`.

Response

Field
Type
Always
Description
id
string
•
Id of the credential. Pass it to users_passkeys_revoke.
name
string
•
The name the user gave this credential, so a person can tell their devices apart. Null when they never named it.
aaguid
string
•
The authenticator MODEL’s identifier, which says what kind of device this is, never which one. Null when the authenticator withheld it.
backedUp
boolean
•
True when the platform syncs this credential, so it survives losing the device. False means it lives on that device alone.
createdAt
string
•
When the credential was registered (ISO 8601).
signCount
integer
•
The authenticator’s own counter as of the last assertion. 0 when the authenticator does not count.
lastUsedAt
string
•
When it last signed in (ISO 8601). Null when it never has.
transports
array
•
How this authenticator can be reached. Empty when the browser reported nothing — the vocabulary is the platform’s and grows, so it is not an enum.

Try it

Read ONE passkey of an end user by id — the name they gave it, its transports, the authenticator model's `aaguid`, whether it is `backedUp`, its sign counter and when it was last used.

When to use

Read ONE passkey of an end user by id — the name they gave it, its transports, the authenticator model's `aaguid`, whether it is `backedUp`, its sign counter and when it was last used. The same shape users_passkeys_list returns per row. NO KEY MATERIAL IS EVER RETURNED: the public key is deliberately absent here as it is there. A credential id that belongs to another user answers 404 exactly like one that never existed.

Example

Ask your agent something like this:

Read ONE passkey of an end user by id — the name they gave it, its transports, the authenticator model's `aaguid`, whether it is `backedUp`, its sign counter and when it was last used.

The agent will invoke users_passkeys_get with these arguments:

{
  "userId": "<userId>",
  "passkeyId": "<passkeyId>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select