Use a custom access token headerv3.8+
Configure the Upstream OAuth plugin with a custom header to use when sending the access token (obtained from the IdP) to the upstream service. For a complete tutorial, see Configure the Upstream OAuth plugin with Kong Identity.
Prerequisites
- You have an IdP configured.
Environment variables
-
CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_ID: The client ID for the application registration in the IdP. -
CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_SECRET: The client secret for the application registration in the IdP.
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: upstream-oauth
config:
oauth:
token_endpoint: https://example.com/oauth2/token
grant_type: client_credentials
client_id: ${{ env "DECK_CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_ID" }}
client_secret: ${{ env "DECK_CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_SECRET"
}}
scopes:
- openid
- profile
behavior:
upstream_access_token_header_name: X-Custom-Auth
Make the following request:
curl -i -X POST http://localhost:8001/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "upstream-oauth",
"config": {
"oauth": {
"token_endpoint": "https://example.com/oauth2/token",
"grant_type": "client_credentials",
"client_id": "'$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_ID'",
"client_secret": "'$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_SECRET'",
"scopes": [
"openid",
"profile"
]
},
"behavior": {
"upstream_access_token_header_name": "X-Custom-Auth"
}
},
"tags": []
}
'
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": "upstream-oauth",
"config": {
"oauth": {
"token_endpoint": "https://example.com/oauth2/token",
"grant_type": "client_credentials",
"client_id": "'$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_ID'",
"client_secret": "'$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_SECRET'",
"scopes": [
"openid",
"profile"
]
},
"behavior": {
"upstream_access_token_header_name": "X-Custom-Auth"
}
},
"tags": []
}
'
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. -
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.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
name: upstream-oauth
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
labels:
global: 'true'
config:
oauth:
token_endpoint: https://example.com/oauth2/token
grant_type: client_credentials
client_id: '$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_ID'
client_secret: '$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_SECRET'
scopes:
- openid
- profile
behavior:
upstream_access_token_header_name: X-Custom-Auth
plugin: upstream-oauth
" | 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_upstream_oauth" "my_upstream_oauth" {
enabled = true
config = {
oauth = {
token_endpoint = "https://example.com/oauth2/token"
grant_type = "client_credentials"
client_id = var.client_credentials_grant_post_auth_client_id
client_secret = var.client_credentials_grant_post_auth_client_secret
scopes = ["openid", "profile"]
}
behavior = {
upstream_access_token_header_name = "X-Custom-Auth"
}
}
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 "client_credentials_grant_post_auth_client_secret" {
type = string
}
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: upstream-oauth
service: serviceName|Id
config:
oauth:
token_endpoint: https://example.com/oauth2/token
grant_type: client_credentials
client_id: ${{ env "DECK_CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_ID" }}
client_secret: ${{ env "DECK_CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_SECRET"
}}
scopes:
- openid
- profile
behavior:
upstream_access_token_header_name: X-Custom-Auth
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 -i -X POST http://localhost:8001/services/{serviceName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "upstream-oauth",
"config": {
"oauth": {
"token_endpoint": "https://example.com/oauth2/token",
"grant_type": "client_credentials",
"client_id": "'$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_ID'",
"client_secret": "'$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_SECRET'",
"scopes": [
"openid",
"profile"
]
},
"behavior": {
"upstream_access_token_header_name": "X-Custom-Auth"
}
},
"tags": []
}
'
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": "upstream-oauth",
"config": {
"oauth": {
"token_endpoint": "https://example.com/oauth2/token",
"grant_type": "client_credentials",
"client_id": "'$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_ID'",
"client_secret": "'$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_SECRET'",
"scopes": [
"openid",
"profile"
]
},
"behavior": {
"upstream_access_token_header_name": "X-Custom-Auth"
}
},
"tags": []
}
'
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. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
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: upstream-oauth
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
oauth:
token_endpoint: https://example.com/oauth2/token
grant_type: client_credentials
client_id: '$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_ID'
client_secret: '$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_SECRET'
scopes:
- openid
- profile
behavior:
upstream_access_token_header_name: X-Custom-Auth
plugin: upstream-oauth
" | kubectl apply -f -
Next, apply the KongPlugin resource by annotating the service resource:
kubectl annotate -n kong service SERVICE_NAME konghq.com/plugins=upstream-oauth
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_upstream_oauth" "my_upstream_oauth" {
enabled = true
config = {
oauth = {
token_endpoint = "https://example.com/oauth2/token"
grant_type = "client_credentials"
client_id = var.client_credentials_grant_post_auth_client_id
client_secret = var.client_credentials_grant_post_auth_client_secret
scopes = ["openid", "profile"]
}
behavior = {
upstream_access_token_header_name = "X-Custom-Auth"
}
}
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 "client_credentials_grant_post_auth_client_secret" {
type = string
}
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: upstream-oauth
route: routeName|Id
config:
oauth:
token_endpoint: https://example.com/oauth2/token
grant_type: client_credentials
client_id: ${{ env "DECK_CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_ID" }}
client_secret: ${{ env "DECK_CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_SECRET"
}}
scopes:
- openid
- profile
behavior:
upstream_access_token_header_name: X-Custom-Auth
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 -i -X POST http://localhost:8001/routes/{routeName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "upstream-oauth",
"config": {
"oauth": {
"token_endpoint": "https://example.com/oauth2/token",
"grant_type": "client_credentials",
"client_id": "'$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_ID'",
"client_secret": "'$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_SECRET'",
"scopes": [
"openid",
"profile"
]
},
"behavior": {
"upstream_access_token_header_name": "X-Custom-Auth"
}
},
"tags": []
}
'
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": "upstream-oauth",
"config": {
"oauth": {
"token_endpoint": "https://example.com/oauth2/token",
"grant_type": "client_credentials",
"client_id": "'$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_ID'",
"client_secret": "'$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_SECRET'",
"scopes": [
"openid",
"profile"
]
},
"behavior": {
"upstream_access_token_header_name": "X-Custom-Auth"
}
},
"tags": []
}
'
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. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
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: upstream-oauth
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
oauth:
token_endpoint: https://example.com/oauth2/token
grant_type: client_credentials
client_id: '$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_ID'
client_secret: '$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_SECRET'
scopes:
- openid
- profile
behavior:
upstream_access_token_header_name: X-Custom-Auth
plugin: upstream-oauth
" | kubectl apply -f -
Next, apply the KongPlugin resource by annotating the httproute or ingress resource:
kubectl annotate -n kong httproute konghq.com/plugins=upstream-oauth
kubectl annotate -n kong ingress konghq.com/plugins=upstream-oauth
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_upstream_oauth" "my_upstream_oauth" {
enabled = true
config = {
oauth = {
token_endpoint = "https://example.com/oauth2/token"
grant_type = "client_credentials"
client_id = var.client_credentials_grant_post_auth_client_id
client_secret = var.client_credentials_grant_post_auth_client_secret
scopes = ["openid", "profile"]
}
behavior = {
upstream_access_token_header_name = "X-Custom-Auth"
}
}
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 "client_credentials_grant_post_auth_client_secret" {
type = string
}
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: upstream-oauth
consumer: consumerName|Id
config:
oauth:
token_endpoint: https://example.com/oauth2/token
grant_type: client_credentials
client_id: ${{ env "DECK_CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_ID" }}
client_secret: ${{ env "DECK_CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_SECRET"
}}
scopes:
- openid
- profile
behavior:
upstream_access_token_header_name: X-Custom-Auth
Make sure to replace the following placeholders with your own values:
-
consumerName|Id: Theidornameof the consumer the plugin configuration will target.
Make the following request:
curl -i -X POST http://localhost:8001/consumers/{consumerName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "upstream-oauth",
"config": {
"oauth": {
"token_endpoint": "https://example.com/oauth2/token",
"grant_type": "client_credentials",
"client_id": "'$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_ID'",
"client_secret": "'$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_SECRET'",
"scopes": [
"openid",
"profile"
]
},
"behavior": {
"upstream_access_token_header_name": "X-Custom-Auth"
}
},
"tags": []
}
'
Make sure to replace the following placeholders with your own values:
-
consumerName|Id: Theidornameof the consumer the plugin configuration will target.
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumers/{consumerId}/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "upstream-oauth",
"config": {
"oauth": {
"token_endpoint": "https://example.com/oauth2/token",
"grant_type": "client_credentials",
"client_id": "'$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_ID'",
"client_secret": "'$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_SECRET'",
"scopes": [
"openid",
"profile"
]
},
"behavior": {
"upstream_access_token_header_name": "X-Custom-Auth"
}
},
"tags": []
}
'
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. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
consumerId: Theidof the consumer 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: upstream-oauth
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
oauth:
token_endpoint: https://example.com/oauth2/token
grant_type: client_credentials
client_id: '$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_ID'
client_secret: '$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_SECRET'
scopes:
- openid
- profile
behavior:
upstream_access_token_header_name: X-Custom-Auth
plugin: upstream-oauth
" | kubectl apply -f -
Next, apply the KongPlugin resource by annotating the KongConsumer resource:
kubectl annotate -n kong CONSUMER_NAME konghq.com/plugins=upstream-oauth
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_upstream_oauth" "my_upstream_oauth" {
enabled = true
config = {
oauth = {
token_endpoint = "https://example.com/oauth2/token"
grant_type = "client_credentials"
client_id = var.client_credentials_grant_post_auth_client_id
client_secret = var.client_credentials_grant_post_auth_client_secret
scopes = ["openid", "profile"]
}
behavior = {
upstream_access_token_header_name = "X-Custom-Auth"
}
}
tags = []
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
consumer = {
id = konnect_gateway_consumer.my_consumer.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 "client_credentials_grant_post_auth_client_secret" {
type = string
}
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: upstream-oauth
consumer_group: consumerGroupName|Id
config:
oauth:
token_endpoint: https://example.com/oauth2/token
grant_type: client_credentials
client_id: ${{ env "DECK_CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_ID" }}
client_secret: ${{ env "DECK_CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_SECRET"
}}
scopes:
- openid
- profile
behavior:
upstream_access_token_header_name: X-Custom-Auth
Make sure to replace the following placeholders with your own values:
-
consumerGroupName|Id: Theidornameof the consumer group the plugin configuration will target.
Make the following request:
curl -i -X POST http://localhost:8001/consumer_groups/{consumerGroupName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "upstream-oauth",
"config": {
"oauth": {
"token_endpoint": "https://example.com/oauth2/token",
"grant_type": "client_credentials",
"client_id": "'$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_ID'",
"client_secret": "'$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_SECRET'",
"scopes": [
"openid",
"profile"
]
},
"behavior": {
"upstream_access_token_header_name": "X-Custom-Auth"
}
},
"tags": []
}
'
Make sure to replace the following placeholders with your own values:
-
consumerGroupName|Id: Theidornameof the consumer group the plugin configuration will target.
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{consumerGroupId}/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "upstream-oauth",
"config": {
"oauth": {
"token_endpoint": "https://example.com/oauth2/token",
"grant_type": "client_credentials",
"client_id": "'$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_ID'",
"client_secret": "'$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_SECRET'",
"scopes": [
"openid",
"profile"
]
},
"behavior": {
"upstream_access_token_header_name": "X-Custom-Auth"
}
},
"tags": []
}
'
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. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
consumerGroupId: Theidof the consumer group 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: upstream-oauth
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
oauth:
token_endpoint: https://example.com/oauth2/token
grant_type: client_credentials
client_id: '$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_ID'
client_secret: '$CLIENT_CREDENTIALS_GRANT_POST_AUTH_CLIENT_SECRET'
scopes:
- openid
- profile
behavior:
upstream_access_token_header_name: X-Custom-Auth
plugin: upstream-oauth
" | kubectl apply -f -
Next, apply the KongPlugin resource by annotating the KongConsumerGroup resource:
kubectl annotate -n kong CONSUMERGROUP_NAME konghq.com/plugins=upstream-oauth
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_upstream_oauth" "my_upstream_oauth" {
enabled = true
config = {
oauth = {
token_endpoint = "https://example.com/oauth2/token"
grant_type = "client_credentials"
client_id = var.client_credentials_grant_post_auth_client_id
client_secret = var.client_credentials_grant_post_auth_client_secret
scopes = ["openid", "profile"]
}
behavior = {
upstream_access_token_header_name = "X-Custom-Auth"
}
}
tags = []
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
consumer_group = {
id = konnect_gateway_consumer_group.my_consumer_group.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 "client_credentials_grant_post_auth_client_secret" {
type = string
}