OAuth 2.0 Introspection

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "oauth2-introspection",
      "config": {
        "introspection_url": "'$INTROSPECTION_URL'",
        "authorization_value": "'$AUTHORIZATION_HEADER_VALUE'",
        "consumer_by": "client_id",
        "custom_claims_forward": [
          "'$CLAIM_NAME'"
        ]
      }
    }
    '

Make sure to replace the following placeholders with your own values:

• region: Geographic region where your Kong Konnect is hosted and operates.

• controlPlaneId: The id of the control plane.

• KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_oauth2_introspection" "my_oauth2_introspection" {
  enabled = true

  config = {
    introspection_url = var.introspection_url
    authorization_value = var.authorization_header_value
    consumer_by = "client_id"
    custom_claims_forward = [var.claim_name]
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}

This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.

variable "claim_name" {
  type = string
}

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/services/{serviceId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "oauth2-introspection",
      "config": {
        "introspection_url": "'$INTROSPECTION_URL'",
        "authorization_value": "'$AUTHORIZATION_HEADER_VALUE'",
        "consumer_by": "client_id",
        "custom_claims_forward": [
          "'$CLAIM_NAME'"
        ]
      }
    }
    '

Make sure to replace the following placeholders with your own values:

• region: Geographic region where your Kong Konnect is hosted and operates.

• controlPlaneId: The id of the control plane.

• KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.

• serviceId: The id of the service the plugin configuration will target.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_oauth2_introspection" "my_oauth2_introspection" {
  enabled = true

  config = {
    introspection_url = var.introspection_url
    authorization_value = var.authorization_header_value
    consumer_by = "client_id"
    custom_claims_forward = [var.claim_name]
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  service = {
    id = konnect_gateway_service.my_service.id
  }
}

This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.

variable "claim_name" {
  type = string
}

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/routes/{routeId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "oauth2-introspection",
      "config": {
        "introspection_url": "'$INTROSPECTION_URL'",
        "authorization_value": "'$AUTHORIZATION_HEADER_VALUE'",
        "consumer_by": "client_id",
        "custom_claims_forward": [
          "'$CLAIM_NAME'"
        ]
      }
    }
    '

Make sure to replace the following placeholders with your own values:

• region: Geographic region where your Kong Konnect is hosted and operates.

• controlPlaneId: The id of the control plane.

• KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.

• routeId: The id of the route the plugin configuration will target.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_oauth2_introspection" "my_oauth2_introspection" {
  enabled = true

  config = {
    introspection_url = var.introspection_url
    authorization_value = var.authorization_header_value
    consumer_by = "client_id"
    custom_claims_forward = [var.claim_name]
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  route = {
    id = konnect_gateway_route.my_route.id
  }
}

This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.

variable "claim_name" {
  type = string
}