Sign in
Plugins

Update a Oauth2 plugin

Update a Oauth2 plugin

put/{workspace}/plugins/{PluginId}#Oauth2

Request body

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'oauth2' 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 list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.

Response

Oauth2 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'oauth2' 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 list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.

Changes

Changed in 3 of the 11 revisions of this API.27

  • 9555cbb8b2594See the full diff
    • ○

      added the new optional request property allOf[PluginBase]/condition

      new-optional-request-property

    • ○

      the hide_credentials request property default value changed from false to true

      request-property-default-value-changed

    • ○

      added the optional property allOf[PluginBase]/condition to the response with the 200 status

      response-optional-property-added

    • ○

      the hide_credentials response's property default value changed from false to true for the status 200

      response-property-default-value-changed

  • 65f3141f166222See the full diff
    • ●

      removed the request property name

      request-property-removed

    • ●

      removed the optional property name from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional request property allOf[Oauth2PluginConfig]/name

      new-optional-request-property

    • ○

      added the optional property allOf[Oauth2PluginConfig]/name to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 740b73588ef41See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 11 revisions, 1 has no diff computed.