You are browsing documentation for an outdated version. See the latest documentation here.
Adding Consumers
In the last section, we learned how to add plugins to Kong, in this section we’re going to learn how to add consumers to your Kong instances. Consumers are associated to individuals using your Service, and can be used for tracking, access management, and more.
Before you start
- You have installed and started Kong Gateway, either through the Docker quickstart or a more comprehensive installation.
- You have configured a Service
- You have enabled the key-auth plugin
1. Create a Consumer through the RESTful API
Lets create a user named Jason by issuing the following request:
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"
}
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 Services, Routes, Consumers and enabling Plugins, feel free to read more on Kong in one of the following documents:
Questions? Issues? Contact us on one of the Community Channels for help!