Skip to content
Kong Summit 2022: Where API Innovation Runs Wild  —Learn More →
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
    • Konnect Cloud
    • Kong Mesh
    • Plugin Hub
    • decK
    • Kubernetes Ingress Controller
    • Insomnia
    • Kuma

    • Kong Konnect Platform

    • Docs contribution guidelines
  • Plugin Hub
  • Support
  • Community
  • Kong Academy
Request Demo
  • Kong Gateway
  • Konnect Cloud
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kubernetes Ingress Controller
  • Insomnia
  • Kuma

  • Kong Konnect Platform

  • Docs contribution guidelines
    • Overview of Konnect
    • Architecture
    • Network Resiliency and Availability
    • Port and Network Requirements
    • Compatibility
    • Release Notes
    • Overview
    • Access a Konnect Account
    • Set up a Runtime
    • Configure a Service
    • Implement and Test the Service
      • Publish and Consume Services
      • Register Applications
    • Import Kong Gateway Entities into Konnect Cloud
    • Overview
      • Konnect Services
      • Service Versions
      • Service Implementations
      • Manage Service Documentation
      • Overview
      • Configure a Plugin on a Service
      • Configure a Plugin on a Route
    • Overview
      • Overview
      • Manage Runtime Groups with UI
      • Manage Runtime Groups with decK
      • Install with Docker
      • Install on Kubernetes
      • Install on Linux
      • Upgrade a Runtime Instance to a New Version
      • Renew Certificates
      • Runtime Parameter Reference
      • Overview
      • Runtime Configuration
    • Troubleshoot
    • Overview
    • Access the Dev Portal
    • Sign Up for a Dev Portal Account
      • Manage Developer Access
      • Manage Application Registration Requests
      • Manage Application Connections
      • Auto Approve Dev and App Registrations
      • Azure OIDC
      • Application Overview
      • Enable and Disable App Registration
      • Create, Edit, and Delete an Application
      • Register an Application with a Service
      • Generate Credentials for an Application
    • Customize Dev Portal
    • Troubleshoot
    • Introduction to Vitals
    • Overview Dashboard
    • Analyze Services and Routes
    • Generate Reports
      • Manage a Konnect Account or Plan
      • Change to a Different Plan
      • Manage Payment Methods and Invoices
      • Overview
        • Overview
        • Manage Teams and Roles
        • Teams Reference
        • Roles Reference
      • Manage Users
      • Set up SSO with Okta
    • Account and Org Deactivation
    • Troubleshoot
    • Overview of Konnect
      • Access a Konnect Account
        • Manage a Konnect Account or Plan
        • Change to a Different Plan
        • Manage Payment Methods and Invoices
        • Manage Users and Roles
        • Set up SSO with Okta
      • Account and Org Deactivation
      • License Management
      • Port and Network Requirements
      • Network Resiliency and Availability
      • Migrate from Kong Gateway to Konnect Cloud
        • Set up a Runtime
        • Configure a Service
        • Implement and Test the Service
      • Manage Konnect Cloud with decK
      • Manage Services
        • Manage Service Documentation
        • Publish a Service to Dev Portal
        • Docker
        • Kubernetes
        • Linux
        • Runtime Parameter Reference
      • Upgrade a Runtime to a New Version
      • Renew Certificates
        • Developer Registration
        • Manage Developer Access
        • Auto Approve Dev and App Registrations
        • Application Overview
        • Create, Edit, and Delete an Application
        • Enable App Registration
        • Disable App Registration
        • Manage Application Registration Requests
        • Manage Application Connections
        • Register an Application with a Service
        • Generate Credentials for an Application
        • Appearance
        • Public Portal
        • Add a Custom Domain
      • Generating Vitals Reports
      • Configure a Plugin on a Service
      • Configure a Plugin on a Route
      • Configure Global or Consumer Plugins
    • Shared Config
      • Proxy Traffic

github-edit-pageEdit this page

report-issueReport an issue

enterprise-switcher-iconSwitch to OSS

On this page
  • Prerequisites
  • Enable app registration
  • Create an application
  • Register the application
  • Generate a key auth credential
  • Summary and next steps
Konnect Cloud
  • Home
  • Konnect Cloud
  • Getting started

Register an Application to a Service

Along with hosting API documentation, the Dev Portal can let your developers register applications against Konnect services. Your applications can then consume those services using application-level authentication.

For example, the application can represent a mobile banking app and the services registered to the application can be a billing API, a users API, and a legal agreements API.

Prerequisites

  • You have a Konnect service with at least one version in the default runtime group. Application registration is not supported for custom runtime groups.

  • You have published the Konnect service to the Dev Portal.

    • To use app registration, the Dev Portal must be protected by some sort of authentication. That means you can’t have a public portal for this step. If you set your Dev Portal to public, disable the setting and create a developer account.

Enable app registration

  1. From the servicehub icon Service Hub, open a service version.

  2. From the Actions dropdown menu, select Enable app registration.

  3. Accept the key-auth setting, toggle Auto-Approve to enable it, then click Enable.

    Application registration uses key authentication (key-auth) by default. If you have integrated the Dev Portal with an IdP, you can also select openid-connect. For the purpose of this example, we’re using the simpler key-auth option, which doesn’t required any external services.

    With Auto Approve enabled, any developers trying to register their applications against this service will be approved automatically. If you leave it off, you have to approve each registration request manually.

    With app registration enabled, all versions of this service now include read-only entries for the acl and key-auth plugins, and the service is now available for registration from the Dev Portal.

Create an application

Link an application to a published service.

  1. Log into the Konnect Dev Portal.

    You can always find your Dev Portal URL under the Dev Portal menu.

    Remember, the Dev Portal doesn’t share credentials with your Konnect account.

  2. In the Konnect Dev Portal, click My Apps from the dropdown menu in the upper right.

  3. On the My Apps page, click the New App button.

  4. Fill out the form with your application name, reference ID, and description. The reference ID must be unique.

  5. Click Create to save and see your new application’s detail page.

Register the application

  1. From your Dev Portal account, open the Catalog from the top menu and click on a service tile.

  2. Choose the version of the service you want to use and click Register.

    If you don’t see the registration button, that means this version doesn’t have application registration enabled.

  3. Select the application you want to register from the list.

  4. Click Request Access.

    This opens the application’s details page. If auto approval is enabled, the service appears with the status Approved.

Generate a key auth credential

  1. In the Authentication pane of the application detail page, click Generate Credential.

  2. Test the generated credential by making a call to the service the application is registered with using your generated API key:

    curl -i -X GET http://localhost:8000/mock \
     -H 'apikey: {API_KEY}'
    

    Use this key in any applications that need to access this service.

Summary and next steps

In this topic, you:

  • Enabled application registration for the a service
  • Created an application through the Dev Portal and registered it against your service
  • Generated an API key for the application and made a call using this key

For next steps, check out some of the other things you can do in Konnect Cloud:

  • If you have existing Kong Gateway configuration you want to use, import Kong Gateway entities into Konnect Cloud
  • Enable plugins on a service or a route
  • Manage your teams and roles
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. 2022