跳到主要内容

参数​

有关所有插件通用的配置选项，请参阅插件通用配置。

  • external_user_label_field

    string

    默认值：groups

    包含外部用户标签的字段。对于顶层值，请使用字段名；对于嵌套值，请使用 JSONPath 表达式。

    所选值可以是列表、序列化的 JSON 数组、带分隔符的字符串或标量字符串。当该值需要显式解析时，请配置 external_user_label_field_parser。

  • external_user_label_field_key

    string

    用于将 JSONPath 表达式选中的值与 allow_labels 或 deny_labels 进行匹配的键。例如，当 external_user_label_field 为 $.orgs..team 且访问控制列表使用 team 键时，请将此字段设置为 team。

  • external_user_label_field_parser

    string

    有效值：

    segmented_text、json 或 table

    用于解析所选外部用户标签值的解析器。

    对序列化的 JSON 数组使用 json，对带分隔符的字符串使用 segmented_text，对列表使用 table。省略此字段时，插件会自动处理列表、JSON 数组字符串、逗号分隔字符串和标量字符串。

  • external_user_label_field_separator

    string

    当 external_user_label_field_parser 为 segmented_text 时，用于拆分标签的正则表达式。

  • allow_labels

    object

    允许请求的标签。配置此字段且没有值匹配 deny_labels 时，至少需要有一个值匹配。

    至少配置 allow_labels 和 deny_labels 中的一项。

  • deny_labels

    object

    拒绝请求的标签。在评估 allow_labels 之前，任何匹配值都会拒绝请求。

    至少配置 allow_labels 和 deny_labels 中的一项。

  • rejected_code

    integer

    默认值：403

    有效值：

    大于或等于 200

    请求被拒绝时返回的 HTTP 状态码。

  • rejected_msg

    string

    默认值：The consumer is forbidden.

    请求被拒绝时返回的错误消息。省略此字段时，插件返回 The consumer is forbidden.。