› › ›

设置安全用户处理器

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

索引请求需要已验证的用户。

表 42. 设置安全用户选项

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

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

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

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