Skip to main content

ACL Plugin Reference

FieldTypeDefaultOptionalLimitationsDescription
Running Modestring-NoOptional Values: "Allow", "Deny"Specify the running mode.
Rejected Status Codeinteger403Yes200 <= Rejected Status Code <= 599Specify the status code sent by Apache APISIX when request is rejected.
Error MessagestringThe consumer is forbidden.YesSpecify the response body sent by Apache APISIX when request is rejected.

Allow Mode

FieldTypeDefaultOptionalLimitationsDescription
Allowed Consumersstring array-YesAllowed Consumer list.
Allowed Consumer Labelsstring array-YesLabel list of allowed Consumers.
note

At lease one field between Allowed Consumers and Allowed Consumer Labels should be specified.

Deny Mode

FieldTypeDefaultOptionalLimitationsDescription
Denied Consumersstring array-YesDenied Consumer list.
Denied Consumer Labelsstring array-YesLabel list of denied Consumers.
note

At lease one field between Denied Consumers and Denied Consumer Labels should be specified.


API7.ai Logo

API Management for Modern Architectures with Edge, API Gateway, Kubernetes, and Service Mesh.

Product

API7 Cloud

SOC2 Type IRed Herring

Copyright © APISEVEN Ltd. 2019 – 2024. Apache, Apache APISIX, APISIX, and associated open source project names are trademarks of the

Apache Software Foundation