Key Auth Configuration

このページは、まだ日本語ではご利用いただけません。翻訳中です。

構成

このプラグインは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 Authプラグインは以下のプロトコルに対応しています：

grpc, grpcs, http, https, ws, wss

パラメータ

このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。

• name or plugin

  string required

  プラグイン名。この場合は key-auth 。

  • Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドはnameです。
  • Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドはpluginです。

• instance_name

  string

  プラグインのインスタンスを識別するための任意のカスタム名 (例: key-auth_my-service 。

  インスタンス名はKong ManagerとKonnectに表示されるので、 例えば複数のサービスで同じプラグインを複数のコンテキストで実行する場合に便利です。また、Kong Admin API経由で特定のプラグインインスタンスに アクセスするためにも使用できます。

  インスタンス名は、次のコンテキスト内で一意である必要があります。

  • Kong Gateway Enterpriseのワークスペース内
  • Konnectのコントロールプレーン（CP）またはコントロールプレーン（CP）グループ内
  • Kong Gateway (OSS)の全世界

• 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 type string required default: apikey

    Describes an array of parameter names where the plugin will look for a key. The key names may only contain [a-z], [A-Z], [0-9], [_] underscore, and [-] hyphen.

  • hide_credentials

    boolean required 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.

  • 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.

  • key_in_header

    boolean required default: true

    If enabled (default), the plugin reads the request header and tries to find the key in it.

  • key_in_query

    boolean required 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 required default: false

    If enabled, the plugin reads the request body. Supported MIME types: application/www-form-urlencoded, application/json, and multipart/form-data.

  • run_on_preflight

    boolean required default: true

    A boolean value that indicates whether the plugin should run (and try to authenticate) on OPTIONS preflight requests. If set to false, then OPTIONS requests are always allowed.

  • realm

    string

    When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.

  • identity_realms

    set of type record default: {"scope"=>"cp", "region"=>nil, "id"=>nil}

    A configuration of Konnect Identity Realms that indicate where to source a consumer from.

    • scope

      string Must be one of: cp, realm

    • id

      string

      A string representing a UUID (universally unique identifier).

    • region

      string