身份验证 API

编辑

允许您提交带有基本身份验证头的请求,以验证用户身份并检索有关已验证用户的信息。

请求

编辑

GET /_security/_authenticate

描述

编辑

成功调用会返回一个 JSON 结构,其中显示用户信息,例如用户名、分配给用户的角色、任何已分配的元数据以及有关验证和授权用户的领域的信息。

响应代码

编辑

如果无法验证用户身份,此 API 将返回 401 状态代码。

示例

编辑

要验证用户身份,请向 /_security/_authenticate 端点提交 GET 请求

resp = client.security.authenticate()
print(resp)
const response = await client.security.authenticate();
console.log(response);
GET /_security/_authenticate

以下示例输出提供了有关“rdeniro”用户的信息

{
  "username": "rdeniro",
  "roles": [
    "admin"
  ],
  "full_name": null,
  "email":  null,
  "metadata": { },
  "enabled": true,
  "authentication_realm": {
    "name" : "file",
    "type" : "file"
  },
  "lookup_realm": {
    "name" : "file",
    "type" : "file"
  },
  "authentication_type": "realm"
}