Kong · Schema

Consumer

A Consumer represents a developer or machine using the API. Consumers are used with authentication plugins to identify and control API access.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen-Source

Properties

Name Type Description
id string The unique identifier of the Consumer.
username string The unique username of the Consumer. At least one of username or custom_id must be specified.
custom_id string A custom identifier for the Consumer. At least one of username or custom_id must be specified.
tags array An optional set of strings for grouping and filtering.
created_at integer Unix epoch timestamp of when the entity was created.
updated_at integer Unix epoch timestamp of when the entity was last updated.
View JSON Schema on GitHub

JSON Schema

kong-gateway-admin-consumer-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Consumer",
  "type": "object",
  "description": "A Consumer represents a developer or machine using the API. Consumers are used with authentication plugins to identify and control API access.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the Consumer."
    },
    "username": {
      "type": "string",
      "description": "The unique username of the Consumer. At least one of username or custom_id must be specified."
    },
    "custom_id": {
      "type": "string",
      "description": "A custom identifier for the Consumer. At least one of username or custom_id must be specified."
    },
    "tags": {
      "type": "array",
      "description": "An optional set of strings for grouping and filtering."
    },
    "created_at": {
      "type": "integer",
      "description": "Unix epoch timestamp of when the entity was created."
    },
    "updated_at": {
      "type": "integer",
      "description": "Unix epoch timestamp of when the entity was last updated."
    }
  }
}