コンテンツにスキップ
|
Plugin Hub
report-issue問題を報告する
header icon

ACL設定

By Kong Inc.

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

構成

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

Consumers and ACLs can be created with declarative configuration.

Admin API endpoints that POST, PUT, PATCH, or DELETE ACLs do not work in DB-less mode.

互換性のあるプロトコル

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

grpc, grpcs, http, https

パラメータ

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

  • name or plugin

    string required

    プラグイン名。この場合は acl 。

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

  • instance_name

    string

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

    • allow

      array of type string

      Arbitrary group names that are allowed to consume the service or route. One of config.allow or config.deny must be specified.

    • deny

      array of type string

      Arbitrary group names that are not allowed to consume the service or route. One of config.allow or config.deny must be specified.

    • hide_groups_header

      boolean required default: false

      If enabled (true), prevents the X-Consumer-Groups header from being sent in the request to the upstream service.

    • include_consumer_groups

      boolean default: false

    • always_use_authenticated_groups

      boolean required default: false

      If enabled (true), the authenticated groups will always be used even when an authenticated consumer already exists. If the authenticated groups don’t exist, it will fallback to use the groups associated with the consumer. By default the authenticated groups will only be used when there is no consumer or the consumer is anonymous.