--- title: Configuring Konnect for PingAuthorize integration description: For Kong Konnect to use PingAuthorize as an external authorization policy runtime service, you must download, install, and configure the ping-auth plugin. component: pingauthorize version: 11.0 page_id: pingauthorize:pingauthorize_integrations:paz_configuring_konnect_for_integration canonical_url: https://docs.pingidentity.com/pingauthorize/11.0/pingauthorize_integrations/paz_configuring_konnect_for_integration.html revdate: April 28, 2025 section_ids: add_pingauth_plugin_konnect: Adding the ping-auth plugin to your control plane adding-the-plugin-using-the-konnect-ui: Adding the plugin using the Konnect UI about-this-task: About this task steps: Steps adding-the-plugin-using-the-konnect-api: Adding the plugin using the Konnect API about-this-task-2: About this task steps-2: Steps result: Result: result-2: Result: upload_files_to_data_plane: Uploading files to data plane nodes about-this-task-3: About this task steps-3: Steps example: Example: configure_pingauth_plugin_konnect: Configuring the ping-auth plugin in Konnect configuring-the-plugin-using-the-gateway-manager-ui: Configuring the plugin using the Gateway Manager UI steps-4: Steps result-3: Result configuring-the-plugin-using-the-kong-api: Configuring the plugin using the Kong API steps-5: Steps result-4: Result: --- # Configuring Konnect for PingAuthorize integration For Kong Konnect to use PingAuthorize as an external authorization policy runtime service, you must download, install, and configure the `ping-auth` plugin. To configure the `ping-auth` plugin in Kong Konnect, you must: 1. [Add the ping-auth plugin to your control plane](#add_pingauth_plugin_konnect) 2. [Upload files to your data plane nodes](#upload_files_to_data_plane) 3. [Configure the ping-auth plugin in Konnect](#configure_pingauth_plugin_konnect) ## Adding the ping-auth plugin to your control plane Use the `ping-auth` plugin's `schema.lua` file to create the configurable entity required by Konnect. Konnect uses this file to create a plugin entry in the plugin catalog for your control plane. If the plugin schema should be available in multiple control planes, add the schema individually to each one. You can manage schemas for custom plugins through the Konnect UI or the Konnect Control Planes Config API. * Using the Konnect UI * Using the Konnect API ### Adding the plugin using the Konnect UI #### About this task | | | | - | ------------------------------------------------------------------------------- | | | The UI is not available when using KIC in Konnect. Use the Konnect API instead. | #### Steps 1. Download version 1.0.8-1 or later of the `kong-plugin-ping-auth` src from . | | | | - | ------------------------------------------------------------------------------- | | | Support for Kong Konnect is available in version 1.0.8 and later of the plugin. | 2. Extract the `src.rock` file and store it on your local computer. Verify that you have the following files in the extracted `/kong-plugin/ping-auth` folder: * `access.lua` * `handler.lua` * `Network_handle.lua` * `response.lua` * `schema.lua` 3. In Gateway Manager, open a control plane. 4. In the sidebar, open Plugins, then click New Plugin. 5. Click the Custom Plugins tab, then click Create on the Custom Plugin tile. 6. Click Select File, then select the `schema.lua` file for the `ping-auth` plugin that you extracted in step 1. 7. Make sure your file displays correctly in the preview, then click Save. ### Adding the plugin using the Konnect API #### About this task When using the `/plugin-schemas` API, authenticate your requests with either a personal access token or a system account token by including it in the authorization header: ``` --header 'Authorization: Bearer kpat_xgfT' ``` #### Steps 1. Upload the `schema.lua` file for your plugin using the `/plugin-schemas` endpoint: ```shell curl -i -X POST \ https://{region}.api.konghq.com/konnect-api/api/runtime_groups/{controlPlaneId}/v2/plugin-schemas \ --header 'Content-Type: application/json' \ --data "{\"lua_schema\": }" ``` ##### Result: You should get an `HTTP 201` response. 2. To check that your schema was uploaded, use the following request: ```shell curl -i -X GET \ https://{region}.api.konghq.com/konnect-api/api/runtime_groups/{controlPlaneId}/v1/available-plugins ``` ##### Result: This request returns an `HTTP 200` response with the schema for your plugin as a JSON object. ## Uploading files to data plane nodes ### About this task After you upload the `ping-auth` plugin's schema to Konnect, upload the following files for the plugin to each Kong Konnect data plane node: * `access.lua` * `handler.lua` * `Network_handle.lua` * `response.lua` * `schema.lua` | | | | - | ---------------------------------------------------------------------------------------------- | | | If a data plane node doesn't have these files, the `ping-auth` plugin cannot run on that node. | Follow the Kong Gateway plugin deployment instructions to set up the plugin on each node. Instructions can vary depending on the platform. If you're running Kong Gateway on Docker, the following instructions are provided as an example. Install the `ping-auth` plugin inside the Kong Konnect Docker container for each node. Copy or mount the plugin's source code into the container. ### Steps 1. In your control plane, go to **Data Plane Nodes**, then click **New Data Plane Node**. 2. Select a **Platform**, for example **Linux (Docker)**, and **Generate a certificate**. ![Screen capture of the "Self-managed Hybrid Data Plane Node" screen](_images/mhy1702679880472.png) 3. Copy the generated Docker run command and add the following snippet to it. Substitute your own source and target paths. * The *\* is the location where you extracted the `ping-auth` plugin files. This is the parent folder that contains the `ping-auth` folder. * The *\* is where you keep custom Kong plugins. This is the path to the `ping-auth` plugin. ``` -v "/:/ping-auth://ping-auth" \ -e "KONG_PLUGINS=bundled,ping-auth" \ -e "KONG_LUA_PACKAGE_PATH=//?.lua;;" \ ``` 4. To start a data plane node with the `ping-auth` plugin loaded, run the command. #### Example: For example, the command will look something like this, including the three snippet lines from the previous step. In this example, `plugins/kong` represents the *\* and `/usr/local/share/lua/5.1/kong/plugins` represents the *\*. ```shell docker run -d \ -v "/plugins/kong/ping-auth:/usr/local/share/lua/5.1/kong/plugins/ping-auth" \ -e "KONG_PLUGINS=bundled,ping-auth" \ -e "KONG_LUA_PACKAGE_PATH=/usr/local/share/lua/5.1/kong/plugins/?.lua;;" \ -e "KONG_ROLE=data_plane" \ -e "KONG_DATABASE=off" \ -e "KONG_VITALS=off" \ -e "KONG_NGINX_WORKER_PROCESSES=1" \ -e "KONG_CLUSTER_MTLS=pki" \ -e "KONG_CLUSTER_CONTROL_PLANE=.cp0.konghq.com:443" \ -e "KONG_CLUSTER_SERVER_NAME=.cp0.konghq.com" \ -e "KONG_CLUSTER_TELEMETRY_ENDPOINT=.tp0.konghq.com:443" \ -e "KONG_CLUSTER_TELEMETRY_SERVER_NAME=.tp0.konghq.com" \ -e "KONG_CLUSTER_CERT=" \ -e "KONG_CLUSTER_CERT_KEY=" \ -e "KONG_LUA_SSL_TRUSTED_CERTIFICATE=system" \ -e "KONG_KONNECT_MODE=on" \ -p 8000:8000 \ -p 8443:8443 \ kong/kong-gateway: ``` 5. To confirm the Docker deployment, run the following command: ``` "docker logs [container id]" ``` ![Screen capture of the "Create a Data Plane Node" confirming deployment of the configured Data Plane Node](_images/xew1702680032882.png) ## Configuring the ping-auth plugin in Konnect After you've uploaded the `ping-auth` plugin's schema to Konnect, configure the plugin in Gateway Manager or use the Kong API. | | | | - | ----------------------------------------------------------------------------- | | | Test the operation of the `ping-auth` plugin before you use it in production. | * Using the Gateway Manager UI * Using the Kong API ### Configuring the plugin using the Gateway Manager UI #### Steps 1. In Gateway Manager, open Plugins from the sidebar, then click New Plugin. 2. On the Custom Plugins tab, click the ping-auth plugin. 3. **Optional:** To enable the plugin for specific consumers, services, or routes, click Scoped, and then enter the Service, Route, and Consumer information. 4. In the Service Url field, enter the host name of your PingAuthorize server and the port of the HTTPS Connection Handler. To find this port number in the PingAuthorize administrative console, go to Configuration → System → Connection Handlers. For example, `https://pingauthorize:8443`. 5. In the Shared Secret field, enter the PingAuthorize sideband client's shared secret. 6. Verify that the Secret Header Name matches the secret header name configured for the Sideband API Servlet Extension in PingAuthorize. ![Screen capture of the Kong Konnect configure plugin screen with the "Secret Header Name" field highlighted](_images/ong1702680219153.png) 7. Configure the following additional fields: | Option | API Field Name | Description | | -------------------------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Connection KeepAlive Ms | `connection_keepAlive_ms` | The duration to keep the connection alive for reuse. The default is `60000`. | | Connection Timeout Ms | `connection_timeout_ms` | The duration to wait before the connection times out. The default is `10000`. | | Enable Debug Logging | `enable_debug_logging` | Controls if the requests and responses are logged at the debug level. The default is `false`. For log messages to show in `error.log`, you must set `log_level = debug` in `kong.conf`. | | Verify Service Certificate | `verify_service_certificate` | Controls whether the service certificate is verified. This is intended for testing purposes and the default is `true`. | 8. Click Save. #### Result Kong Konnect is now configured to work with PingAuthorize. ### Configuring the plugin using the Kong API #### Steps 1. Send the following in a `POST` request to `https://{region}.api.konghq.com/konnect-api/api/runtime_groups/{controlPlaneId}/plugins`: ```json { "name": "ping-auth", "enabled": true, "config": { "enable_debug_logging": true, "verify_service_certificate": false, "secret_header_name": "", "service_url": "https://:", "shared_secret": "" } } ``` The following list describes the required fields for this API request: * `Service_url`: The full URL of the Ping policy provider. This should not contain `/sideband` in the path. * `Shared_secret`: The shared secret value to authenticate this plugin to the policy provider. * `Secret_header_name`: The header name in which the shared secret is provided. You can provide additional configuration in accordance with the Kong API specification. 2. Configure the optional fields: | Option | API Field Name | Description | | ------------------------------ | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Connection KeepAlive Ms** | `connection_keepAlive_ms` | The duration to keep the connection alive for reuse. The default is `60000`. | | **Connection Timeout Ms** | `connection_timeout_ms` | The duration to wait before the connection times out. The default is `10000`. | | **Enable Debug Logging** | `enable_debug_logging` | Controls if the requests and responses are logged at the debug level. The default is `false`. For log messages to show in `error.log`, you must set `log_level = debug` in `kong.conf`. | | **Verify Service Certificate** | `verify_service_certificate` | Controls whether the service certificate is verified. This is intended for testing purposes and the default is `true`. | ##### Result: Kong Konnect is configured to work with PingAuthorize.