Automatically create Dev Portal applications in Kong Identity with Dynamic Client Registration

This is a Konnect tutorial and requires a Konnect personal access token.

1. Create a new personal access token by opening the Konnect PAT page and selecting Generate Token.

2. Export your token to an environment variable:

    export KONNECT_TOKEN='YOUR_KONNECT_PAT'
   

   Copied!

3. Run the quickstart script to automatically provision a Control Plane and Data Plane, and configure your environment:

    curl -Ls https://get.konghq.com/quickstart | bash -s -- -k $KONNECT_TOKEN --deck-output
   

   Copied!

   This sets up a Konnect Control Plane named quickstart, provisions a local Data Plane, and prints out the following environment variable exports:

    export DECK_KONNECT_TOKEN=$KONNECT_TOKEN
    export DECK_KONNECT_CONTROL_PLANE_NAME=quickstart
    export KONNECT_CONTROL_PLANE_URL=https://us.api.konghq.com
    export KONNECT_PROXY_URL='http://localhost:8000'
   

   Copied!

   Copy and paste these into your terminal to configure your session.

decK is a CLI tool for managing Kong Gateway declaratively with state files. To complete this tutorial, install decK version 1.43 or later.

This guide uses deck gateway apply, which directly applies entity configuration to your Gateway instance. We recommend upgrading your decK installation to take advantage of this tool.

You can check your current decK version with deck version.

For this tutorial, you’ll need Kong Gateway entities, like Gateway Services and Routes, pre-configured. These entities are essential for Kong Gateway to function but installing them isn’t the focus of this guide. Follow these steps to pre-configure them:

1. Run the following command:

   echo '
   _format_version: "3.0"
   services:
     - name: example-service
       url: http://httpbin.konghq.com/anything
   routes:
     - name: example-route
       paths:
       - "/anything"
       service:
         name: example-service
   ' | deck gateway apply -
   

   Copied!

To learn more about entities, you can read our entities documentation.

For this tutorial, you’ll need a Dev Portal and some Dev Portal settings, like a published API, pre-configured. These settings are essential for Dev Portal to function but configuring them isn’t the focus of this guide. If you don’t have these settings already configured, follow these steps to pre-configure them:

1. In the Konnect sidebar, navigate to Dev Portal.
2. Click New portal.
3. Click Private portal.
4. In the Portal name field, enter Test Kong Identity DCR.
5. Click Create and continue.
6. Click Save.
7. Copy and export your Dev Portal URL in your terminal:

   export PORTAL_URL='
   https://your-domain.us.kongportals.com'
   

   Copied!
8. In your Dev Portal sidebar, click Settings.
9. Click the Security tab.
10. Enable Auto approve applications. This auto approves developer applications in your Dev Portal and makes it easier to test.
11. Click Save changes.
12. Click Dev Portal in the sidebar.
13. In the Dev Portal sidebar, click APIs.
14. Click New API.
15. In the API name field, enter test-kong-identity-dcr.
16. Click Create.
17. Click Gateway Service tab.
18. Click Link Gateway Service.
19. From the Control plane dropdown menu, select “quickstart”.
20. From the Gateway Service dropdown menu, select “example-service”.
21. Click Submit.
22. Navigate to your Dev Portal URL:

    open $PORTAL_URL
    

    Copied!
23. Click Sign up. We’ll create a test developer account that we can use to create a DCR app.
24. Enter your name and email.
25. Click Create account.
26. If you haven’t set developers to auto approval in Dev Portal, in the Konnect sidebar, navigate to Dev Portal.
27. Click Test Kong Identity DCR.
28. In the Dev Portal sidebar, click Access and approvals.
29. Click your test developer.
30. From the Actions dropdown menu, select “Approve”.