Skip to content

用户 API ​

用户管理接口。

版本说明:企业版独有。个人版为本地单用户,无用户管理接口。所有路径位于 /api/v1/admin/users 前缀(注意并非 /api/users)。默认端口 8080。


GET /api/v1/admin/users ​

获取用户列表(分页)。

查询参数: page(默认 1)、page_size(默认 20)、role(admin/member/viewer)、tenant_id。

响应:

json
{
  "code": 0,
  "data": {
    "items": [
      {
        "id": "usr_2k8x9m3n",
        "username": "admin",
        "email": "admin@example.com",
        "role": "admin",
        "tenant_id": "tnt_default",
        "status": "active",
        "last_login": "2026-08-05T10:30:00Z",
        "created_at": "2026-01-01T00:00:00Z"
      }
    ],
    "total": 25,
    "page": 1,
    "page_size": 10
  },
  "message": "ok",
  "request_id": "req_abc123"
}

POST /api/v1/admin/users ​

创建用户。

字段类型必填说明
usernamestring✅用户名,3–32 字符
passwordstring✅密码,至少 8 字符
emailstring✅邮箱
rolestring-member(默认)/admin/viewer
tenant_idstring-所属租户 ID

GET /api/v1/admin/users/:id ​

获取用户详情。


PUT /api/v1/admin/users/:id ​

更新用户(用户名、邮箱、角色、状态等)。


DELETE /api/v1/admin/users/:id ​

删除用户。


PUT /api/v1/admin/users/:id/password ​

修改用户密码。


PUT /api/v1/admin/users/:id/role ​

修改用户角色。


API Key 管理 ​

方法路径说明
GET/api/v1/admin/users/:id/api-keys列出用户的 API Key
POST/api/v1/admin/users/:id/api-keys签发 API Key(可作 Bearer 令牌使用)
DELETE/api/v1/admin/users/:id/api-keys/:keyId吊销指定 Key

GDPR ​

DELETE /api/v1/admin/users/:id/gdpr —— 按 GDPR 擦除该用户数据(企业版合规能力)。


错误码 ​

场景codemessage
用户不存在40400用户不存在
用户名已存在40900用户名已被注册
邮箱已注册40900邮箱已被使用
不能删除自己40300不能删除当前登录用户