Refresh token grantv1.0+
Configure the OpenID Connect plugin to use the refresh token grant.
Here’s how refresh token grant auth works:
sequenceDiagram
autonumber
participant client as Client <br>(e.g. mobile app)
participant kong as Gateway
participant idp as IdP <br>(e.g. Keycloak)
participant httpbin as Upstream <br>(upstream service,<br> e.g. httpbin)
activate client
activate kong
client->>kong: Service with<br>refresh token
deactivate client
kong->>kong: load refresh token
activate idp
kong->>idp: IdP/token with<br>client credentials and<br>refresh token
deactivate kong
idp->>idp: authenticate client and<br>verify refresh token
activate kong
idp->>kong: return tokens
deactivate idp
kong->>kong: verify tokens
activate httpbin
kong->>httpbin: request with access token
httpbin->>kong: response
deactivate httpbin
activate client
kong->>client: response
deactivate kong
deactivate clientIn this example, the OpenID Connect plugin will only accept refresh tokens sent in a header,
but you can also set the refresh_token_param_type parameter to body, query, or any combination of these values.
For a complete example of authenticating with a refresh token using Keycloak, see the tutorial for configuring OpenID Connect with the refresh token grant.
Note: Setting
config.client_authtoclient_secret_postlets you test the connection to your IdP, but we recommend using a more secure auth method in production. You can use any of the supported client auth methods.
Prerequisites
- A configured identity provider (IdP)
Environment variables
-
ISSUER: The issuer authentication URL for your IdP. For example, if you’re using Keycloak as your IdP, the issuer URL looks like this:http://localhost:8080/realms/example-realm -
CLIENT_ID: The client ID that the plugin uses when it calls authenticated endpoints of the IdP. -
CLIENT_SECRET: The client secret needed to connect to your IdP. -
TOKEN_SALT: A random string that decK requires (v1.59 and later) so session credentials aren’t regenerated on every sync. This parameter is optional for other formats. For example, generate one withopenssl rand -base64 16.
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: openid-connect
config:
issuer: ${{ env "DECK_ISSUER" }}
client_id:
- ${{ env "DECK_CLIENT_ID" }}
client_secret:
- ${{ env "DECK_CLIENT_SECRET" }}
client_auth:
- client_secret_post
auth_methods:
- refresh_token
refresh_token_param_type:
- header
refresh_token_param_name: refresh_token
upstream_refresh_token_header: refresh_token
cache_tokens_salt: ${{ env "DECK_TOKEN_SALT" }}Make the following request:
curl -i -X POST http://localhost:8001/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "openid-connect",
"config": {
"issuer": "'$ISSUER'",
"client_id": [
"'$CLIENT_ID'"
],
"client_secret": [
"'$CLIENT_SECRET'"
],
"client_auth": [
"client_secret_post"
],
"auth_methods": [
"refresh_token"
],
"refresh_token_param_type": [
"header"
],
"refresh_token_param_name": "refresh_token",
"upstream_refresh_token_header": "refresh_token",
"cache_tokens_salt": "'$TOKEN_SALT'"
}
}
'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": "openid-connect",
"config": {
"issuer": "'$ISSUER'",
"client_id": [
"'$CLIENT_ID'"
],
"client_secret": [
"'$CLIENT_SECRET'"
],
"client_auth": [
"client_secret_post"
],
"auth_methods": [
"refresh_token"
],
"refresh_token_param_type": [
"header"
],
"refresh_token_param_name": "refresh_token",
"upstream_refresh_token_header": "refresh_token",
"cache_tokens_salt": "'$TOKEN_SALT'"
}
}
'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: openid-connect
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
labels:
global: 'true'
config:
issuer: '$ISSUER'
client_id:
- '$CLIENT_ID'
client_secret:
- '$CLIENT_SECRET'
client_auth:
- client_secret_post
auth_methods:
- refresh_token
refresh_token_param_type:
- header
refresh_token_param_name: refresh_token
upstream_refresh_token_header: refresh_token
cache_tokens_salt: '$TOKEN_SALT'
plugin: openid-connect
" | 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_openid_connect" "my_openid_connect" {
enabled = true
config = {
issuer = var.issuer
client_id = [var.client_id]
client_secret = [var.client_secret]
client_auth = ["client_secret_post"]
auth_methods = ["refresh_token"]
refresh_token_param_type = ["header"]
refresh_token_param_name = "refresh_token"
upstream_refresh_token_header = "refresh_token"
cache_tokens_salt = var.token_salt
}
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 "issuer" {
type = string
}
variable "client_id" {
type = string
}
variable "client_secret" {
type = string
}
variable "token_salt" {
type = string
}Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: openid-connect
service: serviceName|Id
config:
issuer: ${{ env "DECK_ISSUER" }}
client_id:
- ${{ env "DECK_CLIENT_ID" }}
client_secret:
- ${{ env "DECK_CLIENT_SECRET" }}
client_auth:
- client_secret_post
auth_methods:
- refresh_token
refresh_token_param_type:
- header
refresh_token_param_name: refresh_token
upstream_refresh_token_header: refresh_token
cache_tokens_salt: ${{ env "DECK_TOKEN_SALT" }}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": "openid-connect",
"config": {
"issuer": "'$ISSUER'",
"client_id": [
"'$CLIENT_ID'"
],
"client_secret": [
"'$CLIENT_SECRET'"
],
"client_auth": [
"client_secret_post"
],
"auth_methods": [
"refresh_token"
],
"refresh_token_param_type": [
"header"
],
"refresh_token_param_name": "refresh_token",
"upstream_refresh_token_header": "refresh_token",
"cache_tokens_salt": "'$TOKEN_SALT'"
}
}
'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": "openid-connect",
"config": {
"issuer": "'$ISSUER'",
"client_id": [
"'$CLIENT_ID'"
],
"client_secret": [
"'$CLIENT_SECRET'"
],
"client_auth": [
"client_secret_post"
],
"auth_methods": [
"refresh_token"
],
"refresh_token_param_type": [
"header"
],
"refresh_token_param_name": "refresh_token",
"upstream_refresh_token_header": "refresh_token",
"cache_tokens_salt": "'$TOKEN_SALT'"
}
}
'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: openid-connect
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
config:
issuer: '$ISSUER'
client_id:
- '$CLIENT_ID'
client_secret:
- '$CLIENT_SECRET'
client_auth:
- client_secret_post
auth_methods:
- refresh_token
refresh_token_param_type:
- header
refresh_token_param_name: refresh_token
upstream_refresh_token_header: refresh_token
cache_tokens_salt: '$TOKEN_SALT'
plugin: openid-connect
" | kubectl apply -f -Next, apply the KongPlugin resource by annotating the service resource:
kubectl annotate -n kong service SERVICE_NAME konghq.com/plugins=openid-connectPrerequisite: 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_openid_connect" "my_openid_connect" {
enabled = true
config = {
issuer = var.issuer
client_id = [var.client_id]
client_secret = [var.client_secret]
client_auth = ["client_secret_post"]
auth_methods = ["refresh_token"]
refresh_token_param_type = ["header"]
refresh_token_param_name = "refresh_token"
upstream_refresh_token_header = "refresh_token"
cache_tokens_salt = var.token_salt
}
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 "issuer" {
type = string
}
variable "client_id" {
type = string
}
variable "client_secret" {
type = string
}
variable "token_salt" {
type = string
}Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: openid-connect
route: routeName|Id
config:
issuer: ${{ env "DECK_ISSUER" }}
client_id:
- ${{ env "DECK_CLIENT_ID" }}
client_secret:
- ${{ env "DECK_CLIENT_SECRET" }}
client_auth:
- client_secret_post
auth_methods:
- refresh_token
refresh_token_param_type:
- header
refresh_token_param_name: refresh_token
upstream_refresh_token_header: refresh_token
cache_tokens_salt: ${{ env "DECK_TOKEN_SALT" }}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": "openid-connect",
"config": {
"issuer": "'$ISSUER'",
"client_id": [
"'$CLIENT_ID'"
],
"client_secret": [
"'$CLIENT_SECRET'"
],
"client_auth": [
"client_secret_post"
],
"auth_methods": [
"refresh_token"
],
"refresh_token_param_type": [
"header"
],
"refresh_token_param_name": "refresh_token",
"upstream_refresh_token_header": "refresh_token",
"cache_tokens_salt": "'$TOKEN_SALT'"
}
}
'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": "openid-connect",
"config": {
"issuer": "'$ISSUER'",
"client_id": [
"'$CLIENT_ID'"
],
"client_secret": [
"'$CLIENT_SECRET'"
],
"client_auth": [
"client_secret_post"
],
"auth_methods": [
"refresh_token"
],
"refresh_token_param_type": [
"header"
],
"refresh_token_param_name": "refresh_token",
"upstream_refresh_token_header": "refresh_token",
"cache_tokens_salt": "'$TOKEN_SALT'"
}
}
'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: openid-connect
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
config:
issuer: '$ISSUER'
client_id:
- '$CLIENT_ID'
client_secret:
- '$CLIENT_SECRET'
client_auth:
- client_secret_post
auth_methods:
- refresh_token
refresh_token_param_type:
- header
refresh_token_param_name: refresh_token
upstream_refresh_token_header: refresh_token
cache_tokens_salt: '$TOKEN_SALT'
plugin: openid-connect
" | kubectl apply -f -Next, apply the KongPlugin resource by annotating the httproute or ingress resource:
kubectl annotate -n kong httproute konghq.com/plugins=openid-connectkubectl annotate -n kong ingress konghq.com/plugins=openid-connectPrerequisite: 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_openid_connect" "my_openid_connect" {
enabled = true
config = {
issuer = var.issuer
client_id = [var.client_id]
client_secret = [var.client_secret]
client_auth = ["client_secret_post"]
auth_methods = ["refresh_token"]
refresh_token_param_type = ["header"]
refresh_token_param_name = "refresh_token"
upstream_refresh_token_header = "refresh_token"
cache_tokens_salt = var.token_salt
}
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 "issuer" {
type = string
}
variable "client_id" {
type = string
}
variable "client_secret" {
type = string
}
variable "token_salt" {
type = string
}