Skip to main content
API7.ai Logo

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.

    consumer_group_id is usable in APISIX. API7 Gateway inherits the schema value but does not assign group IDs; selecting it causes requests to return HTTP 401.

  • whitelist

    array[string]

    List of objects to whitelist.

    Configure at least one of whitelist, blacklist, and allowed_by_methods.

    When combined, a matching blacklist entry rejects first. A matching whitelist entry then allows the request without evaluating allowed_by_methods. A value absent from the whitelist remains rejected even if allowed_by_methods would allow its method.

  • blacklist

    array[string]

    List of objects to blacklist.

    Configure at least one of whitelist, blacklist, and allowed_by_methods.

    A matching blacklist entry always rejects the request, including when the same value is also whitelisted.

  • allowed_by_methods

    array[object]

    List of key-value pairs of consumer name and their corresponding HTTP methods allowed.

    Configure at least one of whitelist, blacklist, and allowed_by_methods.

    Method restrictions are evaluated only for values that are not whitelisted. If a value has no entry in this list, this field does not restrict its 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

    vaild vaule:

    greater than or equal to 200

    HTTP status code to return when the request is rejected.

  • rejected_msg

    string

    Error message to return when the request is rejected.