Careful! You are browsing documentation for an outdated version of Kong. Go here to browse the documentation for the latest version.

Table of Contents

Adding Consumers

In the last section, we learned how to add plugins to Kong Enterprise Edition (EE) - in this section we're going to learn how to add Consumers to Kong. Consumers are associated to individuals or applications using your API, and can be used for tracking, access management, and more.

Note: This section assumes you have enabled the key-auth plugin. If you haven't, you can either enable the plugin or skip steps two and three.

1. Create a Consumer

If you'd like to use the Admin API, issue the following cURL request to create your first Consumer, named Jason:

$ curl -i -X POST \
  --url http://localhost:8001/consumers/ \
  --data "username=Jason"

You should see a response similar to the one below:

HTTP/1.1 201 Created
Content-Type: application/json
Connection: keep-alive

{
  "username": "Jason",
  "created_at": 1428555626000,
  "id": "bbdf1c48-19dc-4ab7-cae0-ff4f59d87dc9"
}

Or, add your first Consumer via the Admin GUI:

Congratulations! You've just added your first Consumer to Kong.

Note: Kong also accepts a custom_id parameter when creating Consumers to associate a Consumer with your existing user database.

2. Provision key credentials for your Consumer

Now, we can create a key for our recently created Consumer Jason by issuing the following request:

$ curl -i -X POST \
  --url http://localhost:8001/consumers/Jason/key-auth/ \
  --data 'key=ENTER_KEY_HERE'

3. Verify that your Consumer credentials are valid

We can now issue the following request to verify that the credentials of our Jason Consumer is valid:

$ curl -i -X GET \
  --url http://localhost:8000 \
  --header "Host: example.com" \
  --header "apikey: ENTER_KEY_HERE"

Next Steps

Now that we've covered the basics of adding APIs, Consumers and enabling Plugins, feel free to read more on Kong in one of the following documents: