ACLPluginConfig

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ACLPluginConfig",
  "title": "ACLPluginConfig",
  "x-speakeasy-entity": "PluginACL",
  "properties": {
    "config": {
      "type": "object",
      "properties": {
        "allow": {
          "description": "Arbitrary group names that are allowed to consume the service or route. One of `config.allow` or `config.deny` must be specified.",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "always_use_authenticated_groups": {
          "description": "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.",
          "type": "boolean",
          "default": false
        },
        "deny": {
          "description": "Arbitrary group names that are not allowed to consume the service or route. One of `config.allow` or `config.deny` must be specified.",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "hide_groups_header": {
          "description": "If enabled (`true`), prevents the `X-Consumer-Groups` header from being sent in the request to the upstream service.",
          "type": "boolean",
          "default": false
        },
        "include_consumer_groups": {
          "description": "If enabled (`true`), allows the consumer-groups to be used in the `allow|deny` fields",
          "type": "boolean",
          "default": false
        }
      }
    },
    "name": {
      "const": "acl"
    },
    "protocols": {
      "description": "A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.",
      "type": "array",
      "items": {
        "enum": [
          "grpc",
          "grpcs",
          "http",
          "https",
          "ws",
          "wss"
        ],
        "type": "string"
      },
      "format": "set",
      "default": [
        "grpc",
        "grpcs",
        "http",
        "https"
      ]
    },
    "route": {
      "description": "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.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "service": {
      "description": "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.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    }
  }
}