OAuth 2.0 Authentication Configuration Examples

Make the following request:

curl -X POST http://localhost:8001/services/SERVICE_NAME|SERVICE_ID/plugins \
    --data "name=oauth2"  \
    --data "config.scopes=email"  \
    --data "config.scopes=phone"  \
    --data "config.scopes=address"  \
    --data "config.mandatory_scope=true"  \
    --data "config.provision_key=<autogenerated>"  \
    --data "config.enable_authorization_code=true"

Replace SERVICE_NAME|SERVICE_ID with the id or name of the service that this plugin configuration will target.

First, create a KongPlugin resource:

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: oauth2-example
plugin: oauth2
config:
  scopes:
  - email
  - phone
  - address
  mandatory_scope: true
  provision_key: "<autogenerated>"
  enable_authorization_code: true
" | kubectl apply -f -

Next, apply the KongPlugin resource to an ingress by annotating the service as follows:

kubectl annotate service SERVICE_NAME konghq.com/plugins=oauth2-example

Replace SERVICE_NAME with the name of the service that this plugin configuration will target. You can see your available ingresses by running kubectl get service.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Make the following request:

curl -X POST http://localhost:8001/routes/ROUTE_NAME|ROUTE_ID/plugins \
    --data "name=oauth2"  \
    --data "config.scopes=email"  \
    --data "config.scopes=phone"  \
    --data "config.scopes=address"  \
    --data "config.mandatory_scope=true"  \
    --data "config.provision_key=<autogenerated>"  \
    --data "config.enable_authorization_code=true"

Replace ROUTE_NAME|ROUTE_ID with the id or name of the route that this plugin configuration will target.

First, create a KongPlugin resource:

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: oauth2-example
plugin: oauth2
config:
  scopes:
  - email
  - phone
  - address
  mandatory_scope: true
  provision_key: "<autogenerated>"
  enable_authorization_code: true
" | kubectl apply -f -

Next, apply the KongPlugin resource to an ingress by annotating the ingress as follows:

kubectl annotate ingress INGRESS_NAME konghq.com/plugins=oauth2-example

Replace INGRESS_NAME with the name of the ingress that this plugin configuration will target. You can see your available ingresses by running kubectl get ingress.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Make the following request:

curl -X POST http://localhost:8001/plugins/ \
    --data "name=oauth2"  \
    --data "config.scopes=email"  \
    --data "config.scopes=phone"  \
    --data "config.scopes=address"  \
    --data "config.mandatory_scope=true"  \
    --data "config.provision_key=<autogenerated>"  \
    --data "config.enable_authorization_code=true"

Create a KongClusterPlugin resource and label it as global:

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-oauth2>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: "true"
config:
  scopes:
  - email
  - phone
  - address
  mandatory_scope: true
  provision_key: "<autogenerated>"
  enable_authorization_code: true
plugin: oauth2