ZITADEL Docs
APIsCore ResourcesV2Application

List Application Keys

Returns a list of application keys matching the input parameters.

The result can be sorted by id, aggregate, creation date, expiration date, resource owner or type. It can also be filtered by application, project or organization ID.

Required permissions:

  • project.app.read
POST
/zitadel.application.v2.ApplicationService/ListApplicationKeys

Header Parameters

Connect-Protocol-Version*number

Define the version of the Connect protocol

Value in1
Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

pagination?

Pagination and sorting.

sortingColumn?string

The column to sort by. If not provided, the default is 'KEY_ID'.

Value in"APPLICATION_KEYS_SORT_BY_ID" | "APPLICATION_KEYS_SORT_BY_PROJECT_ID" | "APPLICATION_KEYS_SORT_BY_APPLICATION_ID" | "APPLICATION_KEYS_SORT_BY_CREATION_DATE" | "APPLICATION_KEYS_SORT_BY_ORGANIZATION_ID" | "APPLICATION_KEYS_SORT_BY_EXPIRATION" | "APPLICATION_KEYS_SORT_BY_TYPE"
filters?array<||>

Criteria to filter the application keys. All provided filters are combined with a logical AND.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/zitadel.application.v2.ApplicationService/ListApplicationKeys" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{}'
{
  "keys": [
    {
      "keyId": "string",
      "applicationId": "string",
      "projectId": "string",
      "creationDate": "2023-01-15T01:30:15.01Z",
      "organizationId": "string",
      "expirationDate": "2023-01-15T01:30:15.01Z"
    }
  ],
  "pagination": {
    "totalResult": 0,
    "appliedLimit": 0
  }
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Was this page helpful?

Get Application Key

Get Application Key: Retrieves the application key matching the provided ID. Specifying a project, organization and application ID is optional but help with filtering/performance. Required permissions:

List Applications

List Applications: Returns a list of applications matching the input parameters. The results can be filtered by project, state, type and name. It can be sorted by id, name, creation date, change date or state. Requir...