Applications

Create Application

Changed on

Creates a new application for this portal. The application must be assigned to a developer or a team. An application can be registered for various APIs, issuing credentials for API access. If using DCR, an application will be linked to an Identity Provider's application by its client_id.

post/v3/portals/{portalId}/applications

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/portals/{portalId}/applications
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

portalIdstring uuid required
Example:f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Request body

namestring required

The name of the application.

descriptionstring

A description of the application.

labelsLabelsUpdate nullable

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Labels are intended to store INTERNAL metadata.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

dcr_client_idstring

If using a DCR auth strategy, set this property to link the portal application to an existing client from the DCR provider, instead of having Konnect create a new client.

This allows importing existing clients from an Identity Provider into Konnect, allowing them to be controlled through DCR flows in the portal and use existing client secrets for API access.

The value must be a valid client ID in the DCR provider associated with the auth strategy. For some DCR providers, if the client ID is invalid, the application may still be created but will not function properly.

Note: For AzureAD auth strategies, the client ID must resolve to an accessible Microsoft Entra application using the configured DCR provider credentials. Otherwise, application creation fails.

client_idstring

An identifier to correlate the application with an external system. Cannot be set when using Dynamic Client Registration.

auth_strategy_idstring uuid

The ID of the authentication strategy the application will use when making requests to registered APIs.

Example request

{
  "name": "Portal Application",
  "description": "A portal application provisioned for a developer by a Portal Admin.",
  "labels": {
    "env": "production"
  },
  "auth_strategy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "owner": {
    "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
    "type": "developer"
  }
}

Response

Details about an application in a portal.

OR

Example response

{
  "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z",
  "labels": {
    "env": "test"
  },
  "dcr_provider": {
    "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7"
  },
  "portal": {
    "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7"
  },
  "auth_strategy": {
    "id": "b9e81174-b5bb-4638-a3c3-8afe61a0abf8",
    "name": "name",
    "auth_methods": [
      "bearer"
    ],
    "available_scopes": [
      "scope1",
      "scope2"
    ]
  }
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status