Skip to content
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
    • Kong Konnect
    • Kong Mesh
    • Plugin Hub
    • decK
    • Kubernetes Ingress Controller
    • Insomnia
    • Kuma

    • Docs contribution guidelines
  • Plugin Hub
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kubernetes Ingress Controller
  • Insomnia
  • Kuma

  • Docs contribution guidelines
  • 3.2.x (latest)
  • 3.1.x
  • 3.0.x
  • 2.8.x
  • 2.7.x
  • 2.6.x
  • Older Enterprise versions (2.1-2.5)
  • Older OSS versions (2.1-2.5)
  • Archive (pre-2.1)
    • Overview of Kong Gateway
      • Version Support Policy
      • Supported Installation Options
      • Supported Linux Distributions
    • Stability
    • Release Notes
      • Services
        • Overview
        • Configure Routes with Expressions
      • Upstreams
      • Plugins
      • Routing Traffic
      • Load Balancing
      • Health Checks and Circuit Breakers
      • Kong Performance Testing
    • Glossary
    • Get Kong
    • Services and Routes
    • Rate Limiting
    • Proxy Caching
    • Key Authentication
    • Load-Balancing
      • Overview
        • Overview
        • Deploy Kong Gateway in Hybrid mode
      • DB-less Deployment
      • Traditional
      • Overview
        • Helm
        • OpenShift with Helm
        • kubectl apply
        • Kubernetes Deployment Options
        • Using docker run
        • Build your own Docker images
        • Amazon Linux
        • Debian
        • Red Hat
        • Ubuntu
      • Running Kong as a non-root user
      • Securing the Admin API
      • Using systemd
      • Start Kong Gateway Securely
      • Programatically Creating Admins
      • Enabling RBAC
      • Overview
      • Download your License
      • Deploy Enterprise License
      • Using the License API
      • Monitor Licenses Usage
      • Default Ports
      • DNS Considerations
      • Network and Firewall
      • CP/DP Communication through a Forward Proxy
    • Kong Configuration File
    • Environment Variables
    • Serving a Website and APIs from Kong
      • Overview
      • Prometheus
      • StatsD
      • Datadog
      • Overview
      • Writing a Custom Trace Exporter
      • Tracing API Reference
    • Resource Sizing Guidelines
    • Security Update Process
    • Blue-Green Deployments
    • Canary Deployments
    • Clustering Reference
      • Log Reference
      • Dynamic log level updates
      • Customize Gateway Logs
      • Upgrade Kong Gateway 3.1.x
      • Migrate from OSS to Enterprise
    • Overview
      • Overview
      • Metrics
      • Analytics with InfluxDB
      • Analytics with Prometheus
      • Estimate Analytics Storage in PostgreSQL
      • Overview
      • Getting Started
      • Advanced Usage
        • Overview
        • Environment Variables
        • AWS Secrets Manager
        • Google Secrets Manager
        • Hashicorp Vault
        • Securing the Database with AWS Secrets Manager
      • Reference Format
      • Overview
      • Get Started with Dynamic Plugin Ordering
      • Overview
      • Enable the Dev Portal
      • Publish an OpenAPI Spec
      • Structure and File Types
      • Themes Files
      • Working with Templates
      • Using the Editor
        • Basic Auth
        • Key Auth
        • OIDC
        • Sessions
        • Adding Custom Registration Fields
        • Manage Developers
        • Developer Roles and Content Permissions
        • Authorization Provider Strategy
        • Enable Application Registration
        • Enable Key Authentication for Application Registration
          • External OAuth2 Support
          • Set up Okta and Kong for External Oauth
          • Set up Azure AD and Kong for External Authentication
        • Manage Applications
        • Theme Editing
        • Migrating Templates Between Workspaces
        • Markdown Rendering Module
        • Customizing Portal Emails
        • Adding and Using JavaScript Assets
        • Single Page App in Dev Portal
        • Alternate OpenAPI Renderer
      • SMTP
      • Workspaces
      • Helpers CLI
      • Portal API Documentation
    • Audit Logging
    • Keyring and Data Encryption
    • Workspaces
    • Consumer Groups
    • Event Hooks
    • FIPS 140-2
    • Overview
    • Enable Kong Manager
      • Services and Routes
      • Rate Limiting
      • Proxy Caching
      • Authentication with Consumers
      • Load Balancing
      • Overview
      • Create a Super Admin
      • Workspaces and Teams
      • Reset Passwords and RBAC Tokens
      • Basic Auth
        • Configure LDAP
        • LDAP Service Directory Mapping
        • Configure OIDC
        • OIDC Authenticated Group Mapping
      • Sessions
        • Overview
        • Enable RBAC
        • Add a Role and Permissions
        • Create a User
        • Create an Admin
    • Networking Configuration
    • Workspaces
    • Create Consumer Groups
    • Sending Email
    • Overview
    • File Structure
    • Implementing Custom Logic
    • Plugin Configuration
    • Accessing the Data Store
    • Storing Custom Entities
    • Caching Custom Entities
    • Extending the Admin API
    • Writing Tests
    • (un)Installing your Plugin
      • Overview
      • kong.client
      • kong.client.tls
      • kong.cluster
      • kong.ctx
      • kong.ip
      • kong.jwe
      • kong.log
      • kong.nginx
      • kong.node
      • kong.request
      • kong.response
      • kong.router
      • kong.service
      • kong.service.request
      • kong.service.response
      • kong.table
      • kong.tracing
      • kong.vault
      • kong.websocket.client
      • kong.websocket.upstream
      • Go
      • Javascript
      • Python
      • Running Plugins in Containers
      • External Plugin Performance
    • Overview
        • Overview
        • OpenID Connect with Curity
        • OpenID Connect with Azure AD
        • OpenID Connect with Google
        • OpenID Connect with Okta
        • OpenID Connect with Auth0
        • OpenID Connect with Cognito
      • Authentication Reference
      • Allow Multiple Authentication Plugins
    • Rate Limiting Plugin
      • Add a Body Value
    • GraphQL
      • gRPC Plugins
      • Configure a gRPC service
    • Overview
    • Information Routes
    • Health Routes
    • Tags
    • Debug Routes
    • Services
    • Routes
    • Consumers
    • Plugins
    • Certificates
    • CA Certificates
    • SNIs
    • Upstreams
    • Targets
    • Vaults
    • Keys
    • Licenses
    • Workspaces
    • RBAC
    • Admins
    • Developers
    • Consumer Groups
    • Event Hooks
    • Keyring and Data Encryption
    • Audit Logs
    • kong.conf
    • Injecting Nginx Directives
    • CLI
    • File Permissions Reference
    • Key Management
    • Performance Testing Framework
    • Router Expressions Language
    • FAQ

github-edit-pageEdit this page

report-issueReport an issue

enterprise-switcher-iconSwitch to OSS

On this page
  • Prerequisites
  • Apply OIDC auth mapping to Kong Gateway
    • Review important values
    • Set up mapping
Kong Gateway
3.1.x
  • Home
  • Kong Gateway
  • Kong Manager
  • Authentication and Authorization
  • OpenID Connect
  • OIDC Authenticated Group Mapping
You are browsing documentation for an outdated version. See the latest documentation here.

OIDC Authenticated Group Mapping

Using Kong’s OpenID Connect plugin (OIDC), you can map identity provider (IdP) groups to Kong roles. Adding a user to Kong in this way gives them access to Kong based on their group in the IdP.

Admin accounts are now created automatically when you map your identity provider (IdP) groups to Kong roles. You do not need to create the users, groups, and roles separately. These users then accept invitations to join Kong Manager and log in with their IdP credentials.

Important: In v2.7.x, the admin_claim parameter replaces the consumer_claim parameter required by previous versions.

If an admin’s group changes in the IdP, their Kong admin account’s associated role also changes in Kong Gateway the next time they log in to Kong Manager. The mapping removes the task of manually managing access in Kong Gateway, because it makes the IdP the system of record.

Prerequisites

  • An IdP with an authorization server and users with groups assigned
  • Kong Gateway installed and configured
  • Kong Manager enabled
  • RBAC enabled
  • (Kubernetes) Helm installed

Apply OIDC auth mapping to Kong Gateway

Review important values

In the following examples, you specify the admin_claim and authenticated_groups_claim parameters to identify which admin value and role name to map from the IdP to Kong Gateway, as well as the admin_auto_create_rbac_token_disabled to specify whether an RBAC token is created for admins in Kong.

  • The admin_claim value specifies which IdP username value should map to Kong Manager. The username and password are required for the user to log into the IdP.

  • The authenticated_groups_claim value specifies which IdP claim should be used to assign Kong Gateway roles to the specified Kong Gateway admin.

    This value depends on your IdP – for example, Okta configures claims for groups, and another IdP might configure them as roles.

    In the IdP, the group claim value must follow the format <workspace_name>:<role_name>.

    For example, if "authenticated_groups_claim": ["groups"] is specified, and in the IdP groups:["default:super-admin"] is specified, the administrators specified in admin_claim are assigned to the super-admin role in the default Kong Gateway workspace.

    If the mapping does not work as expected, decode the JWT that’s created by your IdP, and make sure that the admin ID token includes the key:value pair groups:["default:super-admin"] for the case of this example, or the appropriate claim name and claim value as set in your IdP.

  • The admin_auto_create_rbac_token_disabled boolean enables or disables RBAC token creation when automatically creating admins with OpenID Connect. The default is false.

    • Set to true to disable automatic token creation for admins
    • Set to false to enable automatic token creation for admins

Set up mapping

Kubernetes with Helm
Docker
kong.conf
  1. Create a configuration file for the OIDC plugin and save it as admin_gui_auth_conf.

    Provide your own values for all fields indicated by curly braces ({}):

     {                                      
         "issuer": "{YOUR_IDP_URL}",        
         "admin_claim": "email",
         "client_id": ["{CLIENT_ID}"],                 
         "client_secret": ["{CLIENT_SECRET}"],
         "authenticated_groups_claim": ["{CLAIM_NAME}"],
         "ssl_verify": false,
         "leeway": 60,
         "redirect_uri": ["{YOUR_REDIRECT_URI}"],
         "login_redirect_uri": ["{YOUR_LOGIN_REDIRECT_URI}"],
         "logout_methods": ["GET", "DELETE"],
         "logout_query_arg": "logout",
         "logout_redirect_uri": ["{YOUR_LOGOUT_REDIRECT_URI}"],
         "scopes": ["openid","profile","email","offline_access"],
         "auth_methods": ["authorization_code"],
         "admin_auto_create_rbac_token_disabled": false
     }
    

    For detailed descriptions of all OIDC parameters, see the OpenID Connect parameter reference.

  2. Create a secret from the file you just created:

     kubectl create secret generic kong-idp-conf --from-file=admin_gui_auth_conf -n kong
    
  3. Update the RBAC section of the deployment values.yml file with the following parameters:

     rbac:
       enabled: true
       admin_gui_auth: openid-connect
       session_conf_secret: kong-session-conf   
       admin_gui_auth_conf_secret: kong-idp-conf
    
  4. Using Helm, upgrade the deployment with your YAML filename:

     helm upgrade --install kong-ee kong/kong -f ./myvalues.yaml -n kong
    

If you have a Docker installation, run the following command to set the needed environment variables and reload the Kong Gateway configuration.

Provide your own values for all fields indicated by curly braces ({}):

echo "
  KONG_ENFORCE_RBAC=on \
  KONG_ADMIN_GUI_AUTH=openid-connect \
  KONG_ADMIN_GUI_AUTH_CONF='{
      \"issuer\": \"{YOUR_IDP_URL}\",
      \"admin_claim\": \"email\",
      \"client_id\": [\"<someid>\"],
      \"client_secret\": [\"<somesecret>\"],
      \"authenticated_groups_claim\": [\"{CLAIM_NAME}\"],,
      \"ssl_verify\": false,
      \"leeway\": 60,
      \"redirect_uri\": [\"{YOUR_REDIRECT_URI}\"],
      \"login_redirect_uri\": [\"{YOUR_LOGIN_REDIRECT_URI}\"],
      \"logout_methods\": [\"GET\", \"DELETE\"],
      \"logout_query_arg\": \"logout\",
      \"logout_redirect_uri\": [\"{YOUR_LOGOUT_REDIRECT_URI}\"],
      \"scopes\": [\"openid\",\"profile\",\"email\",\"offline_access\"],
      \"auth_methods\": [\"authorization_code\"],
      \"admin_auto_create_rbac_token_disabled\": false
    }' kong reload exit" | docker exec -i {KONG_CONTAINER_ID} /bin/sh

Replace {KONG_CONTAINER_ID} with the ID of your container.

For detailed descriptions of all the parameters used here, and many other customization options, see the OpenID Connect parameter reference.

  1. Navigate to your kong.conf file.

  2. With RBAC enabled, add the admin_gui_auth and admin_gui_auth_conf properties to the file.

    Provide your own values for all fields indicated by curly braces ({}):

     enforce_rbac = on
     admin_gui_auth = openid-connect
     admin_gui_auth_conf = {                                      
         "issuer": "{YOUR_IDP_URL}",        
         "admin_claim": "email",
         "client_id": ["{CLIENT_ID}"],                 
         "client_secret": ["{CLIENT_SECRET}"],
         "authenticated_groups_claim": ["{CLAIM_NAME}"],
         "ssl_verify": false,
         "leeway": 60,
         "redirect_uri": ["{YOUR_REDIRECT_URI}"],
         "login_redirect_uri": ["{YOUR_LOGIN_REDIRECT_URI}"],
         "logout_methods": ["GET", "DELETE"],
         "logout_query_arg": "logout",
         "logout_redirect_uri": ["{YOUR_LOGOUT_REDIRECT_URI}"],
         "scopes": ["openid","profile","email","offline_access"],
         "auth_methods": ["authorization_code"],
         "admin_auto_create_rbac_token_disabled": false
     }
    

    For detailed descriptions of all the parameters used here, and many other customization options, see the OpenID Connect parameter reference.

  3. Restart Kong Gateway to apply the file.

     kong restart -c /path/to/kong.conf
    
Thank you for your feedback.
Was this page useful?
  • Kong
    THE CLOUD CONNECTIVITY COMPANY

    Kong powers reliable digital connections across APIs, hybrid and multi-cloud environments.

    • Company
    • Customers
    • Events
    • Investors
    • Careers Hiring!
    • Partners
    • Press
    • Contact
  • Products
    • Kong Konnect
    • Kong Gateway
    • Kong Mesh
    • Get Started
    • Pricing
  • Resources
    • eBooks
    • Webinars
    • Briefs
    • Blog
    • API Gateway
    • Microservices
  • Open Source
    • Install Kong Gateway
    • Kong Community
    • Kubernetes Ingress
    • Kuma
    • Insomnia
  • Solutions
    • Decentralize
    • Secure & Govern
    • Create a Dev Platform
    • API Gateway
    • Kubernetes
    • Service Mesh
Star
  • Terms•Privacy
© Kong Inc. 2023