Skip to content
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
    • Kong Konnect
    • Kong Mesh
    • Plugin Hub
    • decK
    • Kubernetes Ingress Controller
    • Insomnia
    • Kuma

    • Docs contribution guidelines
  • Plugin Hub
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kubernetes Ingress Controller
  • Insomnia
  • Kuma

  • Docs contribution guidelines
  • 3.2.x (latest)
  • 3.1.x
  • 3.0.x
  • 2.8.x
  • 2.7.x
  • 2.6.x
  • Older Enterprise versions (2.1-2.5)
  • Older OSS versions (2.1-2.5)
  • Archive (pre-2.1)
    • Overview of Kong Gateway
      • Version Support Policy
      • Third Party Dependencies
      • Browser Support
    • Stability
    • Release Notes
      • Services
        • Overview
        • Configure Routes with Expressions
      • Upstreams
      • Plugins
      • Routing Traffic
      • Load Balancing
      • Health Checks and Circuit Breakers
      • Kong Performance Testing
    • Glossary
    • Get Kong
    • Services and Routes
    • Rate Limiting
    • Proxy Caching
    • Key Authentication
    • Load-Balancing
      • Overview
        • Overview
        • Deploy Kong Gateway in Hybrid mode
      • DB-less Deployment
      • Traditional
      • Overview
        • Helm
        • OpenShift with Helm
        • kubectl apply
        • Kubernetes Deployment Options
        • Using docker run
        • Build your own Docker images
        • Amazon Linux
        • Debian
        • Red Hat
        • Ubuntu
      • Running Kong as a non-root user
      • Securing the Admin API
      • Using systemd
      • Start Kong Gateway Securely
      • Programatically Creating Admins
      • Enabling RBAC
      • Overview
      • Download your License
      • Deploy Enterprise License
      • Using the License API
      • Monitor Licenses Usage
      • Default Ports
      • DNS Considerations
      • Network and Firewall
      • CP/DP Communication through a Forward Proxy
        • Configure PostgreSQL TLS
        • Troubleshooting PostgreSQL TLS
    • Kong Configuration File
    • Environment Variables
    • Serving a Website and APIs from Kong
      • Overview
      • Prometheus
      • StatsD
      • Datadog
      • Overview
      • Writing a Custom Trace Exporter
      • Tracing API Reference
    • Resource Sizing Guidelines
    • Security Update Process
    • Blue-Green Deployments
    • Canary Deployments
    • Clustering Reference
      • Log Reference
      • Dynamic log level updates
      • Customize Gateway Logs
      • Upgrade Kong Gateway 3.x.x
      • Migrate from OSS to Enterprise
    • Overview
      • Overview
      • Metrics
      • Analytics with InfluxDB
      • Analytics with Prometheus
      • Estimate Analytics Storage in PostgreSQL
      • Overview
      • Getting Started
      • Advanced Usage
        • Overview
        • Environment Variables
        • AWS Secrets Manager
        • Google Secrets Manager
        • Hashicorp Vault
        • Securing the Database with AWS Secrets Manager
      • Reference Format
      • Overview
      • Get Started with Dynamic Plugin Ordering
      • Overview
      • Enable the Dev Portal
      • Publish an OpenAPI Spec
      • Structure and File Types
      • Themes Files
      • Working with Templates
      • Using the Editor
        • Basic Auth
        • Key Auth
        • OIDC
        • Sessions
        • Adding Custom Registration Fields
        • Manage Developers
        • Developer Roles and Content Permissions
        • Authorization Provider Strategy
        • Enable Application Registration
        • Enable Key Authentication for Application Registration
          • External OAuth2 Support
          • Set up Okta and Kong for External Oauth
          • Set up Azure AD and Kong for External Authentication
        • Manage Applications
        • Theme Editing
        • Migrating Templates Between Workspaces
        • Markdown Rendering Module
        • Customizing Portal Emails
        • Adding and Using JavaScript Assets
        • Single Page App in Dev Portal
        • Alternate OpenAPI Renderer
      • SMTP
      • Workspaces
      • Helpers CLI
      • Portal API Documentation
    • Audit Logging
    • Keyring and Data Encryption
    • Workspaces
    • Consumer Groups
    • Event Hooks
    • Configure Data Plane Resilience
    • About Control Plane Outage Management
      • Overview
      • Install the FIPS Compliant Package
      • FIPS 140-2 Compliant Plugins
    • Overview
    • Enable Kong Manager
      • Services and Routes
      • Rate Limiting
      • Proxy Caching
      • Authentication with Consumers
      • Load Balancing
      • Overview
      • Create a Super Admin
      • Workspaces and Teams
      • Reset Passwords and RBAC Tokens
      • Basic Auth
        • Configure LDAP
        • LDAP Service Directory Mapping
        • Configure OIDC
        • OIDC Authenticated Group Mapping
      • Sessions
        • Overview
        • Enable RBAC
        • Add a Role and Permissions
        • Create a User
        • Create an Admin
    • Networking Configuration
    • Workspaces
    • Create Consumer Groups
    • Sending Email
    • Overview
    • File Structure
    • Implementing Custom Logic
    • Plugin Configuration
    • Accessing the Data Store
    • Storing Custom Entities
    • Caching Custom Entities
    • Extending the Admin API
    • Writing Tests
    • (un)Installing your Plugin
      • Overview
      • kong.client
      • kong.client.tls
      • kong.cluster
      • kong.ctx
      • kong.ip
      • kong.jwe
      • kong.log
      • kong.nginx
      • kong.node
      • kong.request
      • kong.response
      • kong.router
      • kong.service
      • kong.service.request
      • kong.service.response
      • kong.table
      • kong.tracing
      • kong.vault
      • kong.websocket.client
      • kong.websocket.upstream
      • Go
      • Javascript
      • Python
      • Running Plugins in Containers
      • External Plugin Performance
    • Overview
        • Overview
        • OpenID Connect with Curity
        • OpenID Connect with Azure AD
        • OpenID Connect with Google
        • OpenID Connect with Okta
        • OpenID Connect with Auth0
        • OpenID Connect with Cognito
      • Authentication Reference
      • Allow Multiple Authentication Plugins
    • Rate Limiting Plugin
      • Add a Body Value
    • GraphQL
      • gRPC Plugins
      • Configure a gRPC service
    • Overview
    • Information Routes
    • Health Routes
    • Tags
    • Debug Routes
    • Services
    • Routes
    • Consumers
    • Plugins
    • Certificates
    • CA Certificates
    • SNIs
    • Upstreams
    • Targets
    • Vaults
    • Keys
    • Licenses
    • Workspaces
    • RBAC
    • Admins
    • Developers
    • Consumer Groups
    • Event Hooks
    • Keyring and Data Encryption
    • Audit Logs
    • kong.conf
    • Injecting Nginx Directives
    • CLI
    • Key Management
    • Performance Testing Framework
    • Router Expressions Language
    • FAQ

github-edit-pageEdit this page

report-issueReport an issue

enterprise-switcher-iconSwitch to OSS

On this page
  • Set up consumer group
  • Set up Rate Limiting Advanced config for consumer group
  • Remove consumer from group - group view
  • Remove consumer from group - consumer view
  • Delete consumer group configurations
  • Delete consumer group
  • Manage multiple consumers
Kong Gateway
3.2.x (latest)
  • Home
  • Kong Gateway
  • Kong Enterprise
  • Consumer Groups
  • Consumer Groups Examples

Consumer Groups Examples

With consumer groups, you can define any number of rate limiting tiers and apply them to subsets of consumers, instead of managing each consumer individually.

For example, you could define three consumer groups:

  • A “gold tier” with 1000 requests per minute
  • A “silver tier” with 10 requests per second
  • A “bronze tier” with 6 requests per second

The consumer_groups endpoint works together with the Rate Limiting Advanced plugin.

Consumers that are not in a consumer group default to the Rate Limiting advanced plugin’s configuration, so you can define tier groups for some users and have a default behavior for consumers without groups.

To use consumer groups for rate limiting, you need to:

  • Create one or more consumer groups
  • Create consumers
  • Assign consumers to groups
  • Configure the Rate Limiting Advanced plugin with the enforce_consumer_groups and consumer_groups parameters, setting up the list of consumer groups that the plugin accepts
  • Configure rate limiting for each consumer group, overriding the plugin’s configuration

For all possible requests, see the Consumer Groups reference.

Set up consumer group

  1. Create a consumer group named Gold:

    cURL
    HTTPie
    curl -i -X POST http://{HOSTNAME}:8001/consumer_groups \
       --data name=Gold
    
    http POST :8001/consumer_groups name=Gold
    

    Response:

     {
         "created_at": 1638915521,
         "id": "8a4bba3c-7f82-45f0-8121-ed4d2847c4a4",
         "name": "Gold",
         "tags": null
     }
    
  2. Create a consumer, Amal:

    cURL
    HTTPie
    curl -i -X POST http://{HOSTNAME}:8001/consumers \
       --data username=Amal
    
    http POST :8001/consumers username=Amal
    

    Response:

     {
         "created_at": 1638915577,
         "custom_id": null,
         "id": "8089a0e6-1d31-4e00-bf51-5b902899b4cb",
         "tags": null,
         "type": 0,
         "username": "Amal",
         "username_lower": "amal"
     }
    
  3. Add Amal to the Gold consumer group:

    cURL
    HTTPie
    curl -i -X POST http://{HOSTNAME}:8001/consumer_groups/Gold/consumers \
       --data consumer=Amal
    
    http POST :8001/consumer_groups/Gold/consumers consumer=Amal
    

    Response:

     {
       "consumer_group": {
       "created_at": 1638915521,
       "id": "8a4bba3c-7f82-45f0-8121-ed4d2847c4a4",
       "name": "Gold",
       "tags": null
       },
       "consumers": [
         {
             "created_at": 1638915577,
             "id": "8089a0e6-1d31-4e00-bf51-5b902899b4cb",
             "type": 0,
             "username": "Amal",
             "username_lower": "amal"
         }
       ]
     }
    

Set up Rate Limiting Advanced config for consumer group

  1. Enable the Rate Limiting Advanced plugin, setting the rate limit to five requests (config.limit) for every 30 seconds (config.window_size):

    cURL
    HTTPie
    curl -i -X POST http://{HOSTNAME}:8001/plugins/  \
       --data name=rate-limiting-advanced \
       --data config.limit=5 \
       --data config.window_size=30 \
       --data config.window_type=sliding \
       --data config.retry_after_jitter_max=0 \
       --data config.enforce_consumer_groups=true \
       --data config.consumer_groups=Gold
    
    http -f :8001/plugins/  \
       name=rate-limiting-advanced \
       config.limit=5 \
       config.window_size=30 \
       config.window_type=sliding \
       config.retry_after_jitter_max=0 \
       config.enforce_consumer_groups=true \
       config.consumer_groups=Gold
    

    For consumer groups, the following parameters are required:

    • config.enforce_consumer_groups=true: enables consumer groups for this plugin.
    • config.consumer_groups=Gold: specifies a list of groups that this plugin allows overrides for.

    Note: In this example, you’re configuring the plugin globally, so it applies to all entities (Services, Routes, and Consumers) in the Kong Gateway instance. You can also apply it to a specific Service or Route for more granular control.

  2. The plugin you just set up applies to all consumers in the cluster. Change the rate limiting configuration for the Gold consumer group only, setting the limit to ten requests for every ten seconds:

    cURL
    HTTPie
    curl -i -X PUT http://{HOSTNAME}:8001/consumer_groups/Gold/overrides/plugins/rate-limiting-advanced \
       --data config.limit=10 \
       --data config.window_size=10 \
       --data config.retry_after_jitter_max=1
    
    http PUT :8001/consumer_groups/Gold/overrides/plugins/rate-limiting-advanced \
       config.limit=10 \
       config.window_size=10 \
       config.retry_after_jitter_max=1
    

    Response:

     {
       "config": {
           "limit": [
               10
           ],
           "retry_after_jitter_max": 1,
           "window_size": [
               10
           ]
       },
       "consumer_group": "Gold",
       "plugin": "rate-limiting-advanced"
     }
    
  3. Check that it worked by looking at the Gold consumer group object:

    cURL
    HTTPie
    curl -i -X GET http://{HOSTNAME}:8001/consumer_groups/Gold
    
    http :8001/consumer_groups/Gold
    

    Notice the plugins object in the response, along with the parameters that you just set for the Rate Limiting Advanced plugin:

     {
         "consumer_group": {
             "created_at": 1638915521,
             "id": "8a4bba3c-7f82-45f0-8121-ed4d2847c4a4",
             "name": "Gold",
             "tags": null
         },
         "consumers": [
             {
                 "created_at": 1638915577,
                 "id": "8089a0e6-1d31-4e00-bf51-5b902899b4cb",
                 "type": 0,
                 "username": "Amal",
                 "username_lower": "amal"
             }
         ],
         "plugins": [
             {
                 "config": {
                     "limit": [
                         10
                     ],
                     "retry_after_jitter_max": 1,
                     "window_size": [
                         10
                     ],
                     "window_type": "sliding"
                 },
                 "consumer_group": {
                     "id": "8a4bba3c-7f82-45f0-8121-ed4d2847c4a4"
                 },
                 "created_at": 1638916518,
                 "id": "b7c426a2-6fcc-4bfd-9b7a-b66e8f1ad260",
                 "name": "rate-limiting-advanced"
             }
         ]
     }
    

Remove consumer from group - group view

You can remove a consumer from a group by accessing /consumers or /consumer_groups. The following steps use /consumer_groups.

  1. Check the Gold consumer group for the consumer name:

    cURL
    HTTPie
    curl -i -X GET http://{HOSTNAME}:8001/consumer_groups/Gold
    
    http :8001/consumer_groups/Gold
    

    Response:

     {
         "consumer_group": {
             "created_at": 1638915521,
             "id": "8a4bba3c-7f82-45f0-8121-ed4d2847c4a4",
             "name": "Gold",
             "tags": null
         },
         "consumers": [
             {
                 "created_at": 1638915577,
                 "id": "8089a0e6-1d31-4e00-bf51-5b902899b4cb",
                 "type": 0,
                 "username": "Amal",
                 "username_lower": "amal"
             }
         ]
       }
    
  2. Using the username or ID of the consumer (Amal in this example), remove the consumer from the group:

    cURL
    HTTPie
    curl -i -X DELETE http://{HOSTNAME}:8001/consumer_groups/Gold/consumers/Amal
    
    http DELETE :8001/consumer_groups/Gold/consumers/Amal
    

    If successful, you receive the following response:

     HTTP/1.1 204 No Content
    
  3. To verify, check the consumer group configuration again:

    cURL
    HTTPie
    curl -i -X GET http://{HOSTNAME}:8001/consumer_groups/Gold
    
    http :8001/consumer_groups/Gold
    

    Response, with no consumers assigned:

     {
         "consumer_group": {
             "created_at": 1638917780,
             "id": "be4bcfca-b1df-4fac-83cc-5cf6774bf48e",
             "name": "Gold",
             "tags": null
         }
     }
    

Remove consumer from group - consumer view

You can remove a consumer from a group by accessing /consumers or /consumer_groups. The following steps use /consumers.

  1. If you know the consumer name and not the consumer group name, you can look up the group through the consumer:

    cURL
    HTTPie
    curl -i -X GET http://{HOSTNAME}:8001/consumers/Amal/consumer_groups
    
    http :8001/consumers/Amal/consumer_groups
    

    Response:

     {
         "consumer_groups": [
             {
                 "created_at": 1638915521,
                 "id": "8a4bba3c-7f82-45f0-8121-ed4d2847c4a4",
                 "name": "Gold",
                 "tags": null
             }
         ]
     }
    
  2. Using the username or ID of the group (Gold in this example), remove the consumer from the group:

    cURL
    HTTPie
    curl -i -X DELETE http://{HOSTNAME}:8001/consumers/Amal/consumer_groups/Gold
    
    http DELETE :8001/consumers/Amal/consumer_groups/Gold
    

    If successful, you receive the following response:

     HTTP/1.1 204 No Content
    
  3. To verify, check the consumer object configuration:

    cURL
    HTTPie
    curl -i -X GET http://{HOSTNAME}:8001/consumer_groups/Gold
    
    http :8001/consumer_groups/Gold
    

    Response, with no consumers assigned:

     {
         "consumer_group": {
             "created_at": 1638917780,
             "id": "be4bcfca-b1df-4fac-83cc-5cf6774bf48e",
             "name": "Gold",
             "tags": null
         }
     }
    

Delete consumer group configurations

You can also clear the configuration of a consumer group without deleting the consumer group itself.

With this method, the consumers in the group aren’t deleted and are still in the consumer group.

  1. Delete the consumer group configuration using the following request:

    cURL
    HTTPie
    curl -i -X DELETE http://{HOSTNAME}:8001/consumer_groups/Gold/overrides/plugins/rate-limiting-advanced
    
    http DELETE :8001/consumer_groups/Gold/overrides/plugins/rate-limiting-advanced
    

    If successful, you receive see the following response:

     HTTP/1.1 204 No Content
    
  2. To verify, check the consumer object configuration:

    cURL
    HTTPie
    curl -i -X GET http://{HOSTNAME}:8001/consumer_groups/Gold
    
    http :8001/consumer_groups/Gold
    

    Response, without a plugins object:

     {
         "consumer_group": {
             "created_at": 1638917780,
             "id": "be4bcfca-b1df-4fac-83cc-5cf6774bf48e",
             "name": "Gold",
             "tags": null
         }
     }
    

Delete consumer group

If you don’t need a consumer group anymore, you can delete it. This removes all consumers from the group, and deletes the group itself. The consumers in the group are not deleted.

  1. Delete a consumer group using the following request:

    cURL
    HTTPie
    curl -i -X DELETE http://{HOSTNAME}:8001/consumer_groups/Gold
    
    http DELETE :8001/consumer_groups/Gold
    

    If successful, you receive see the following response:

     HTTP/1.1 204 No Content
    
  2. Check the list of consumer groups to verify that the Gold group is gone:

    cURL
    HTTPie
    curl -i -X GET http://{HOSTNAME}:8001/consumer_groups
    
    http :8001/consumer_groups
    

    Response:

     {
     "data": [],
     "next": null
     }
    
  3. Check a consumer that was in the group to make sure it still exists:

    cURL
    HTTPie
    curl -i -X GET http://{HOSTNAME}:8001/consumers/Amal
    
    http :8001/consumers/Amal
    

    An HTTP/1.1 200 OK response means the consumer exists.

Manage multiple consumers

You can perform many /consumer_groups operations in bulk.

  1. Assuming you deleted the group Gold in the previous section, create it again, along with another group named Speedsters:

    cURL
    HTTPie
    curl -i -X POST http://{HOSTNAME}:8001/consumer_groups \
       --data name=Gold
        
     curl -i -X POST http://{HOSTNAME}:8001/consumer_groups \
       --data name=Speedsters
    
    http POST :8001/consumer_groups name=Gold
        
     http POST :8001/consumer_groups name=Speedsters
    
  2. Create two consumers, BarryAllen and WallyWest:

    cURL
    HTTPie
    curl -i -X POST http://{HOSTNAME}:8001/consumers \
       --data username=BarryAllen
        
     curl -i -X POST http://{HOSTNAME}:8001/consumers \
       --data username=WallyWest
    
    http POST :8001/consumers username=BarryAllen
        
     http POST :8001/consumers username=WallyWest
    
  3. Add both consumers to the Speedsters group:

    cURL
    HTTPie
    curl -i -X POST http://{HOSTNAME}:8001/consumer_groups/Speedsters/consumers \
       --data consumer=BarryAllen \
       --data consumer=WallyWest
    
    http POST :8001/consumer_groups/Speedsters/consumers \
       consumer:='["BarryAllen", "WallyWest"]'
    

    Kong Gateway validates the provided list of consumers before assigning them to the consumer group. To pass validation, consumers must exist and must not be in the group already.

    If any consumer fails validation, no consumers are assigned to the group.

    Response, if everything is successful:

     {
         "consumer_group": {
             "created_at": 1639432267,
             "id": "a905151a-5767-40e8-804e-50eec4d0235b",
             "name": "Speedsters",
             "tags": null
         },
         "consumers": [
             {
                 "created_at": 1639432286,
                 "id": "ea904e1d-1f0d-4d5a-8391-cae60cb21d61",
                 "type": 0,
                 "username": "BarryAllen",
                 "username_lower": "barryallen"
             },
             {
                 "created_at": 1639432288,
                 "id": "065d8249-6fe6-4d80-a0ae-f159caef7af0",
                 "type": 0,
                 "username": "WallyWest",
                 "username_lower": "wallywest"
             }
         ]
     }
    
  4. You can clear all consumers from a group with one request. This may be useful if you need to cycle the group for a new batch of users.

    For example, delete all consumers from the Speedsters group:

    cURL
    HTTPie
    curl -i -X DELETE http://{HOSTNAME}:8001/consumer_groups/Speedsters/consumers
    
    http DELETE :8001/consumer_groups/Speedsters/consumers
    

    Response:

     HTTP/1.1 204 No Content
    
  5. You can also add a consumer to multiple groups:
    • If all groups are allowed by the Rate Limiting Advanced plugin, only the first group’s settings apply.
    • Otherwise, whichever group is specified in the Rate Limiting Advanced plugin becomes active.

    Add BarryAllen to two groups, Gold and Speedsters:

    cURL
    HTTPie
    curl -i -X POST http://{HOSTNAME}:8001/consumers/BarryAllen/consumer_groups \
       --data group=Gold \
       --data group=Speedsters
    
    http POST :8001/consumers/BarryAllen/consumer_groups \
       group:='["Gold", "Speedsters"]'
    

    The response should look something like this:

     {
       "consumer": {
           "created_at": 1639436091,
           "custom_id": null,
           "id": "6098d577-6741-4cf8-9c86-e68057b8f970",
           "tags": null,
           "type": 0,
           "username": "BarryAllen",
           "username_lower": "barryallen"
       },
       "consumer_groups": [
           {
               "created_at": 1639432267,
               "id": "a905151a-5767-40e8-804e-50eec4d0235b",
               "name": "Gold",
               "tags": null
           },
           {
               "created_at": 1639436107,
               "id": "2fd2bdd6-690c-4e49-8296-31f55015496d",
               "name": "Speedsters",
               "tags": null
           }
       ]
     }
    
  6. Finally, you can also remove a consumer from all groups:

    cURL
    HTTPie
    curl -i -X DELETE http://{HOSTNAME}:8001/consumers/BarryAllen/consumer_groups
    
    http DELETE :8001/consumers/BarryAllen/consumer_groups
    

    Response:

     HTTP/1.1 204 No Content
    
Thank you for your feedback.
Was this page useful?
  • Kong
    THE CLOUD CONNECTIVITY COMPANY

    Kong powers reliable digital connections across APIs, hybrid and multi-cloud environments.

    • Company
    • Customers
    • Events
    • Investors
    • Careers Hiring!
    • Partners
    • Press
    • Contact
  • Products
    • Kong Konnect
    • Kong Gateway
    • Kong Mesh
    • Get Started
    • Pricing
  • Resources
    • eBooks
    • Webinars
    • Briefs
    • Blog
    • API Gateway
    • Microservices
  • Open Source
    • Install Kong Gateway
    • Kong Community
    • Kubernetes Ingress
    • Kuma
    • Insomnia
  • Solutions
    • Decentralize
    • Secure & Govern
    • Create a Dev Platform
    • API Gateway
    • Kubernetes
    • Service Mesh
Star
  • Terms•Privacy
© Kong Inc. 2023