Apache APISIX Consumer

A Consumer is an entity that consumes API services and is identified by a username.

ApacheAPI GatewayCloud NativeKubernetesLuaNGINXOpen SourceTraffic Management

Properties

Name	Type	Description
username	string	Unique username for the consumer.
desc	string	Description of the consumer.
plugins	object	Plugin configuration bound to this consumer.
labels	object	Key-value pairs for categorization.
group_id	string	ID of a consumer group this consumer belongs to.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/api-evangelist/apache-apisix/blob/main/json-schema/consumer.json",
  "title": "Apache APISIX Consumer",
  "description": "A Consumer is an entity that consumes API services and is identified by a username.",
  "type": "object",
  "required": ["username"],
  "properties": {
    "username": {
      "type": "string",
      "description": "Unique username for the consumer."
    },
    "desc": {
      "type": "string",
      "description": "Description of the consumer."
    },
    "plugins": {
      "type": "object",
      "description": "Plugin configuration bound to this consumer."
    },
    "labels": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Key-value pairs for categorization."
    },
    "group_id": {
      "type": "string",
      "description": "ID of a consumer group this consumer belongs to."
    }
  }
}