Kong · Schema

KeyWithoutParents

A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
created_at	integer	Unix epoch when the resource was created.
id	string	A string representing a UUID (universally unique identifier).
jwk	string	A JSON Web Key represented as a string.
kid	string	A unique identifier for a key.
name	string	The name to associate with the given keys.
pem	object	A keypair in PEM format.
set	object	The id (an UUID) of the key-set with which to associate the key.
tags	array	An optional set of strings associated with the Key for grouping and filtering.
updated_at	integer	Unix epoch when the resource was last updated.
x5t	string	X.509 certificate SHA-1 thumbprint.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/KeyWithoutParents",
  "title": "KeyWithoutParents",
  "description": "A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.",
  "type": "object",
  "properties": {
    "created_at": {
      "description": "Unix epoch when the resource was created.",
      "type": "integer",
      "nullable": true
    },
    "id": {
      "description": "A string representing a UUID (universally unique identifier).",
      "type": "string",
      "nullable": true
    },
    "jwk": {
      "description": "A JSON Web Key represented as a string.",
      "type": "string",
      "nullable": true,
      "x-encrypted": true,
      "x-referenceable": true
    },
    "kid": {
      "description": "A unique identifier for a key.",
      "type": "string"
    },
    "name": {
      "description": "The name to associate with the given keys.",
      "type": "string",
      "nullable": true
    },
    "pem": {
      "description": "A keypair in PEM format.",
      "type": "object",
      "nullable": true,
      "properties": {
        "private_key": {
          "type": "string",
          "x-encrypted": true,
          "x-referenceable": true
        },
        "public_key": {
          "type": "string",
          "x-referenceable": true
        }
      }
    },
    "set": {
      "description": "The id (an UUID) of the key-set with which to associate the key.",
      "type": "object",
      "nullable": true,
      "properties": {
        "id": {
          "type": "string"
        }
      },
      "x-foreign": true
    },
    "tags": {
      "description": "An optional set of strings associated with the Key for grouping and filtering.",
      "type": "array",
      "items": {
        "description": "A string representing a tag.",
        "type": "string"
      },
      "nullable": true
    },
    "updated_at": {
      "description": "Unix epoch when the resource was last updated.",
      "type": "integer",
      "nullable": true
    },
    "x5t": {
      "description": "X.509 certificate SHA-1 thumbprint.",
      "type": "string",
      "nullable": true
    }
  },
  "example": {
    "id": "d958f66b-8e99-44d2-b0b4-edd5bbf24658",
    "jwk": "{\"alg\":\"RSA\",  \"kid\": \"42\",  ...}",
    "kid": "42",
    "name": "a-key",
    "pem": {
      "private_key": "-----BEGIN",
      "public_key": "-----BEGIN"
    },
    "set": {
      "id": "b86b331c-dcd0-4b3e-97ce-47c5a9543031"
    }
  },
  "additionalProperties": false,
  "required": [
    "kid"
  ]
}