获取用户 API编辑

检索本机领域和内置用户的信息。

请求编辑

GET /_security/user

GET /_security/user/<username>

先决条件编辑

  • 要使用此 API,您必须至少具有 read_security 集群权限。

描述编辑

有关本机领域的更多信息,请参阅 领域本机用户身份验证

路径参数编辑

username
(可选,字符串)用户的标识符。您可以将多个用户名指定为逗号分隔的列表。如果省略此参数,则 API 将检索所有用户的信息。

查询参数编辑

with_profile_uid
(可选,布尔值)确定是否检索用户的 uid,如果存在。默认为 false

响应正文编辑

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

响应代码编辑

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

示例编辑

要检索本机用户,请向 /_security/user/<username> 端点提交 GET 请求

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 作为响应的一部分

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"
  }
}

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

GET /_security/user