Skip to main content

Get Application Key By ID​

Returns an application key. Keys are used for authorizing API Applications.

Path Parameters
    projectId string required
    appId string required
    keyId string required
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.

Responses

A successful response.

Schema
    key object
    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
    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

GET /projects/:projectId/apps/:appId/keys/:keyId

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL
https://$CUSTOM-DOMAIN/management/v1
Bearer Token
projectId — path required
appId — path required
keyId — path required
x-zitadel-orgid — header
Accept
curl / cURL
curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/apps/:appId/keys/:keyId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'