Kong · Schema

AppAuthStrategyOpenIDConnectResponse

Response payload from creating an OIDC Application Auth Strategy

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
id object
name object
display_name object
strategy_type string
configs object JSON-B object containing the configuration for the OIDC strategy
active boolean At least one published entity is using this auth strategy.
dcr_provider object
labels object
created_at object
updated_at object
supports_multiple_credentials boolean Indicates whether this auth strategy supports multiple credentials. - `true` for Key Auth strategies and when supported for Client Credentials strategies - `false` when not supported for Client Creden
View JSON Schema on GitHub

JSON Schema

kong-appauthstrategyopenidconnectresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AppAuthStrategyOpenIDConnectResponse",
  "title": "AppAuthStrategyOpenIDConnectResponse",
  "description": "Response payload from creating an OIDC Application Auth Strategy",
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/components/schemas/UUID"
    },
    "name": {
      "$ref": "#/components/schemas/AuthStrategyName"
    },
    "display_name": {
      "$ref": "#/components/schemas/AuthStrategyDisplayName"
    },
    "strategy_type": {
      "type": "string",
      "enum": [
        "openid_connect"
      ]
    },
    "configs": {
      "description": "JSON-B object containing the configuration for the OIDC strategy",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "openid-connect": {
          "$ref": "#/components/schemas/AppAuthStrategyConfigOpenIDConnect"
        }
      },
      "required": [
        "openid-connect"
      ]
    },
    "active": {
      "description": "At least one published entity is using this auth strategy.",
      "type": "boolean"
    },
    "dcr_provider": {
      "type": "object",
      "additionalProperties": false,
      "nullable": true,
      "properties": {
        "id": {
          "$ref": "#/components/schemas/UUID"
        },
        "name": {
          "type": "string"
        },
        "display_name": {
          "$ref": "#/components/schemas/DcrProviderDisplayName"
        },
        "provider_type": {
          "description": "The type of DCR provider.",
          "type": "string",
          "enum": [
            "auth0",
            "azureAd",
            "curity",
            "okta",
            "http"
          ],
          "x-speakeasy-unknown-values": "allow"
        }
      },
      "required": [
        "id",
        "name",
        "provider_type"
      ]
    },
    "labels": {
      "$ref": "#/components/schemas/Labels"
    },
    "created_at": {
      "$ref": "#/components/schemas/CreatedAt"
    },
    "updated_at": {
      "$ref": "#/components/schemas/UpdatedAt"
    },
    "supports_multiple_credentials": {
      "description": "Indicates whether this auth strategy supports multiple credentials.\n- `true` for Key Auth strategies and when supported for Client Credentials strategies\n- `false` when not supported for Client Credentials strategies\n",
      "type": "boolean",
      "readOnly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "name",
    "display_name",
    "strategy_type",
    "configs",
    "active",
    "dcr_provider",
    "labels",
    "created_at",
    "updated_at"
  ]
}