用户信息

一次性拿到当前已鉴权用户的所有 dashboard 字段:身份、角色、所属 group、剩余配额、累计请求数、邀请状态、Sidebar 权限。返回的是经过白名单过滤的精选投影,而不是裸的数据库行。

鉴权

本接口走 BUZZ 的标准用户鉴权链,必须同时带上以下两个 header:

请求示例

curl -s 'https://buzzai.cc/api/user/self' \
  -H "Authorization: Bearer $BUZZ_ACCESS_TOKEN" \
  -H "Buzz-User: 1"

import os, requests

resp = requests.get(
    "https://buzzai.cc/api/user/self",
    headers={
        "Authorization": f"Bearer {os.environ['BUZZ_ACCESS_TOKEN']}",
        "Buzz-User": "1",
    },
    timeout=10,
)
resp.raise_for_status()
profile = resp.json()["data"]
print(profile["username"], profile["group"], profile["quota"])

const resp = await fetch("https://buzzai.cc/api/user/self", {
  headers: {
    Authorization: `Bearer ${process.env.BUZZ_ACCESS_TOKEN}`,
    "Buzz-User": "1",
  },
});
const { data } = await resp.json();
console.log(data.username, data.group, data.quota);

实测响应(已脱敏)

{
  "success": true,
  "message": "",
  "data": {
    "id": 1,
    "username": "buzz666",
    "display_name": "buzz666",
    "role": 100,
    "status": 1,
    "email": "",
    "github_id": "<REDACTED_NUMERIC_ID>",
    "discord_id": "",
    "oidc_id": "",
    "wechat_id": "",
    "telegram_id": "",
    "linux_do_id": "",
    "group": "enterprise",
    "quota": 29214128,
    "used_quota": 588097249,
    "request_count": 398916,
    "aff_code": "tYxh",
    "aff_count": 0,
    "aff_quota": 0,
    "aff_history_quota": 0,
    "inviter_id": 0,
    "setting": "{\"notify_type\":\"email\",\"quota_warning_threshold\":100000,\"gotify_priority\":0,\"record_ip_log\":true}",
    "stripe_customer": "",
    "sidebar_modules": "",
    "permissions": {
      "sidebar_modules": {},
      "sidebar_settings": false
    }
  }
}

2026-05-26 实测于 buzzai.cc。

响应包络

data 字段

响应是手写的字段白名单,而非数据库行的直接序列化。password、access_token、verification_code、管理员的 remark 等敏感列都会在返回前被剔除。

已显式排除的字段

handler 用白名单方式手写返回字段,以下列即使在 root 账号上也永远不会出现在响应里:

• password、original_password — 凭据
• access_token — 用户自己的 access token(你已经有了,不会再回显)
• verification_code — 注册 / 邮件验证用的临时码
• remark — 管理员备注,服务端在序列化前清空
• deleted_at、created_at、last_login_at、last_active_at — 内部生命周期时间戳

错误码

相关链接

• Billing 接口 — 把 quota 换算成货币、查 usage
• GET /api/token/ — 管理 sk- API token
• 鉴权指南 — Access Token 与 User Token 的区别