list_consumers

Retrieve and manage a list of consumers associated with a specific control plane in Kong Konnect, including details like consumer IDs, usernames, and custom IDs, with pagination support for efficient data handling.

Instructions

List all consumers associated with a control plane.

INPUT:

controlPlaneId: String - ID of the control plane
size: Number - Number of consumers to return (1-1000, default: 100)
offset: String (optional) - Pagination offset token from previous response

OUTPUT:

metadata: Object - Contains controlPlaneId, size, offset, nextOffset, totalCount
consumers: Array - List of consumers with details for each including:
- consumerId: String - Unique identifier for the consumer
- username: String - Username for this consumer
- customId: String - Custom identifier for this consumer
- tags: Array - Tags associated with the consumer
- enabled: Boolean - Whether the consumer is enabled
- metadata: Object - Creation and update timestamps
relatedTools: Array - List of related tools for consumer analysis

Input Schema

Name	Required	Description
`controlPlaneId`	Yes	Control Plane ID (obtainable from list-control-planes tool)
`offset`	No	Offset token for pagination (from previous response)
`size`	No	Number of consumers to return

Input Schema (JSON Schema)

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "controlPlaneId": {
      "description": "Control Plane ID (obtainable from list-control-planes tool)",
      "type": "string"
    },
    "offset": {
      "description": "Offset token for pagination (from previous response)",
      "type": "string"
    },
    "size": {
      "default": 100,
      "description": "Number of consumers to return",
      "maximum": 1000,
      "minimum": 1,
      "type": "integer"
    }
  },
  "required": [
    "controlPlaneId"
  ],
  "type": "object"
}

Kong Konnect MCP Server

list_consumers

Instructions

Input Schema

Input Schema (JSON Schema)

Other Tools from Kong Konnect MCP Server

Related Tools