ZITADEL Docs
APIsCore ResourcesV2User

Search Keys

List all matching keys. By default all keys of the instance on which the caller has permission to read the owning users are returned. Make sure to include a limit and sorting for pagination.

Required permission:

  • user.read
POST
/v2/users/keys/search

Request Body

application/json

pagination?|

List limitations and ordering.

sortingColumn?|

The field the result is sorted by. The default is the creation date. Beware that if you change this, your result pagination might be inconsistent.

filters?array<||||>

Define the criteria to query for.

[key: string]?never

Response Body

application/json

curl -X POST "https://loading/v2/users/keys/search" \  -H "Content-Type: application/json" \  -d '{}'
{
  "pagination": {
    "totalResult": 0,
    "appliedLimit": 0
  },
  "result": [
    {
      "creationDate": "2023-01-15T01:30:15.01Z",
      "changeDate": "2023-01-15T01:30:15.01Z",
      "id": "string",
      "userId": "string",
      "organizationId": "string",
      "expirationDate": "2023-01-15T01:30:15.01Z"
    }
  ]
}

Was this page helpful?

Retrieve the information returned by the identity provider

Retrieve the information returned by the identity provider for registration or updating an existing user with new information..

Search Personal Access Tokens

Search Personal Access Tokens: List all personal access tokens. By default all personal access tokens of the instance on which the caller has permission to read the owning users are returned. Make sure to include a limit and sor...