« 激活用户资料 API 启用用户资料 API »

› › ›

禁用用户资料 API

禁用用户资料 API

用户资料功能仅供 Kibana 和 Elastic 的可观察性、企业搜索和 Elastic Security 解决方案使用。单个用户和外部应用程序不应直接调用此 API。Elastic 保留在未来版本中更改或删除此功能的权利，恕不另行通知。

禁用用户资料，使其在用户资料搜索中不可见。

请求

POST /_security/profile/<uid>/_disable

PUT /_security/profile/<uid>/_disable

先决条件

要使用此 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

« 激活用户资料 API 启用用户资料 API »