Skip to main content

Module consumer_restriction

Module consumer_restriction 

Source
Expand description

Consumer allow/deny list plugin (consumer-restriction).

Restricts which already-authenticated consumers may reach a route. It does not authenticate — an upstream auth node (e.g. key-auth) must have attached the consumer identity first (the consumer.* keys in context.message). This plugin then matches the consumer’s name or group against a configured whitelist/blacklist and, optionally, restricts a named consumer to specific HTTP methods.

Structs§

AllowedByMethod 🔒
A per-consumer HTTP-method allowlist entry.
ConsumerRestrictionPlugin
Restricts access based on the attached consumer’s name or group.

Enums§

RestrictionType 🔒
What consumer attribute the lists match against.