Kong · Schema

Client Credentials 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.
labels object
client_id string The ID used to linked the portal application to an Identity Provider application.
registration_count number The number of API registrations that are associated with the application. Registrations of any status are included in the count.
dcr_provider object Information about the DCR provider this application uses, if using DCR.
portal object Information about the portal the application is in.
auth_strategy object
granted_scopes array List of granted scopes for the application. Null if application type does not support returning granted scopes.
owner object
View JSON Schema on GitHub

JSON Schema

kong-clientcredentialsapplication-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ClientCredentialsApplication",
  "title": "Client Credentials 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
    },
    "labels": {
      "$ref": "#/components/schemas/LabelsUpdate"
    },
    "client_id": {
      "description": "The ID used to linked the portal application to an Identity Provider application.",
      "type": "string",
      "readOnly": true
    },
    "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
    },
    "dcr_provider": {
      "description": "Information about the DCR provider this application uses, if using DCR.",
      "type": "object",
      "additionalProperties": false,
      "nullable": true,
      "properties": {
        "id": {
          "$ref": "#/components/schemas/UUID"
        }
      },
      "required": [
        "id"
      ]
    },
    "portal": {
      "description": "Information about the portal the application is in.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "$ref": "#/components/schemas/UUID"
        }
      },
      "required": [
        "id"
      ]
    },
    "auth_strategy": {
      "$ref": "#/components/schemas/AuthStrategyClientCredentials"
    },
    "granted_scopes": {
      "description": "List of granted scopes for the application. Null if application type does not support returning granted scopes.",
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "owner": {
      "$ref": "#/components/schemas/ApplicationOwner"
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "created_at",
    "updated_at",
    "name",
    "description",
    "registration_count",
    "client_id",
    "auth_strategy",
    "dcr_provider",
    "portal",
    "labels",
    "granted_scopes"
  ]
}