API 参考 / admin

用户列表(平台超管)

GET /api/v1/admin/users · adminListUsers

跨组织用户分页列表。可按邮箱/名称模糊(query)、账号状态(status)、平台角色(platformRole)过滤。 分页统一 page(1 起)+ pageSize(默认 20,上限 100)。要求平台超管。

本接口要求浏览器会话。Bearer API Token 无法调用——Token 的生命周期管理必须在网页端完成。

参数

query
string —— 邮箱模糊搜索词(ILIKE,服务端参数化 + 通配转义)。
status
string —— 按账号状态过滤(active|suspended|deleted);空为全部。
platformRole
string —— 按平台角色过滤(user|superadmin);空为全部。
page
integer —— 页码(1 起);缺省或非法为 1。平台运营面分页统一 page + pageSize。
pageSize
integer —— 每页条数,默认 20,上限 100。平台运营面分页统一 page + pageSize。

响应字段 · 200

items(必填)
AdminUserSummary[]
items[].id(必填)
string
items[].email(必填)
string
items[].status(必填)
enum;取值:active / suspended / deleted
items[].platformRole(必填)
enum;取值:user / superadmin
items[].emailVerified(必填)
boolean
items[].orgCount(必填)
integer
items[].createdAt(必填)
string
items[].name
string
items[].avatarUrl
string
page(必填)
integer
pageSize(必填)
integer
total(必填)
integer

错误

请求示例(curl)

curl -X GET "https://你的项目.workflow.games/api/v1/admin/users?query=…&status=…" \
  -H "Authorization: Bearer wfp_…"

响应示例

HTTP/1.1 200
{
  "items": [
    {
      "id": "018f3c2e-0000-7000-8000-000000000000",
      "email": "[email protected]",
      "status": "active",
      "platformRole": "user",
      "emailVerified": true,
      "orgCount": 1,
      "createdAt": "示例文本"
    }
  ],
  "page": 1,
  "pageSize": 1,
  "total": 1
}

合同真值:OpenAPI 3.1(0.1.0)。

相关:Agent 接入指南 · 使用指南 · API 参考索引

Workflow 正在加载…