› › ›

设置安全用户处理器

设置安全用户处理器编辑

通过预处理摄取，将当前认证用户的用户相关详细信息（例如 username、roles、email、full_name、metadata、api_key、realm 和 authentication_type）设置到当前文档中。 api_key 属性仅在用户使用 API 密钥进行身份验证时存在。它是一个包含 API 密钥的 id、name 和 metadata（如果存在且非空）字段的对象。 realm 属性也是一个包含两个字段的对象，name 和 type。使用 API 密钥身份验证时，realm 属性引用创建 API 密钥的领域。 authentication_type 属性是一个字符串，可以从 REALM、API_KEY、TOKEN 和 ANONYMOUS 中取值。

索引请求需要经过身份验证的用户。

表 41. 设置安全用户选项

名称	必需	默认值	描述
`field`	是	-	用于存储用户信息的字段。
`properties`	否	[`username`, `roles`, `email`, `full_name`, `metadata`, `api_key`, `realm`, `authentication_type`]	控制向 `field` 添加哪些用户相关属性。
`description`	否	-	处理器的描述。用于描述处理器的目的或其配置。
`if`	否	-	有条件地执行处理器。请参阅有条件地运行处理器。
`ignore_failure`	否	`否`	忽略处理器的错误。请参阅处理管道错误。
`on_failure`	否	-	处理处理器的错误。请参阅处理管道错误。
`tag`	否	-	处理器的标识符。用于调试和指标。

以下示例将当前认证用户的全部用户详细信息添加到所有由此管道处理的文档的 user 字段中

{
  "processors" : [
    {
      "set_security_user": {
        "field": "user"
      }
    }
  ]
}

« 设置处理器排序处理器 »