Plugins

Get a UpstreamOauth plugin

get/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#UpstreamOauth

Response

UpstreamOauth plugin

conditionstring nullable

An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.

created_atinteger nullable

Unix epoch when the resource was created.

enabledboolean nullable

Whether the plugin is applied.

idstring nullable

A string representing a UUID (universally unique identifier).

instance_namestring nullable

A unique string representing a UTF-8 encoded name.

name'upstream-oauth' required

The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.

tagsstring[] nullable

An optional set of strings associated with the Plugin for grouping and filtering.

updated_atinteger nullable

Unix epoch when the resource was last updated.

protocolsstring[]

A set of strings representing HTTP protocols.

Changes

Changed in 13 of the 52 revisions of this API.3246

Jun 26, 20264a39c7f8550911See the full diff
- ▲
  the allOf[UpstreamOauthPluginConfig]/config/cache/redis/port response's property type/format changed from integer/ to string/ for status 200
  response-property-type-changed
- ○
  the port response's property default value changed from 6379 to 6379 for the status 200
  response-property-default-value-changed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 11, 202662c54f1094bb1See the full diff
- ○
  the response property allOf[PluginBase]/partials/items/path became required for the status 200
  response-property-became-required
Apr 24, 20267d6a643707d91See the full diff
- ○
  added the optional property allOf[PluginBase]/condition to the response with the 200 status
  response-optional-property-added
Jan 13, 2026ad02b4e24eb21See the full diff
- ○
  added the optional property allOf[UpstreamOauthPluginConfig]/config/cache/redis/cloud_authentication to the response with the 200 status
  response-optional-property-added
Oct 29, 202519e869275e281See the full diff
- ▲
  the allOf[UpstreamOauthPluginConfig]/name response's property type/format changed from string/ to / for status 200
  response-property-type-changed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 22, 202596118a9cd7f42134See the full diff
- ▲
  the response property allOf[PluginBase]/partials/items/name became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[PluginBase]/partials/items/path became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[UpstreamOauthPluginConfig]/config/behavior became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[UpstreamOauthPluginConfig]/config/cache/redis/cluster_nodes became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[UpstreamOauthPluginConfig]/config/cache/redis/keepalive_backlog became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[UpstreamOauthPluginConfig]/config/cache/redis/password became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[UpstreamOauthPluginConfig]/config/cache/redis/sentinel_master became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[UpstreamOauthPluginConfig]/config/cache/redis/sentinel_nodes became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[UpstreamOauthPluginConfig]/config/cache/redis/sentinel_password became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[UpstreamOauthPluginConfig]/config/cache/redis/sentinel_username became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[UpstreamOauthPluginConfig]/config/cache/redis/server_name became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[UpstreamOauthPluginConfig]/config/cache/redis/username became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[UpstreamOauthPluginConfig]/config/client/http_proxy became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[UpstreamOauthPluginConfig]/config/client/http_proxy_authorization became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[UpstreamOauthPluginConfig]/config/client/https_proxy became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[UpstreamOauthPluginConfig]/config/client/https_proxy_authorization became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[UpstreamOauthPluginConfig]/config/client/no_proxy became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[UpstreamOauthPluginConfig]/config/oauth/client_id became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[UpstreamOauthPluginConfig]/config/oauth/client_secret became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[UpstreamOauthPluginConfig]/config/oauth/password became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[UpstreamOauthPluginConfig]/config/oauth/username became nullable for the status 200
  response-property-became-nullable
- ○
  the audience response's property default value was added for the status 200
  response-property-default-value-added
- ○
  the auth_method response's property default value client_secret_post was added for the status 200
  response-property-default-value-added
- ○
  the client_secret_jwt_alg response's property default value HS512 was added for the status 200
  response-property-default-value-added
- ○
  the cluster_max_redirections response's property default value 5 was added for the status 200
  response-property-default-value-added
- ○
  the connect_timeout response's property default value 2000 was added for the status 200
  response-property-default-value-added
- ○
  the connection_is_proxied response's property default value false was added for the status 200
  response-property-default-value-added
- ○
  the database response's property default value 0 was added for the status 200
  response-property-default-value-added
- ○
  the default_ttl response's property default value 3600 was added for the status 200
  response-property-default-value-added
- ○
  the dictionary_name response's property default value kong_db_cache was added for the status 200
  response-property-default-value-added
- ○
  the eagerly_expire response's property default value 5 was added for the status 200
  response-property-default-value-added
- ○
  the enabled response's property default value true was added for the status 200
  response-property-default-value-added
- ○
  the grant_type response's property default value client_credentials was added for the status 200
  response-property-default-value-added
- ○
  the host response's property default value 127.0.0.1 was added for the status 200
  response-property-default-value-added
- ○
  the host response's property default value 127.0.0.1 was added for the status 200
  response-property-default-value-added
- ○
  the idp_error_response_body_template response's property default value { "code": "{{status}}" "message": "{{message}}" } was added for the status 200
  response-property-default-value-added
- ○
  the idp_error_response_content_type response's property default value application/json; charset=utf-8 was added for the status 200
  response-property-default-value-added
- ○
  the idp_error_response_message response's property default value Failed to authenticate request to upstream was added for the status 200
  response-property-default-value-added
- ○
  the idp_error_response_status_code response's property default value 502 was added for the status 200
  response-property-default-value-added
- ○
  the ip response's property default value 127.0.0.1 was added for the status 200
  response-property-default-value-added
- ○
  the keep_alive response's property default value true was added for the status 200
  response-property-default-value-added
- ○
  the keepalive_pool_size response's property default value 256 was added for the status 200
  response-property-default-value-added
- ○
  the port response's property default value 6379 was added for the status 200
  response-property-default-value-added
- ○
  the port response's property default value 6379 was added for the status 200
  response-property-default-value-added
- ○
  the port response's property default value 6379 was added for the status 200
  response-property-default-value-added
- ○
  the protocols response's property default value grpc grpcs http https was added for the status 200
  response-property-default-value-added
- ○
  the purge_token_on_upstream_status_codes response's property default value 401 was added for the status 200
  response-property-default-value-added
- ○
  the read_timeout response's property default value 2000 was added for the status 200
  response-property-default-value-added
- ○
  the send_timeout response's property default value 2000 was added for the status 200
  response-property-default-value-added
- ○
  the ssl response's property default value false was added for the status 200
  response-property-default-value-added
- ○
  the ssl_verify response's property default value false was added for the status 200
  response-property-default-value-added
- ○
  the ssl_verify response's property default value false was added for the status 200
  response-property-default-value-added
- ○
  the strategy response's property default value memory was added for the status 200
  response-property-default-value-added
- ○
  the timeout response's property default value 10000 was added for the status 200
  response-property-default-value-added
- ○
  the upstream_access_token_header_name response's property default value Authorization was added for the status 200
  response-property-default-value-added
This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 22, 20252c77aeaee5fb13See the full diff
- ▲
  the response property allOf[PluginBase]/tags became nullable for the status 200
  response-property-became-nullable
- ○
  the response property allOf[UpstreamOauthPluginConfig]/config became required for the status 200
  response-property-became-required
- ○
  the response property allOf[UpstreamOauthPluginConfig]/config/oauth became required for the status 200
  response-property-became-required
- ○
  the response property allOf[UpstreamOauthPluginConfig]/config/oauth/token_endpoint became required for the status 200
  response-property-became-required
Jun 17, 2025c308b7426a7c1See the full diff
- ▲
  the allOf[UpstreamOauthPluginConfig]/protocols response's property type/format changed from array/ to array/set for status 200
  response-property-type-changed
May 21, 202569704304ad5f1See the full diff
- ○
  added the optional property allOf[PluginBase]/partials to the response with the 200 status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 22, 20258b14ad5a467711See the full diff
- ▲
  the response property allOf[UpstreamOauthPluginConfig]/config/oauth/scopes became nullable for the status 200
  response-property-became-nullable
- ○
  the scopes response's property default value was added for the status 200
  response-property-default-value-added

Full history (13 revisions)