Kong · Schema

CreateOAuthCredential

Payload used to create an `OAuth` credential for an integration instance.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
type string
config object
View JSON Schema on GitHub

JSON Schema

kong-createoauthcredential-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateOAuthCredential",
  "title": "CreateOAuthCredential",
  "description": "Payload used to create an `OAuth` credential for an integration instance.",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "const": "oauth"
    },
    "config": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "grant_type": {
          "description": "The OAuth 2.0 grant type used for authorization (e.g., `authorization_code`).",
          "type": "string",
          "enum": [
            "authorization_code"
          ]
        },
        "code": {
          "description": "The authorization code used to exchange for an access token with the identity server.",
          "type": "string",
          "example": "Yzk5ZDczMzRlNDEwY"
        },
        "redirect_uri": {
          "description": "The redirect URI submitted to the authorization server during the authentication request\nto retrieve the authorization code.\n",
          "type": "string",
          "format": "uri",
          "example": "https://cloud.konghq.com/us/service-catalog/integrations/pagerduty/oauth"
        }
      },
      "required": [
        "grant_type",
        "code",
        "redirect_uri"
      ],
      "title": "CreateOAuthCredentialConfig"
    }
  },
  "additionalProperties": false,
  "required": [
    "type",
    "config"
  ]
}