Home / Dev Portal
Edit
Report

Dev Portal developer sign-up

Uses: Dev Portal
Related Documentation
Dev Portal Documentation
OpenAPI Specifications
Konnect Developer Portal
Incompatible with
on-prem
Tags
#authentication
Related Resources
Developer self-service and app registration
Dev Portal developer RBAC

The Dev Portal enables you to quickly get access to your APIs of interest, in a self-serve way. Whether you’re accessing the Dev Portal of a company you work for, or one that you’re interested in, all you need is an application and a set of credentials to start accessing those APIs in minutes.

To create credentials, you must first create an application in which store those credentials.

The following diagram shows how to register your app in Dev Portal:

 
flowchart TD
    A[Sign up for Dev Portal] --> B(Create an application)
    B --> C(Add APIs to the application)
    C --> D(Create application credentials)
    D --> |Generate in Dev Portal| E[Use application] 
    D --> |Create in IdP| E

Register and create an application

All developers must register through the Konnect Dev Portal. A Konnect admin will provide the registration URL.

1. Register or sign in

Go to the Dev Portal and choose one of the following options:

  • Register for access by creating an account
  • Sign in using single sign-on (SSO), if enabled

Once approved, you can create an application.

2. Create an application

You can register an application for one or multiple APIs.

  1. Click Catalog.
  2. Select the API and click Register.
  3. Choose Create an application.
  4. If your Dev Portal admin has enabled app sharing with teams and you want to assign the app to your team, do the following:
    1. Select This is a team owned application.
    2. From the Select team dropdown menu, select the team you want to assign the app to.

Each application supports only one authentication strategy. When combining APIs in a single app, ensure they use the same strategy.

The Reference ID must be unique. For OIDC, use the client ID from your IdP as the reference ID.

To manage your app, go to the app details and select Edit or Delete.

3. Create credentials

Choose one of the following methods to generate credentials:

  • API key: Navigate to My Apps, select your app, and click Generate Credential in the Authentication pane.
  • OIDC: Manually create the app in your identity provider (IdP) and match the Dev Portal reference ID with the client ID.

Once your app has products, credentials, and approval, you can begin making requests using the configured credentials.

FAQs

I’ve logged into the Dev Portal and want to use the Dev Portal API to manage my assets, but it asks for a portalaccesstoken. What is this token and where can I find it?

A portalaccesstoken is a cookie that gets generated when a developer authenticates to Dev Portal. It’s used only by the Dev Portal API.

Unlike the Konnect PAT, it can’t be generated or managed manually, but it can expire. You can find the portalaccesstoken cookie value in an outgoing request to the API after you login, or in the cookie storage section of your browser’s dev tools. If the token expires, you need to re-authenticate with Dev Portal to generate a new cookie.

When using the Dev Portal API, you need to send the portalaccesstoken in a cookie header with requests access any resources that require authentication. For example, the POST /v3/applications endpoint requires auth, so you would access it like this:

curl -X POST https://global.api.konghq.com/v3/applications \
-H 'Content-Type: application/json' \
-H 'Cookie: portalaccesstoken=$JWT_ACCESS_TOKEN_VALUE' \

I created an application in Dev Portal, but I’d like to assign it to my team instead or I want to assign it to a different team. How do I do that?

To assign an app you created to a team in the Dev Portal UI:

  1. Navigate to your app in Dev Portal.
  2. Click the Settings tab.
  3. Under App sharing, click Transfer ownership and select the team you want to transfer the app to.

In the Dev Portal UI, once an application is assigned to a team, ownership can only be transferred to another team you are a member of. Transferring ownership back to an individual developer is only supported by the Dev Portal API. For more details, see Developer self-service and app registration.

Something wrong?
Report an Issue | Edit this Page
View all Kong documentation

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!
Contribute

Still need help?

Ask in our Slack Community
Contact Support