KOkong
Applications

Get an Application by Portal

Changed on

Returns the configuration of a single application in this portal. If an application is linked to a DCR Provider, the dcr_provider.id and client_id can be used to correlate it. An application manages a set of credentials and registrations for specific APIs.

get/v3/portals/{portalId}/applications/{applicationId}

Request

Response

Details about an application in a portal.

idstring uuid required

Contains a unique identifier used for this resource.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

namestring required

The name of the application.

descriptionstring nullable required

A description of the application.

labelsLabelsUpdate nullable required

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 "_".

client_idstring

The ID used to linked the portal application to an Identity Provider application.

registration_countnumber required

The number of API registrations that are associated with the application. Registrations of any status are included in the count.

granted_scopesstring[] nullable

List of granted scopes for the application. Null if application type does not support returning granted scopes.

Example response

{
  "id": "b15e2460-ba40-431d-9df0-4957fcffacda",
  "labels": {
    "env": "test"
  },
  "name": "App 1",
  "description": "An easy to manage app in a Konnect developer portal",
  "registration_count": 4,
  "portal": {
    "id": "95606071-49c7-4c2e-ae49-8a86d72a8110"
  },
  "auth_strategy": {
    "id": "45606071-49c7-4c2e-ae49-8a86d72a8110",
    "name": "API Key",
    "credential_type": "key_auth",
    "key_names": [
      "apikey"
    ]
  },
  "created_at": "2022-12-22T19:09:30.712Z",
  "updated_at": "2022-12-22T19:09:30.712Z",
  "owner": {
    "id": "8cd9feff-b4da-4a9f-ba49-cbe83c75ff22",
    "type": "developer"
  }
}

Changes

  • f530bf400198Revision changes
    • 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

  • 4a02153f2e60Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status