OAuth 2.0 Introspection

The value to set as the Authorization header when querying the introspection endpoint. This depends on the OAuth 2.0 server, but usually is the client_id and client_secret as a Base64-encoded Basic Auth string (Basic MG9hNWl...).
This field is encrypted.
This field is referenceable.

A string indicating whether to associate OAuth2 username or client_id with the consumer’s username. OAuth2 username is mapped to a consumer’s username field, while an OAuth2 client_id maps to a consumer’s custom_id.

A list of custom claims to be forwarded from the introspection response to the upstream request. Claims are forwarded in headers with prefix X-Credential-{claim-name}.

A list of custom headers to be added in the introspection request.

An optional boolean value telling the plugin to hide the credential to the upstream API server. It will be removed by Kong before proxying the request.

A boolean indicating whether to forward information about the current downstream request to the introspect endpoint. If true, headers X-Request-Path and X-Request-Http-Method will be inserted into the introspect request.

A string representing a URL, such as https://example.com/path/to/resource?q=search.

An optional value in milliseconds that defines how long an idle connection lives before being closed.

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.

An optional timeout in milliseconds when sending data to the upstream server.

The token_type_hint value to associate to introspection requests.

The TTL in seconds for the introspection response. Set to 0 to disable the expiration.