ACL

Overview Examples Configuration reference Changelog API reference

Configuration

configobject

Hide Child Parameters

allowarray[string]

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

always_use_authenticated_groupsboolean

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.

Default:false

denyarray[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_headerboolean

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

Default:false

include_consumer_groupsboolean

If enabled (true), allows the consumer-groups to be used in the allow|deny fields

Default:false

protocolsarray[string]

A set of strings representing HTTP protocols.

Allowed values:grpcgrpcshttphttps

Default:grpc, grpcs, http, https

routeobject

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

serviceobject

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

ACL

Configuration

Did this doc help?

Help us make these docs great!

Still need help