Authenticate principalsv3.15+
You can authenticate principals managed by Kong Identity in Konnect by configuring the principals field in the Key Auth plugin. Principals are grouped into regional directories.
For a full tutorial of this example, see Authenticate Principals with the Key Authentication plugin.
Prerequisites
- A Kong Identity directory that contains principals in Konnect
Environment variables
-
DIRECTORY_NAME: The name of the Kong Identity directory to look up principals in.
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: key-auth
config:
key_names:
- apikey
identity_realms: []
principals:
enabled: true
directory: ${{ env "DECK_DIRECTORY_NAME" }}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": "key-auth",
"config": {
"key_names": [
"apikey"
],
"identity_realms": [],
"principals": {
"enabled": true,
"directory": "'$DIRECTORY_NAME'"
}
},
"tags": []
}
'Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
controlPlaneId: Theidof the control plane.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
name: key-auth
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
labels:
global: 'true'
config:
key_names:
- apikey
identity_realms: []
principals:
enabled: true
directory: '$DIRECTORY_NAME'
plugin: key-auth
" | kubectl apply -f -Prerequisite: Configure your Personal Access Token
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_key_auth" "my_key_auth" {
enabled = true
config = {
key_names = ["apikey"]
identity_realms = []
principals = {
enabled = true
directory = var.directory_name
}
}
tags = []
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 "directory_name" {
type = string
}Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: key-auth
service: serviceName|Id
config:
key_names:
- apikey
identity_realms: []
principals:
enabled: true
directory: ${{ env "DECK_DIRECTORY_NAME" }}Make sure to replace the following placeholders with your own values:
-
serviceName|Id: Theidornameof the service the plugin configuration will target.
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": "key-auth",
"config": {
"key_names": [
"apikey"
],
"identity_realms": [],
"principals": {
"enabled": true,
"directory": "'$DIRECTORY_NAME'"
}
},
"tags": []
}
'Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
controlPlaneId: Theidof the control plane. -
serviceId: Theidof the service the plugin configuration will target.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: key-auth
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
key_names:
- apikey
identity_realms: []
principals:
enabled: true
directory: '$DIRECTORY_NAME'
plugin: key-auth
" | kubectl apply -f -Next, apply the KongPlugin resource by annotating the service resource:
kubectl annotate -n kong service SERVICE_NAME konghq.com/plugins=key-authPrerequisite: Configure your Personal Access Token
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_key_auth" "my_key_auth" {
enabled = true
config = {
key_names = ["apikey"]
identity_realms = []
principals = {
enabled = true
directory = var.directory_name
}
}
tags = []
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 "directory_name" {
type = string
}Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: key-auth
route: routeName|Id
config:
key_names:
- apikey
identity_realms: []
principals:
enabled: true
directory: ${{ env "DECK_DIRECTORY_NAME" }}Make sure to replace the following placeholders with your own values:
-
routeName|Id: Theidornameof the route the plugin configuration will target.
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": "key-auth",
"config": {
"key_names": [
"apikey"
],
"identity_realms": [],
"principals": {
"enabled": true,
"directory": "'$DIRECTORY_NAME'"
}
},
"tags": []
}
'Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
controlPlaneId: Theidof the control plane. -
routeId: Theidof the route the plugin configuration will target.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: key-auth
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
key_names:
- apikey
identity_realms: []
principals:
enabled: true
directory: '$DIRECTORY_NAME'
plugin: key-auth
" | kubectl apply -f -Next, apply the KongPlugin resource by annotating the httproute or ingress resource:
kubectl annotate -n kong httproute konghq.com/plugins=key-authkubectl annotate -n kong ingress konghq.com/plugins=key-authPrerequisite: Configure your Personal Access Token
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_key_auth" "my_key_auth" {
enabled = true
config = {
key_names = ["apikey"]
identity_realms = []
principals = {
enabled = true
directory = var.directory_name
}
}
tags = []
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 "directory_name" {
type = string
}