Skip to main content

List Application Keys

POST 
https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/apps/:appId/keys/_search

Search application keys. Keys are used for authorizing API Applications.

Request​

Path Parameters

    projectId stringrequired
    appId stringrequired

Header Parameters

    x-zitadel-orgid string

    The default is always the organization of the requesting user. If you like to change/get objects of another organization include the header. Make sure the requesting user has permission to access the requested data.

Body

required

    query

    object

    Object unspecific list filters like offset, limit and asc/desc.

    offset uint64
    limit int64

    Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

    asc boolean

    default is descending

Responses​

A successful response.

Schema

    details

    object

    totalResult uint64
    processedSequence uint64
    viewTimestamp date-time

    the last time the view got updated

    result

    object[]

  • Array [

    • id string

    details

    object

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

    resourceOwner resource_owner is the organization an object belongs to (string)
    type string

    Possible values: [KEY_TYPE_UNSPECIFIED, KEY_TYPE_JSON]

    Default value: KEY_TYPE_UNSPECIFIED

    the file type of the key

    expirationDate date-time

    the date a key will expire

  • ]

curl -L 'https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/apps/:appId/keys/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  }
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/management/v1
Auth
Parameters
— pathrequired
— pathrequired
— header
Body required
{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  }
}
ResponseClear

Click the Send API Request button above and see the response here!