v1

latestOpenAPI 3.0.32026-08-064799140.5 KB
Users

List passkeys for a user

Returns a list of passkeys for a user by given userID.

The list can be sorted and filtered:

  • The sort parameter supports the following fields: userID, created, status, backupState, browserName and osName.
  • The filter parameter supports the following fields: userID, created, status, backupState, browserName and osName.

Refer to the parameter description for more details on sorting in different directions and using the filter with different operators.

get/users/{userID}/credentials

Path parameters

userIDstring required
Example:usr-4693224802260150919

Unique identifier of the user. Format: usr-<number>.

Query parameters

sortstring
Example:createdAt:desc

Field and direction to sort results. Use the format fieldName:asc or fieldName:desc.

filter[]string[]

Filter results by specific fields and conditions. Format: <field>:<operator>:<value>. Supported operators include:

  • eq: equals (e.g. email:eq:mail@example\.com matches items where email equals mail@example.com)
  • gt: greater than (e.g. created:gt:2021-01-01T00:00:00 matches items created after Jan 1, 2021)
  • lt: less than (e.g. created:lt:2021-01-01T00:00:00 matches items created before Jan 1, 2021)
pageinteger
Example:1

The page number to retrieve for paginated results.

pageSizeinteger
Example:20

The number of items to return per page. Useful for pagination.

includeAllStatusboolean

Whether to include all status types (including deleted) in the response. Default is false, which excludes deleted items.

Response

List of passkeys.

Example response

{
  "credentials": [
    {
      "id": "cre-12345"
    }
  ]
}