个人访问令牌(PAT)

个人访问令牌(PAT)

PAT 是一种长期有效的认证令牌,适用于脚本、CI/CD 流水线和 AI 工具集成。


创建 PAT

  1. 登录 M-Doc,进入「设置 > 个人令牌」页面
  2. 点击「创建令牌」
  3. 设置:
    • 名称:描述用途,如「CI 部署」「Claude MCP」
    • 权限范围(Scope):选择所需权限
    • 过期时间(可选)
  4. 点击「创建」
  5. 复制并保存令牌(仅显示一次!)

令牌格式:mdoc_pat_<random_string>

权限范围(Scope)

Scope 说明
read:documents 读取文档列表和元数据
read:articles 读取文章内容和目录
write:articles 创建、更新、删除、发布文章
admin:all 所有权限(管理员级别)
  • 每个 PAT 可以绑定一个或多个 Scope
  • 调用接口时系统会检查 PAT 是否具备所需 Scope
  • admin:all 为通配权限,可访问所有接口

使用方式

在请求头中携带 PAT:

curl -H "Authorization: Bearer mdoc_pat_xxxxx" \
  https://mdoc.cc/openapi/organizations/my-org/documents

适用路由

PAT 认证适用于所有 /openapi/* 前缀的路由。系统通过 UnifiedAuthMiddleware 自动识别 mdoc_pat_ 前缀并路由到 PAT 认证流程。

管理 PAT

查看令牌列表

在「设置 > 个人令牌」页面可以查看所有已创建的 PAT,包括:

  • 名称
  • 权限范围
  • 创建时间
  • 过期时间
  • 最后使用时间

删除令牌

点击令牌右侧的「删除」按钮即可撤销令牌。删除后该令牌立即失效。

安全建议

  1. 最小权限原则:仅授予必要的 Scope
  2. 设置过期时间:避免永久有效的令牌
  3. 定期轮换:定期创建新令牌并删除旧令牌
  4. 安全存储:使用环境变量或密钥管理服务,不要提交到代码仓库
# 推荐:使用环境变量
export MDOC_TOKEN=mdoc_pat_xxxxx

# 在脚本中使用
curl -H "Authorization: Bearer $MDOC_TOKEN" ...