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

Adding Consumers

Before you start:
  1. Make sure you've installed Kong — It should only take a minute!
  2. Make sure you've started Kong.
  3. Also, make sure you've added your API to Kong.

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 API, and can be used for tracking, access management, and more.

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

  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 consumer_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 with the Consumer id from our previous request:

    $ curl -i -X POST \
      --url http://localhost:8001/keyauth_credentials/ \
      --data 'key=ENTER_KEY_HERE' \
      --data 'consumer_id=bbdf1c48-19dc-4ab7-cae0-ff4f59d87dc9'
  3. Verify that your Consumer credentials are valid

    Using the id of the Consumer we just created we can issue the following request to verify that the credentials of our Consumer is valid:

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

Next Steps

Now that we've covered the basics of creating consumers, enabling plugins, and adding apis you can start giving out access and sharing your API.

Keep up with the latest features