Basic Authentication設定

古いプラグインバージョンのドキュメントを閲覧しています。

構成

このプラグインはDB-lessモードと部分的に互換性があります。

Consumers and Credentials can be created with declarative configuration.

Admin API endpoints which do POST, PUT, PATCH or DELETE on Credentials are not available on DB-less mode.

互換性のあるプロトコル

Basic Authenticationプラグインは以下のプロトコルに対応しています：

grpc, grpcs, http, https, ws, wss

パラメータ

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

• name or plugin

  string required

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

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

• instance_name

  string

  プラグインのインスタンスを識別するための任意のカスタム名 (例: basic-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
  • anonymous

    string

    認証に失敗した場合に「匿名」コンシューマとして使用するオプションの文字列（消費者のUUIDまたはユーザー名）の値。空の場合（デフォルトはnull）、リクエストは認証失敗 4xx で失敗します。この値はコンシューマのcustom_idではなく、idまたはusername属性を参照している必要があることに注意してください。

  • hide_credentials

    boolean required default: false

    アップストリームサービスの認証情報を表示または非表示にするようにプラグインに指示するオプションのブール値。trueの場合、プラグインはリクエストをプロキシする前にリクエストから認証情報（つまり、Authorizationヘッダー）を削除します。

  • realm

    string required default: service

    認証が失敗すると、プラグインはrealm属性値を含むWWW-Authenticateヘッダーを送信します。