Configuration
This plugin is partially compatible with DB-less mode.
Consumers and JWT secrets can be created with declarative configuration.
Admin API endpoints that do POST, PUT, PATCH, or DELETE on secrets are not available on DB-less mode.
Compatible protocols
The JWT plugin is compatible with the following protocols:
grpc
, grpcs
, http
, https
Parameters
Here's a list of all the parameters which can be used in this plugin's configuration:
-
string required
The name of the plugin, in this case
jwt
.- If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is
name
. - If using the KongPlugin object in Kubernetes, the field is
plugin
.
- If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is
-
string
An optional custom name to identify an instance of the plugin, for example
jwt_my-service
.The instance name shows up in Kong Manager and in Konnect, so it's useful when running the same plugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance via the Kong Admin API.
An instance name must be unique within the following context:
- Within a workspace for Kong Gateway Enterprise
- Within a control plane or control plane group for Konnect
- Globally for Kong Gateway (OSS)
-
string
The name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level
/plugins
endpoint. Not required if using/services/{serviceName|Id}/plugins
. -
string
The name or ID of the route the plugin targets. Set one of these parameters if adding the plugin to a route through the top-level
/plugins
endpoint. Not required if using/routes/{routeName|Id}/plugins
. -
boolean default:
true
Whether this plugin will be applied.
-
record required
-
set of type
string
default:jwt
A list of querystring parameters that Kong will inspect to retrieve JWTs.
-
set of type
string
A list of cookie names that Kong will inspect to retrieve JWTs.
-
string default:
iss
The name of the claim in which the key identifying the secret must be passed. The plugin will attempt to read this claim from the JWT payload and the header, in that order.
-
boolean required default:
false
If true, the plugin assumes the credential’s secret to be base64 encoded. You will need to create a base64-encoded secret for your Consumer, and sign your JWT with the original secret.
-
set of type
string
Must be one of:exp
,nbf
A list of registered claims (according to RFC 7519) that Kong can verify as well. Accepted values: one of exp or nbf.
-
string
An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
-
boolean required default:
true
A boolean value that indicates whether the plugin should run (and try to authenticate) on OPTIONS preflight requests. If set to false, then OPTIONS requests will always be allowed.
-
number default:
0
between:0
31536000
A value between 0 and 31536000 (365 days) limiting the lifetime of the JWT to maximum_expiration seconds in the future.
-
set of type
string
default:authorization
A list of HTTP header names that Kong will inspect to retrieve JWTs.
-
string
When authentication fails the plugin sends
WWW-Authenticate
header withrealm
attribute value.
-