› › ›

获取用户 API

编辑

获取用户 API

编辑

检索原生领域和内置用户的用户信息。

请求

编辑

GET /_security/user

GET /_security/user/<用户名>

先决条件

编辑

要使用此 API，您必须至少拥有 read_security 集群权限。

描述

编辑

有关原生领域的更多信息，请参阅领域和原生用户身份验证。

路径参数

编辑

用户名: （可选，字符串）用户的标识符。您可以将多个用户名指定为逗号分隔的列表。如果省略此参数，则 API 会检索所有用户的相关信息。

查询参数

编辑

with_profile_uid: （可选，布尔值）确定是否检索用户的用户配置文件 uid（如果存在）。默认为 false。

响应体

编辑

成功的调用将返回一个用户数组，其中包含用户的 JSON 表示形式。请注意，不包含用户密码。

响应代码

编辑

如果用户未在 native 领域中定义，则请求返回 404。

示例

编辑

要检索原生用户，请向 /_security/user/<username> 端点提交 GET 请求

resp = client.security.get_user(
    username="jacknich",
)
print(resp)

const response = await client.security.getUser({
  username: "jacknich",
});
console.log(response);

GET /_security/user/jacknich

{
  "jacknich": {
    "username": "jacknich",
    "roles": [
      "admin", "other_role1"
    ],
    "full_name": "Jack Nicholson",
    "email": "[email protected]",
    "metadata": { "intelligence" : 7 },
    "enabled": true
  }
}

要在响应中检索用户 profile_uid

resp = client.security.get_user(
    username="jacknich",
    with_profile_uid=True,
)
print(resp)

const response = await client.security.getUser({
  username: "jacknich",
  with_profile_uid: "true",
});
console.log(response);

GET /_security/user/jacknich?with_profile_uid=true

{
  "jacknich": {
    "username": "jacknich",
    "roles": [
      "admin", "other_role1"
    ],
    "full_name": "Jack Nicholson",
    "email": "[email protected]",
    "metadata": { "intelligence" : 7 },
    "enabled": true,
    "profile_uid": "u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0"
  }
}

省略用户名以检索所有用户

resp = client.security.get_user()
print(resp)

const response = await client.security.getUser();
console.log(response);

GET /_security/user

« 获取用户权限 API 授予 API 密钥 API »