---
title: "Create a Oauth2 plugin"
method: POST
path: "/{workspace}/plugins#Oauth2"
tags: ["Plugins"]
---

# Create a Oauth2 plugin

`POST /{workspace}/plugins#Oauth2`

Create a Oauth2 plugin

## Request body

- Oauth2Plugin — A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the [Kong Hub](https://docs.konghq.com/hub/). When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the `service` and `consumer` fields.
  - `condition` string, 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_at` integer, nullable — Unix epoch when the resource was created.
  - `enabled` boolean, nullable — Whether the plugin is applied.
  - `id` string, nullable — A string representing a UUID (universally unique identifier).
  - `instance_name` string, 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.
  - `ordering` object, nullable
    - `after` object
      - `access` string[]
    - `before` object
      - `access` string[]
  - `partials` object[] — A list of partials to be used by the plugin.
    - `id` string — A string representing a UUID (universally unique identifier).
    - `name` string — A unique string representing a UTF-8 encoded name.
    - `path` string
  - `tags` string[], nullable — An optional set of strings associated with the Plugin for grouping and filtering.
  - `updated_at` integer, nullable — Unix epoch when the resource was last updated.
  - `config` object
    - `accept_http_if_already_terminated` boolean — Accepts HTTPs requests that have already been terminated by a proxy or load balancer.
    - `anonymous` string — An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
    - `auth_header_name` string — The name of the header that is supposed to carry the access token.
    - `enable_authorization_code` boolean — An optional boolean value to enable the three-legged Authorization Code flow (RFC 6742 Section 4.1).
    - `enable_client_credentials` boolean — An optional boolean value to enable the Client Credentials Grant flow (RFC 6742 Section 4.4).
    - `enable_implicit_grant` boolean — 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_password_grant` boolean — An optional boolean value to enable the Resource Owner Password Credentials Grant flow (RFC 6742 Section 4.3).
    - `global_credentials` boolean — 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`.
    - `hide_credentials` boolean — An optional boolean value telling the plugin to show or hide the credential from the upstream service.
    - `mandatory_scope` boolean — An optional boolean value telling the plugin to require at least one `scope` to be authorized by the end user.
    - `persistent_refresh_token` boolean
    - `pkce` 'lax' | 'none' | 'strict' — Specifies a mode of how the Proof Key for Code Exchange (PKCE) should be handled by the plugin.
    - `provision_key` string — The unique key the plugin has generated when it has been added to the Service.
    - `realm` string — When authentication fails the plugin sends `WWW-Authenticate` header with `realm` attribute value.
    - `refresh_token_ttl` number — Time-to-live value for data
    - `reuse_refresh_token` boolean — An optional boolean value that indicates whether an OAuth refresh token is reused when refreshing an access token.
    - `scopes` string[] — Describes an array of scope names that will be available to the end user. If `mandatory_scope` is set to `true`, then `scopes` are required.
    - `token_expiration` number — 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.
  - `protocols` string[] — 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.
  - `route` object — If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
    - `id` string
  - `service` object — If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    - `id` string

## Response `201`

Created Oauth2 plugin

- Oauth2Plugin — A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the [Kong Hub](https://docs.konghq.com/hub/). When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the `service` and `consumer` fields.
  - `condition` string, 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_at` integer, nullable — Unix epoch when the resource was created.
  - `enabled` boolean, nullable — Whether the plugin is applied.
  - `id` string, nullable — A string representing a UUID (universally unique identifier).
  - `instance_name` string, 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.
  - `ordering` object, nullable
    - `after` object
      - `access` string[]
    - `before` object
      - `access` string[]
  - `partials` object[] — A list of partials to be used by the plugin.
    - `id` string — A string representing a UUID (universally unique identifier).
    - `name` string — A unique string representing a UTF-8 encoded name.
    - `path` string
  - `tags` string[], nullable — An optional set of strings associated with the Plugin for grouping and filtering.
  - `updated_at` integer, nullable — Unix epoch when the resource was last updated.
  - `config` object
    - `accept_http_if_already_terminated` boolean — Accepts HTTPs requests that have already been terminated by a proxy or load balancer.
    - `anonymous` string — An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
    - `auth_header_name` string — The name of the header that is supposed to carry the access token.
    - `enable_authorization_code` boolean — An optional boolean value to enable the three-legged Authorization Code flow (RFC 6742 Section 4.1).
    - `enable_client_credentials` boolean — An optional boolean value to enable the Client Credentials Grant flow (RFC 6742 Section 4.4).
    - `enable_implicit_grant` boolean — 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_password_grant` boolean — An optional boolean value to enable the Resource Owner Password Credentials Grant flow (RFC 6742 Section 4.3).
    - `global_credentials` boolean — 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`.
    - `hide_credentials` boolean — An optional boolean value telling the plugin to show or hide the credential from the upstream service.
    - `mandatory_scope` boolean — An optional boolean value telling the plugin to require at least one `scope` to be authorized by the end user.
    - `persistent_refresh_token` boolean
    - `pkce` 'lax' | 'none' | 'strict' — Specifies a mode of how the Proof Key for Code Exchange (PKCE) should be handled by the plugin.
    - `provision_key` string — The unique key the plugin has generated when it has been added to the Service.
    - `realm` string — When authentication fails the plugin sends `WWW-Authenticate` header with `realm` attribute value.
    - `refresh_token_ttl` number — Time-to-live value for data
    - `reuse_refresh_token` boolean — An optional boolean value that indicates whether an OAuth refresh token is reused when refreshing an access token.
    - `scopes` string[] — Describes an array of scope names that will be available to the end user. If `mandatory_scope` is set to `true`, then `scopes` are required.
    - `token_expiration` number — 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.
  - `protocols` string[] — 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.
  - `route` object — If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
    - `id` string
  - `service` object — If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    - `id` string

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.net/kong/apis/kong-enterprise-admin-api.md) · [All operations](https://skmtc.net/kong/apis/kong-enterprise-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kong/kong-enterprise-admin-api/revisions/28b1f8a59cdc/schema)