Consumer Restriction

Parameters

See plugin common configurations for configuration options available to all plugins.

type
string
default: consumer_name
vaild vaule:
consumer_name, consumer_group_id, service_id, or route_id
Key type to restrict by.
whitelist
array[string]
List of objects to whitelist.
At least one of whitelist, blacklist, and allowed_by_methods should be configured. If all are configured, the precedence is blacklist > whitelist > allowed_by_methods.
blacklist
array[string]
List of objects to blacklist.
At least one of whitelist, blacklist, and allowed_by_methods should be configured. If all are configured, the precedence is blacklist > whitelist > allowed_by_methods.
allowed_by_methods
array[object]
List of key-value pairs of consumer name and their corresponding HTTP methods allowed.
At least one of whitelist, blacklist, and allowed_by_methods should be configured. If all are configured, the precedence is blacklist > whitelist > allowed_by_methods.
- user
  string
  Consumer username.
- methods
  array[string]
  vaild vaule:
  Any combination of the GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, CONNECT, TRACE, PURGE methods
  List of allowed HTTP methods for the consumer.
rejected_code
integer
default: 403
HTTP status code to return when the request is rejected.
rejected_msg
string
Error message to return when the request is rejected.