Skip to content
2023 API Summit Hackathon: Experiment with AI for APIs (August 28 - September 27) Learn More →
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
      Lightweight, fast, and flexible cloud-native API gateway
      Kong Konnect
      Single platform for SaaS end-to-end connectivity
      Kong Mesh
      Enterprise service mesh based on Kuma and Envoy
      decK
      Helps manage Kong’s configuration in a declarative fashion
      Kong Ingress Controller
      Works inside a Kubernetes cluster and configures Kong to proxy traffic
      Kong Gateway Operator
      Manage your Kong deployments on Kubernetes using YAML Manifests
      Insomnia
      Collaborative API development platform
      Kuma
      Open-source distributed control plane with a bundled Envoy Proxy integration
  • API Specs
  • Plugin Hub
    • Explore the Plugin Hub
      View all plugins View all plugins View all plugins arrow image
    • Functionality View all View all arrow image
      View all plugins
      Authentication's icon
      Authentication
      Protect your services with an authentication layer
      Security's icon
      Security
      Protect your services with additional security layer
      Traffic Control's icon
      Traffic Control
      Manage, throttle and restrict inbound and outbound API traffic
      Serverless's icon
      Serverless
      Invoke serverless functions in combination with other plugins
      Analytics & Monitoring's icon
      Analytics & Monitoring
      Visualize, inspect and monitor APIs and microservices traffic
      Transformations's icon
      Transformations
      Transform request and responses on the fly on Kong
      Logging's icon
      Logging
      Log request and response data using the best transport for your infrastructure
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
Kong Gateway
3.2.x
  • Home icon
  • Kong Gateway
  • Kong Manager
  • Get Started
  • Authentication with Consumers
github-edit-pageEdit this page
report-issueReport an issue
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kong Ingress Controller
  • Kong Gateway Operator
  • Insomnia
  • Kuma

  • Docs contribution guidelines
  • 3.4.x (latest)
  • 3.3.x
  • 3.2.x
  • 3.1.x
  • 3.0.x
  • 2.8.x
  • 2.7.x
  • 2.6.x
  • Archive (pre-2.6)
enterprise-switcher-icon Switch to OSS
On this pageOn this page
  • Set up the Key Authentication Plugin
  • Set up Consumers and Credentials
  • Validate Key Authentication
  • Next steps
You are browsing documentation for an outdated version. See the latest documentation here.

Authentication with Consumers

In this example, you’re going to enable the Key Authentication plugin, then create a consumer that uses key authentication. API key authentication is one of the most popular ways to conduct API authentication and can be implemented to create and delete access keys as required.

If you prefer to use the Admin API, check out the Kong Gateway getting started guide.

Set up the Key Authentication Plugin

From the Workspaces tab in Kong Manager:

  1. Open the default workspace.
  2. From the menu, open Routes and select the mocking route you created.
  3. From the sub-menu, select the Plugins tab, then click Install Plugin.
  4. Find the Key Authentication plugin and click Enable.
  5. On the Install plugin: key-auth page, the plugin fields are automatically scoped to the route because the plugin is selected from the mocking route’s page.

    For this example, this means that you can use all of the default values.

  6. Click Create.

Now, if you try to access the route without providing an API key, the request will fail, and you’ll see the message "No API key found in request".

Before Kong proxies requests for this route, it needs an API key. For this example, since you installed the Key Authentication plugin, you need to create a consumer with an associated key first.

Set up Consumers and Credentials

From the Workspaces tab in Kong Manager:

  1. Open the default workspace.
  2. From the menu, open Consumers, then click New Consumer.
  3. Enter a Username and Custom ID. For this example, you can use consumer for each field.
  4. Click Create.
  5. On the Consumers page, open your new consumer.
  6. Open Credentials from the sub-menu.
  7. Click New Key Auth Credential.
  8. Set the key to apikey and click Create.

The new Key Authentication ID displays on the Consumers page under the Credentials tab.

Validate Key Authentication

To validate the Key Authentication plugin, access your route through your browser by appending ?apikey=apikey to the url:

http://localhost:8000/mock?apikey=apikey

Next steps

Next, you’ll learn about load balancing upstream services using targets.

Thank you for your feedback.
Was this page useful?
Too much on your plate? close cta icon
More features, less infrastructure with Kong Konnect. 1M requests per month for free.
Try it for Free
  • 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