Skip to main content
GET
/
users
/
{userID}
/
credentials
List passkeys for a user
curl --request GET \
  --url https://backendapi.corbado.io/v2/users/{userID}/credentials \
  --header 'Authorization: Basic <encoded-value>'
{
  "credentials": [
    {
      "id": "cre-12345",
      "credentialID": "<string>",
      "attestationType": "<string>",
      "transport": [
        "usb"
      ],
      "backupEligible": true,
      "backupState": true,
      "authenticatorAAGUID": "<string>",
      "sourceOS": "<string>",
      "sourceBrowser": "<string>",
      "lastUsed": "<string>",
      "lastUsedMs": 123,
      "created": "<string>",
      "createdMs": 123,
      "status": "pending",
      "aaguidDetails": {
        "aaguid": "<string>",
        "name": "<string>",
        "iconLight": "<string>",
        "iconDark": "<string>"
      },
      "tags": [
        "<string>"
      ]
    }
  ],
  "paging": {
    "page": 1,
    "totalPages": 123,
    "totalItems": 123
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication is used to authenticate requests to the Backend API. The username is the project ID and the password is the API secret.

The project ID and API secret can be found in the Developer Panel.

Path Parameters

​
userID
string
required

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

Example:

"usr-4693224802260150919"

Query Parameters

​
sort
string

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

Example:

"createdAt: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 [email protected])
  • 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)
​
page
integer
default:1

The page number to retrieve for paginated results.

Example:

1

​
pageSize
integer
default:10

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

Example:

20

​
includeAllStatus
boolean
default:false

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

Response

List of passkeys.

​
credentials
object[]
required
​
paging
object
required