Inspect query string parametersv1.0+
This configuration lists query string parameters that Kong Gateway will inspect to retrieve JWTs.
The JWT plugin needs a Consumer with a credential attached before it can authenticate requests.
The following creates the Consumer and attaches the credential in one document:
_format_version: "3.0"
consumers:
- username: alex
jwt_secrets:
- key: hello_world
algorithm: HS256
secret: hello_world_secretThe JWT plugin needs a Consumer with a credential attached before it can authenticate requests.
Create the Consumer:
curl -i -X POST http://localhost:8001/consumers/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"username": "alex"
}
'Attach the jwt credential:
curl -i -X POST http://localhost:8001/consumers/alex/jwt \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"key": "hello_world",
"algorithm": "HS256",
"secret": "hello_world_secret"
}
'The JWT plugin needs a Consumer with a credential attached before it can authenticate requests.
Create the Consumer:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumers/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"username": "alex"
}
'Attach the jwt credential:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumers/alex/jwt \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"key": "hello_world",
"algorithm": "HS256",
"secret": "hello_world_secret"
}
'Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId: Theidof the control plane.
See the Konnect Control Planes Config API reference to learn about region-specific URLs and personal access tokens.
The JWT plugin needs a Consumer with a credential attached before it can authenticate requests.
Create a Secret labeled with the jwt credential type:
apiVersion: v1
kind: Secret
metadata:
name: alex-jwt
namespace: kong
labels:
konghq.com/credential: jwt
stringData:
key: hello_world
algorithm: HS256
secret: hello_world_secretCreate the KongConsumer and reference the Secret:
apiVersion: configuration.konghq.com/v1
kind: KongConsumer
metadata:
name: alex
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
username: alex
credentials:
- alex-jwtThe JWT plugin needs a Consumer with a credential attached before it can authenticate requests.
Add the following to your Terraform configuration to create the Consumer and the credential:
resource "konnect_gateway_consumer" "my_consumer" {
username = "alex"
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}
resource "konnect_gateway_jwt" "my_jwt" {
consumer_id = konnect_gateway_consumer.my_consumer.id
key = "hello_world"
algorithm = "HS256"
secret = "hello_world_secret"
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: jwt
config:
uri_param_names:
- paramName_2.2.xMake the following request:
curl -i -X POST http://localhost:8001/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "jwt",
"config": {
"uri_param_names": [
"paramName_2.2.x"
]
}
}
'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": "jwt",
"config": {
"uri_param_names": [
"paramName_2.2.x"
]
}
}
'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 Control Planes Config API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
name: jwt
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
labels:
global: 'true'
config:
uri_param_names:
- paramName_2.2.x
plugin: jwt
" | 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_jwt" "my_jwt" {
enabled = true
config = {
uri_param_names = ["paramName_2.2.x"]
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: jwt
service: serviceName|Id
config:
uri_param_names:
- paramName_2.2.xMake 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 -i -X POST http://localhost:8001/services/{serviceName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "jwt",
"config": {
"uri_param_names": [
"paramName_2.2.x"
]
}
}
'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": "jwt",
"config": {
"uri_param_names": [
"paramName_2.2.x"
]
}
}
'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 Control Planes Config API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: jwt
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
config:
uri_param_names:
- paramName_2.2.x
plugin: jwt
" | kubectl apply -f -Next, apply the KongPlugin resource by annotating the service resource:
kubectl annotate -n kong service SERVICE_NAME konghq.com/plugins=jwtPrerequisite: 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_jwt" "my_jwt" {
enabled = true
config = {
uri_param_names = ["paramName_2.2.x"]
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
service = {
id = konnect_gateway_service.my_service.id
}
}Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: jwt
route: routeName|Id
config:
uri_param_names:
- paramName_2.2.xMake 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 -i -X POST http://localhost:8001/routes/{routeName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "jwt",
"config": {
"uri_param_names": [
"paramName_2.2.x"
]
}
}
'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": "jwt",
"config": {
"uri_param_names": [
"paramName_2.2.x"
]
}
}
'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 Control Planes Config API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: jwt
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
config:
uri_param_names:
- paramName_2.2.x
plugin: jwt
" | kubectl apply -f -Next, apply the KongPlugin resource by annotating the httproute or ingress resource:
kubectl annotate -n kong httproute konghq.com/plugins=jwtkubectl annotate -n kong ingress konghq.com/plugins=jwtPrerequisite: 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_jwt" "my_jwt" {
enabled = true
config = {
uri_param_names = ["paramName_2.2.x"]
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
route = {
id = konnect_gateway_route.my_route.id
}
}