You are browsing documentation for an outdated plugin version.
Configuration
This plugin is not compatible with DB-less mode.
For its regular work, the plugin needs to both generate and delete tokens, and commit those changes to the database, which is not compatible with DB-less.
In addition to this, its Admin API endpoints offer several POST, PATCH, PUT, and DELETE methods for tokens and credentials. None of them would work on DB-less.
Compatible protocols
The OAuth 2.0 Authentication plugin is compatible with the following protocols:
grpc
, grpcs
, http
, https
, ws
, wss
Parameters
Here's a list of all the parameters which can be used in this plugin's configuration:
-
name or plugin
string requiredThe name of the plugin, in this case
oauth2
.- 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
-
service.name or service.id
stringThe 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
. -
route.name or route.id
stringThe 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
. -
enabled
boolean default:true
Whether this plugin will be applied.
-
config
record required-
scopes
array of typestring
Describes an array of scope names that will be available to the end user. If
mandatory_scope
is set totrue
, thenscopes
are required.
-
mandatory_scope
boolean required default:false
An optional boolean value telling the plugin to require at least one
scope
to be authorized by the end user.
-
provision_key
string required encryptedThe unique key the plugin has generated when it has been added to the Service.
-
token_expiration
number required default:7200
An optional integer value telling the plugin how many seconds a token should last, after which the client will need to refresh the token. Set to
0
to disable the expiration.
-
enable_authorization_code
boolean required default:false
An optional boolean value to enable the three-legged Authorization Code flow (RFC 6742 Section 4.1).
-
enable_implicit_grant
boolean required default:false
An optional boolean value to enable the Implicit Grant flow which allows to provision a token as a result of the authorization process (RFC 6742 Section 4.2).
-
enable_client_credentials
boolean required default:false
An optional boolean value to enable the Client Credentials Grant flow (RFC 6742 Section 4.4).
-
enable_password_grant
boolean required default:false
An optional boolean value to enable the Resource Owner Password Credentials Grant flow (RFC 6742 Section 4.3).
-
hide_credentials
boolean required default:false
An optional boolean value telling the plugin to show or hide the credential from the upstream service. If
true
, the plugin will strip the credential from the request (the header containing the client credentials) before proxying it.
-
accept_http_if_already_terminated
boolean required default:false
Accepts HTTPs requests that have already been terminated by a proxy or load balancer and the
x-forwarded-proto: https
header has been added to the request. Only enable this option if the Kong server cannot be publicly accessed and the only entry point is such proxy or load balancer.
-
anonymous
stringAn optional string (consumer UUID) value to use as an anonymous consumer if authentication fails. If empty (default), the request fails with an authentication failure
4xx
. Note that this value must refer to the consumerid
attribute that is internal to Kong Gateway, and not itscustom_id
.
-
global_credentials
boolean required default:false
An optional boolean value that allows using the same OAuth credentials generated by the plugin with any other Service whose OAuth 2.0 plugin configuration also has
config.global_credentials=true
.
-
auth_header_name
string default:authorization
The name of the header that is supposed to carry the access token. Default:
authorization
.
-
refresh_token_ttl
number required default:1209600
An optional integer value telling the plugin how many seconds a token/refresh token pair is valid for, and can be used to generate a new access token. Default value is 2 weeks. Set to
0
to keep the token/refresh token pair valid indefinitely.
-
reuse_refresh_token
boolean required default:false
An optional boolean value that indicates whether an OAuth refresh token is reused when refreshing an access token.
-
persistent_refresh_token
boolean required default:false
-
pkce
string default:lax
Must be one of:none
,lax
,strict
Specifies a mode of how the Proof Key for Code Exchange (PKCE) should be handled by the plugin. The possible modes are
none
,lax
, andstrict
. Thestrict
mode enforces PKCE on both authorization and token endpoints for all the clients. Thelax
mode enforces PKCE for public clients, but it does not enforce it for confidential clients. Thenone
mode does not enforce PKCE on any client. In any case, if a client asks for PKCE on authorization endpoint, the PKCE is also enforced on token endpoint.
-