Kong · Schema

OAuth Config

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
type	string
client_id	string	The OAuth client identifier.
client_secret	string	The OAuth client secret.
authorization_endpoint	string	The URL where users are redirected to authorize access.
token_endpoint	string	The URL used to retrieve access tokens.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpsertOAuthAuthConfig",
  "title": "OAuth Config",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "const": "oauth"
    },
    "client_id": {
      "description": "The OAuth client identifier.",
      "type": "string",
      "example": "d745213a-b7e8-4998-abe3-41f164001970"
    },
    "client_secret": {
      "description": "The OAuth client secret.",
      "type": "string",
      "example": "s3cr3t4p1cl13ntt0k3n1234567890abcdef",
      "writeOnly": true
    },
    "authorization_endpoint": {
      "description": "The URL where users are redirected to authorize access.",
      "type": "string",
      "format": "uri",
      "example": "https://identity.service.com/oauth/authorize"
    },
    "token_endpoint": {
      "description": "The URL used to retrieve access tokens.",
      "type": "string",
      "format": "uri",
      "example": "https://identity.service.com/oauth/token"
    }
  },
  "additionalProperties": false,
  "required": [
    "type",
    "client_id",
    "client_secret",
    "authorization_endpoint",
    "token_endpoint"
  ],
  "x-speakeasy-name-override": "oauth_config"
}