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.
 
- 200
 - default
 
A successful response.
- application/json
 - application/grpc
 - application/grpc-web+proto
 
- Schema
 - Example (from schema)
 
Schema
key object
id stringdetails object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs totype stringPossible values: [
KEY_TYPE_UNSPECIFIED,KEY_TYPE_JSON]Default value:
KEY_TYPE_UNSPECIFIEDthe file type of the key
expirationDate date-timethe date a key will expire
{
  "key": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-12",
      "changeDate": "2023-05-12",
      "resourceOwner": "69629023906488334"
    },
    "type": "KEY_TYPE_JSON",
    "expirationDate": "3019-04-01T08:45:00.000000Z"
  }
}
- Schema
 - Example (from schema)
 
Schema
key object
id stringdetails object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs totype stringPossible values: [
KEY_TYPE_UNSPECIFIED,KEY_TYPE_JSON]Default value:
KEY_TYPE_UNSPECIFIEDthe file type of the key
expirationDate date-timethe date a key will expire
{
  "key": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-12",
      "changeDate": "2023-05-12",
      "resourceOwner": "69629023906488334"
    },
    "type": "KEY_TYPE_JSON",
    "expirationDate": "3019-04-01T08:45:00.000000Z"
  }
}
- Schema
 - Example (from schema)
 
Schema
key object
id stringdetails object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs totype stringPossible values: [
KEY_TYPE_UNSPECIFIED,KEY_TYPE_JSON]Default value:
KEY_TYPE_UNSPECIFIEDthe file type of the key
expirationDate date-timethe date a key will expire
{
  "key": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-12",
      "changeDate": "2023-05-12",
      "resourceOwner": "69629023906488334"
    },
    "type": "KEY_TYPE_JSON",
    "expirationDate": "3019-04-01T08:45:00.000000Z"
  }
}
An unexpected error response.
- application/json
 - application/grpc
 - application/grpc-web+proto
 
- Schema
 - Example (from schema)
 
Schema
- code int32
 - message string
 details object[]
Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
 - Example (from schema)
 
Schema
- code int32
 - message string
 details object[]
Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
 - Example (from schema)
 
Schema
- code int32
 - message string
 details object[]
Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}