ACL Configuration

You are browsing unreleased documentation.

Configuration

This plugin is partially compatible with DB-less mode.

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.

Compatible protocols

The ACL plugin is compatible with the following protocols:

grpc, grpcs, http, https

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration:

• name or plugin

  string required

  The name of the plugin, in this case acl.

  • If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is name.
  • If using the KongPlugin object in Kubernetes, the field is plugin.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example acl_my-service.

  The instance name shows up in Kong Manager and in Konnect, so it's useful when running the same plugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance via the Kong Admin API.

  An instance name must be unique within the following context:

  • Within a workspace for Kong Gateway Enterprise
  • Within a control plane or control plane group for Konnect
  • Globally for Kong Gateway (OSS)

• service.name or service.id

  string

  The name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level /plugins endpoint. Not required if using /services/{serviceName|Id}/plugins.

• route.name or route.id

  string

  The name or ID of the route the plugin targets. Set one of these parameters if adding the plugin to a route through the top-level /plugins endpoint. Not required if using /routes/{routeName|Id}/plugins.

• enabled

  boolean default: true

  Whether this plugin will be applied.

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