--- title: "Create a BasicAuth plugin" method: POST path: "/{workspace}/plugins#BasicAuth" tags: ["Plugins"] --- # Create a BasicAuth plugin `POST /{workspace}/plugins#BasicAuth` Create a BasicAuth plugin ## Request body - BasicAuthPlugin — 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` 'basic-auth', 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 - `anonymous` string — An optional string (Consumer UUID or username) value to use as an "anonymous" consumer if authentication fails. If empty (default null), the request will fail with an authentication failure `4xx`. Please note that this value must refer to the Consumer `id` or `username` attribute, and **not** its `custom_id`. - `brute_force_protection` object - `redis` object — Redis configuration - `cloud_authentication` object — Cloud auth related configs for connecting to a Cloud Provider's Redis instance. - `auth_provider` 'aws' | 'azure' | 'gcp' — Auth providers to be used to authenticate to a Cloud Provider's Redis instance. - `aws_access_key_id` string — AWS Access Key ID to be used for authentication when `auth_provider` is set to `aws`. - `aws_assume_role_arn` string — The ARN of the IAM role to assume for generating ElastiCache IAM authentication tokens. - `aws_cache_name` string — The name of the AWS Elasticache cluster when `auth_provider` is set to `aws`. - `aws_is_serverless` boolean — This flag specifies whether the cluster is serverless when auth_provider is set to `aws`. - `aws_region` string — The region of the AWS ElastiCache cluster when `auth_provider` is set to `aws`. - `aws_role_session_name` string — The session name for the temporary credentials when assuming the IAM role. - `aws_secret_access_key` string — AWS Secret Access Key to be used for authentication when `auth_provider` is set to `aws`. - `azure_client_id` string — Azure Client ID to be used for authentication when `auth_provider` is set to `azure`. - `azure_client_secret` string — Azure Client Secret to be used for authentication when `auth_provider` is set to `azure`. - `azure_tenant_id` string — Azure Tenant ID to be used for authentication when `auth_provider` is set to `azure`. - `gcp_service_account_json` string — GCP Service Account JSON to be used for authentication when `auth_provider` is set to `gcp`. - `database` integer — Database to use for the Redis connection when using the `redis` strategy - `host` string — A string representing a host name, such as example.com. - `password` string — Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis. - `port` integer — An integer representing a port number between 0 and 65535, inclusive. - `server_name` string — A string representing an SNI (server name indication) value for TLS. - `ssl` boolean — If set to true, uses SSL to connect to Redis. - `ssl_verify` boolean — If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly. - `timeout` integer — An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. - `username` string — Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`. - `strategy` 'cluster' | 'memory' | 'off' | 'redis' — The brute force protection strategy to use for retrieving and incrementing the limits. Available values are: `cluster`, `redis`, `memory`, and `off`. - `hide_credentials` boolean — An optional boolean value telling the plugin to show or hide the credential from the upstream service. If `true`, the plugin will strip the credential from the request (i.e. the `Authorization` header) before proxying it. - `principals` object - `directory` string — The Kong Identity directory instance to authenticate against. - `enabled` boolean — When true, authenticate against Kong Identity instead of local credentials. - `error_on_miss` boolean — When true (default), return 401 if no matching principal is found in Kong Identity. When false, allow the request to continue unauthenticated instead. - `realm` string — When authentication fails the plugin sends `WWW-Authenticate` header with `realm` attribute value. - `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 BasicAuth plugin - BasicAuthPlugin — 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` 'basic-auth', 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 - `anonymous` string — An optional string (Consumer UUID or username) value to use as an "anonymous" consumer if authentication fails. If empty (default null), the request will fail with an authentication failure `4xx`. Please note that this value must refer to the Consumer `id` or `username` attribute, and **not** its `custom_id`. - `brute_force_protection` object - `redis` object — Redis configuration - `cloud_authentication` object — Cloud auth related configs for connecting to a Cloud Provider's Redis instance. - `auth_provider` 'aws' | 'azure' | 'gcp' — Auth providers to be used to authenticate to a Cloud Provider's Redis instance. - `aws_access_key_id` string — AWS Access Key ID to be used for authentication when `auth_provider` is set to `aws`. - `aws_assume_role_arn` string — The ARN of the IAM role to assume for generating ElastiCache IAM authentication tokens. - `aws_cache_name` string — The name of the AWS Elasticache cluster when `auth_provider` is set to `aws`. - `aws_is_serverless` boolean — This flag specifies whether the cluster is serverless when auth_provider is set to `aws`. - `aws_region` string — The region of the AWS ElastiCache cluster when `auth_provider` is set to `aws`. - `aws_role_session_name` string — The session name for the temporary credentials when assuming the IAM role. - `aws_secret_access_key` string — AWS Secret Access Key to be used for authentication when `auth_provider` is set to `aws`. - `azure_client_id` string — Azure Client ID to be used for authentication when `auth_provider` is set to `azure`. - `azure_client_secret` string — Azure Client Secret to be used for authentication when `auth_provider` is set to `azure`. - `azure_tenant_id` string — Azure Tenant ID to be used for authentication when `auth_provider` is set to `azure`. - `gcp_service_account_json` string — GCP Service Account JSON to be used for authentication when `auth_provider` is set to `gcp`. - `database` integer — Database to use for the Redis connection when using the `redis` strategy - `host` string — A string representing a host name, such as example.com. - `password` string — Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis. - `port` integer — An integer representing a port number between 0 and 65535, inclusive. - `server_name` string — A string representing an SNI (server name indication) value for TLS. - `ssl` boolean — If set to true, uses SSL to connect to Redis. - `ssl_verify` boolean — If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly. - `timeout` integer — An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. - `username` string — Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`. - `strategy` 'cluster' | 'memory' | 'off' | 'redis' — The brute force protection strategy to use for retrieving and incrementing the limits. Available values are: `cluster`, `redis`, `memory`, and `off`. - `hide_credentials` boolean — An optional boolean value telling the plugin to show or hide the credential from the upstream service. If `true`, the plugin will strip the credential from the request (i.e. the `Authorization` header) before proxying it. - `principals` object - `directory` string — The Kong Identity directory instance to authenticate against. - `enabled` boolean — When true, authenticate against Kong Identity instead of local credentials. - `error_on_miss` boolean — When true (default), return 401 if no matching principal is found in Kong Identity. When false, allow the request to continue unauthenticated instead. - `realm` string — When authentication fails the plugin sends `WWW-Authenticate` header with `realm` attribute value. - `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)