このページは、まだ日本語ではご利用いただけません。翻訳中です。
古いプラグインバージョンのドキュメントを閲覧しています。
構成
このプラグインはDB-lessモードと部分的に互換性があります。
Consumers and credentials can be created with declarative configuration.
Admin API endpoints that do POST, PUT, PATCH, or DELETE on credentials are not available on DB-less mode.
互換性のあるプロトコル
Key Authentication - Encryptedプラグインは以下のプロトコルに対応しています:
grpc
, grpcs
, http
, https
パラメータ
このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。
-
name or plugin
string requiredプラグイン名。この場合は
key-auth-enc
。- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
name
です。 - Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドは
plugin
です。
- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
-
service.name or service.id
stringプラグインが対象とするサービス名または ID。最上位の
/plugins
エンドポイント. からプラグインをサービスに追加する場合は、これらのパラメータのいずれかを設定してください/services/{serviceName|Id}/plugins
を使用する場合は必要ありません。 -
route.name or route.id
stringプラグインがターゲットとするルート名または ID。最上位の
/plugins
エンドポイント. を通るルートにプラグインを追加する場合は、これらのパラメータのいずれかを設定してください/routes/{routeName|Id}/plugins
を使用する場合は必要ありません。 -
enabled
boolean default:true
このプラグインが適用されるかどうか。
-
config
record required-
key_names
array of typestring
required default:apikey
Describes an array of parameter names where the plugin will look for a key. The client must send the authentication key in one of those key names, and the plugin will try to read the credential from a header, request body, or query string parameter with the same name.
Key names may only contain [a-z], [A-Z], [0-9], [_] underscore, and [-] hyphen.
-
hide_credentials
boolean default:false
An optional boolean value telling the plugin to show or hide the credential from the upstream service. If
true
, the plugin strips the credential from the request (i.e., the header, query string, or request body containing the key) before proxying it.
-
anonymous
stringAn optional string (consumer UUID) value to use as an anonymous consumer if authentication fails. If empty (default), the request will fail with an authentication failure
4xx
. Note that this value must refer to the consumerid
attribute that is internal to Kong Gateway, and not itscustom_id
.
-
key_in_header
boolean default:true
If enabled (default), the plugin reads the request header and tries to find the key in it.
-
key_in_query
boolean default:true
If enabled (default), the plugin reads the query parameter in the request and tries to find the key in it.
-
key_in_body
boolean default:false
If enabled, the plugin reads the request body (if said request has one and its MIME type is supported) and tries to find the key in it. Supported MIME types:
application/www-form-urlencoded
,application/json
, andmultipart/form-data
.
-
run_on_preflight
boolean default:true
A boolean value that indicates whether the plugin should run (and try to authenticate) on
OPTIONS
preflight requests. If set tofalse
, thenOPTIONS
requests are always allowed.
-