禁用用户配置文件 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 的用户配置文件
resp = client.security.disable_user_profile(
uid="u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0",
)
print(resp)
const response = await client.security.disableUserProfile({
uid: "u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0",
});
console.log(response);
POST /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_disable