禁用用户配置文件 API
编辑禁用用户配置文件 API编辑
用户配置文件功能仅供 Kibana 和 Elastic 的可观察性、企业搜索和 Elastic 安全解决方案使用。个人用户和外部应用程序不应直接调用此 API。Elastic 保留更改或删除此功能的权利,恕不另行通知。
禁用用户配置文件,使其在 用户配置文件搜索 中不可见。
先决条件编辑
要使用此 API,您必须具有 manage_user_profile
集群权限。
描述编辑
当您 激活用户配置文件 时,它会自动启用并在用户配置文件搜索中可见。您可以使用禁用用户配置文件 API 来禁用用户配置文件,使其在这些搜索中不可见。
要重新启用禁用的用户配置文件,请使用 启用用户配置文件 API 。
路径参数编辑
-
<uid>
- (必需,字符串) 用户配置文件的唯一标识符。
查询参数编辑
-
refresh
- (可选,枚举) 如果为
true
,Elasticsearch 将刷新受影响的分片以使此操作对搜索可见,如果为wait_for
,则等待刷新以使此操作对搜索可见,如果为false
,则不执行任何刷新操作。有效值:true
、false
、wait_for
。默认值:false
。
示例编辑
以下请求将禁用与 u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0
匹配的 uid
的用户配置文件
POST /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_disable