Kong · Schema

Consumer

The Consumer object represents a consumer - or a user - of a Service. You can either rely on Kong as the primary datastore, or you can map the consumer list with your database to keep consistency between Kong and your existing primary datastore.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
created_at integer Unix epoch when the resource was created.
custom_id string Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or `username` with the request.
id string A string representing a UUID (universally unique identifier).
tags array An optional set of strings associated with the Consumer for grouping and filtering.
updated_at integer Unix epoch when the resource was last updated.
username string The unique username of the Consumer. You must send either this field or `custom_id` with the request.
View JSON Schema on GitHub

JSON Schema

kong-consumer-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Consumer",
  "title": "Consumer",
  "x-speakeasy-entity": "Consumer",
  "description": "The Consumer object represents a consumer - or a user - of a Service. You can either rely on Kong as the primary datastore, or you can map the consumer list with your database to keep consistency between Kong and your existing primary datastore.",
  "type": "object",
  "properties": {
    "created_at": {
      "description": "Unix epoch when the resource was created.",
      "type": "integer",
      "nullable": true
    },
    "custom_id": {
      "description": "Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or `username` with the request.",
      "type": "string",
      "nullable": true
    },
    "id": {
      "description": "A string representing a UUID (universally unique identifier).",
      "type": "string",
      "nullable": true
    },
    "tags": {
      "description": "An optional set of strings associated with the Consumer 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
    },
    "username": {
      "description": "The unique username of the Consumer. You must send either this field or `custom_id` with the request.",
      "type": "string",
      "nullable": true
    }
  },
  "example": {
    "custom_id": "4200",
    "id": "8a388226-80e8-4027-a486-25e4f7db5d21",
    "tags": [
      "silver-tier"
    ],
    "username": "bob-the-builder"
  },
  "additionalProperties": false
}