API 参考

用户

管理项目中的用户。所有端点需要私密密钥,仅限服务器端使用。

仅限服务器端
所有用户管理端点需要您的 sk_live_ 私密密钥。切勿在客户端代码中暴露此密钥。
GET/v1/dashboard/users

列出用户

列出当前项目中的所有用户。需要私密密钥。

查询参数
text
?limit=20&offset=0&search=john&projectId=proj_abc123
响应
json
{
  "users": [
    {
      "id": "usr_abc123",
      "email": "user@example.com",
      "displayName": "John Doe",
      "avatarUrl": null,
      "isBanned": false,
      "signInCount": 5,
      "lastSignInAt": "2026-01-15T10:30:00Z",
      "createdAt": "2026-01-01T00:00:00Z"
    }
  ],
  "total": 42
}
GET/v1/dashboard/users/:userId

获取用户

通过 ID 获取单个用户,包括其关联的登录方式和活跃会话。

响应
json
{
  "id": "usr_abc123",
  "email": "user@example.com",
  "displayName": "John Doe",
  "providers": ["google", "github"],
  "sessions": [...],
  "publicMetadata": {}
}
PATCH/v1/dashboard/users/:userId/ban

封禁用户

封禁用户。撤销所有活跃会话并阻止未来登录。

响应
json
{ "success": true }
PATCH/v1/dashboard/users/:userId/unban

解除封禁

解除用户封禁,允许其重新登录。

响应
json
{ "success": true }
DELETE/v1/dashboard/users/:userId

删除用户

永久删除用户及其所有数据。此操作不可撤销。

响应
json
{ "success": true }
Authon — Universal Authentication Platform