--- title: "Create a Oauth2 plugin" method: POST path: "/plugins#Oauth2" tags: ["Plugins"] --- # Create a Oauth2 plugin `POST /plugins#Oauth2` Create a Oauth2 plugin ## Request body - CreateOauth2Plugin - `config` object — The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/). - `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` 'none' | 'lax' | '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. - `created_at` integer — Unix epoch when the resource was created. - `enabled` boolean — Whether the plugin is applied. - `id` string - `instance_name` string - `name` 'oauth2' — The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately. - `ordering` object - `after` object - `access` string[] - `before` object - `access` string[] - `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"`. - `tags` string[] — An optional set of strings associated with the Plugin for grouping and filtering. - `updated_at` integer — Unix epoch when the resource was last updated. - `consumer` object — If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer. - `id` string - `consumer_group` object - `id` string - `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 - `config` object — The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/). - `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` 'none' | 'lax' | '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. - `created_at` integer — Unix epoch when the resource was created. - `enabled` boolean — Whether the plugin is applied. - `id` string - `instance_name` string - `name` 'oauth2' — The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately. - `ordering` object - `after` object - `access` string[] - `before` object - `access` string[] - `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"`. - `tags` string[] — An optional set of strings associated with the Plugin for grouping and filtering. - `updated_at` integer — Unix epoch when the resource was last updated. - `consumer` object — If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer. - `id` string - `consumer_group` object - `id` string - `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 ## Changes > 3 revisions in range; 1 not diffed. - **2024-09-11** `5bd52189d290` — 6 info - added the new optional request property `allOf[#/components/schemas/Oauth2PluginConfig]/config/realm` - added the new optional request property `allOf[#/components/schemas/Plugin]/allOf[#/components/schemas/PluginWithoutParents]/ordering/after` - added the new optional request property `allOf[#/components/schemas/Plugin]/allOf[#/components/schemas/PluginWithoutParents]/ordering/before` - added the optional property `allOf[#/components/schemas/Oauth2PluginConfig]/config/realm` to the response with the `201` status - …2 more [Change history](https://skmtc.dev/kong/apis/kong-enterprise-admin-api/changes/plugins#Oauth2/post.md) --- [API](https://skmtc.dev/kong/apis/kong-enterprise-admin-api.md) · [All operations](https://skmtc.dev/kong/apis/kong-enterprise-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/kong/kong-enterprise-admin-api/revisions/5bd52189d290/schema)