此 API 用于获取 Easysearch 安全模块中的内部用户配置信息。
API #
GET /_security/user
GET /_security/user/{name}
API 的作用 #
查询内部用户（internal users）的配置信息。可以：
- 获取所有用户：返回所有用户配置
- 获取指定用户：返回特定用户的配置信息
- 批量查询：通过参数查询多个用户
用户信息包括角色、属性等，但不包括密码哈希。
API 的参数 #
路由参数 #
| 参数 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
name | string | 可选 | 用户名 如果不提供，返回所有用户 |
查询字符串参数 #
| 参数 | 类型 | 是否必需 | 默认值 | 描述 |
|---|---|---|---|---|
name | string | 可选 | 所有用户 | 要查询的用户名列表 支持逗号分隔多个用户 例如： admin,alice,bob |
请求示例 #
# 获取所有用户
GET /_security/user
# 获取指定用户
GET /_security/user/admin
# 获取多个用户（通过查询参数）
GET /_security/user?name=admin,alice,bob
响应示例 #
成功响应 - 所有用户 #
{
"admin": {
"hash": "",
"roles": ["security_admin"],
"attributes": {}
},
"alice": {
"hash": "",
"roles": ["viewer"],
"attributes": {
"department": "IT"
}
},
"bob": {
"hash": "",
"roles": ["editor", "viewer"],
"attributes": {}
}
}
成功响应 - 指定用户 #
{
"admin": {
"hash": "",
"roles": ["security_admin"],
"attributes": {}
}
}
响应字段说明 #
| 字段 | 描述 |
|---|---|
| 用户名（键） | 用户的唯一标识符 |
hash | 密码哈希 查询时显示为空字符串 |
roles | 用户分配的角色列表 |
attributes | 用户自定义属性 |
使用场景 #
- 用户管理：查看系统中的所有用户
- 权限检查：检查用户的角色分配
- 审计日志：记录用户配置变更
- 问题排查：诊断用户登录问题
权限说明 #
- 普通用户：只能查询自己的信息
- 管理员：可以查询所有用户信息
- 隐藏用户：只有超级管理员可以查看
注意事项 #
- 密码哈希在查询时不会显示（显示为空字符串）
- 隐藏用户对非超级管理员不可见
- 需要相应的安全权限才能执行此操作
