Kong · Schema

Key Auth Application

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
id object
created_at object
updated_at object
name string The name of the application.
description string A description of the application.
auth_strategy object
portal object Information about the portal the application is in.
labels object
registration_count number The number of API registrations that are associated with the application. Registrations of any status are included in the count.
owner object
View JSON Schema on GitHub

JSON Schema

kong-keyauthapplication-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/KeyAuthApplication",
  "title": "Key Auth Application",
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/components/schemas/UUID"
    },
    "created_at": {
      "$ref": "#/components/schemas/CreatedAt"
    },
    "updated_at": {
      "$ref": "#/components/schemas/UpdatedAt"
    },
    "name": {
      "description": "The name of the application.",
      "type": "string"
    },
    "description": {
      "description": "A description of the application.",
      "type": "string",
      "nullable": true
    },
    "auth_strategy": {
      "$ref": "#/components/schemas/AuthStrategyKeyAuth"
    },
    "portal": {
      "description": "Information about the portal the application is in.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "$ref": "#/components/schemas/UUID"
        }
      },
      "required": [
        "id"
      ]
    },
    "labels": {
      "$ref": "#/components/schemas/LabelsUpdate"
    },
    "registration_count": {
      "description": "The number of API registrations that are associated with the application. Registrations of any status are included in the count.",
      "type": "number",
      "readOnly": true
    },
    "owner": {
      "$ref": "#/components/schemas/ApplicationOwner"
    }
  },
  "example": {
    "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"
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "created_at",
    "updated_at",
    "name",
    "description",
    "auth_strategy",
    "portal",
    "registration_count",
    "labels"
  ]
}