Skip to content

This document was written by AI and has been manually reviewed.

团队

团队是 OAuth 应用与已验证域名的共同所有者。成员可以在与个人资源相同的界面里管理团队的应用和域名,但单个成员的离开不会影响这些资源的归属。

角色

角色管理成员改团队设置管理应用/域名转移所有权解散
owner是(转给 co-owner)
co-owner是(除 owner)
admin是(仅 member)
member团队允许的写

每个团队恰好有一名 owner。转移所有权是一次性的、可审计的操作;原 owner 自动降级为 co-owner。

站点管理员对每个团队都拥有所有者级权限 —— 以站点身份行使,即便对自己所属或拥有的团队也是如此,添加成员时还可以覆盖团队自身的加入门槛。团队页会以横幅予以说明,其操作会带 site_admin: true 记入该团队的审计日志。管理员可切换到普通视图改以自己的成员身份行事。详见 管理员 → 站点管理员对所有团队的权限

加入团队

三种方式:

  1. 直接添加 — 由 admin/co-owner/owner 在 Teams → <team> → Members → Add member 中添加。站点管理员可在 Admin → Teams → 添加成员 中对任意团队执行此操作。
  2. 邀请链接 — 在 Members → Generate invite 生成。可选邮箱锁定、最大使用次数、过期时间。访问 /teams/join/:token 会显示团队资料以及任何未满足的加入门槛
  3. API — 携带会话 bearer 调用 POST /api/teams/join/:token

加入门槛

团队所有者可要求成员加入前满足某些安全因素(成员之后试图降级时也会再次校验)。管理员还能设置 站点底线 — 任何团队都必须满足的最低要求。

门槛团队字段站点底线键
至少有一个 TOTP 认证器或 Passkeyteams.require_2fadefault_team_require_2fa
主邮箱已验证teams.require_verified_emaildefault_team_require_verified_email

有效要求 = 团队标记 站点底线。所有者可在底线之上加严,但不能在底线之下放松。被站点强制的因素在团队设置 UI 中会被锁灰。

回溯生效

启用门槛会立即对每个现有成员生效。任何未满足该因素的成员将在团队操作中被拦下,直到自行补齐。unmetRequirements 工具函数会在加入确认页和用户侧改动路径(例如移除最后一个 TOTP 认证器)上把错误清晰地呈现给用户。请先通知成员后再切换。

/teams/join/:token 的负载会先列出门槛,并提供链接跳到 资料 → 安全 / 资料 → 邮箱 以便补齐:

json
{
  "team": { "id": "...", "name": "Acme", "avatar_url": "..." },
  "requirements": {
    "require_2fa": true,
    "require_verified_email": true,
    "forced_by_site": { "require_2fa": false, "require_verified_email": true }
  },
  "unmet": ["2fa"]
}

子团队(递归嵌套)

一个团队可以在另一个团队下创建,用来映射组织内部结构。子团队最多递归嵌套至运营方配置的 max_team_depth(默认 5 层);服务器在创建和移动时都会拒绝循环以及超深嵌套。

整个特性都受站点配置控制 —— 运营方可以关闭它、收紧深度上限,或独立切换两类继承语义。详见下方 可配置项

继承 —— 向下流动的内容

子团队不是独立副本。两类资源自动从上级流向所有后代,各自可在站点配置中独立开关

  1. 成员资格inherit_team_membership,默认开启)—— 团队 A 的成员在 A 的任意后代团队上都至少拥有自己在 A 上的角色。直接成员资格会与继承叠加:有效角色 = max(直接, 继承)。可实现“部门负责人是每个项目子团队的 admin”而不必复制成员记录。关闭后,getEffectiveMember 会退化为只看直接成员行,列表也不再向子树展开。
  2. 已验证域名inherit_team_domains,默认开启)—— 上级团队拥有的所有域名都会作为只读条目出现在子团队的域名列表中,并打上 inherited_from 标记。这样当上级已经验证了顶级域,子团队的子域可以自动验证通过。关闭后,列表和自动验证均退化为只看自己拥有的域名。

其他资源仍然独立。应用属于创建它的团队;既有的 share-to-team 流程仍然适用于显式复制。

可配置项

子团队的全部行为都由站点配置驱动(管理员 → 设置 → 团队与应用限制)。同一组数值也在未鉴权的 /api/site 响应中暴露,方便 SDK 客户端在 UI 上做相同的开关。

类型默认值作用
enable_sub_teamsbooltrue总开关;关闭后所有子团队接口返回 403,UI 隐藏“子团队”标签。
max_team_depthint5嵌套深度上限(服务端强制,管理员接口校验 1–20)。
inherit_team_membershipbooltrue让成员角色向下级团队级联。
inherit_team_domainsbooltrue让上级域名出现在子团队列表,并参与自动验证。
default_team_profile_show_sub_teamsbooltrue公开资料“子团队”分区的默认展示开关。

teams 表上的 profile_show_sub_teams 列与其它 profile_show_* 字段使用相同约定:null 跟随站点默认值,0/1 表示按团队覆盖。

管理子团队

  • 创建POST /api/teams/:parentId/sub-teams(调用者需在上级团队上是 admin+,直接或继承均可),或在 UI 中点击 Teams → <team> → Sub-teams → New sub-team。创建者成为新子团队的 owner。
  • 列出GET /api/teams/:id/sub-teams 返回直接子团队列表,包含成员数与调用者的有效角色。支持 ?page=?limit=?q= 名称搜索并返回 total。上级团队的成员也能查看。
  • 移动 / 改父PATCH /api/teams/:id { "parent_team_id": "..." },传 null 表示提升回顶层。仅限被移动团队的 owner,且调用者必须在新上级团队上是 admin+。服务端会同时遍历两个子树以拒绝会造成循环或超过 MAX_TEAM_DEPTH 的移动。
  • 删除DELETE /api/teams/:id 会级联到每一个后代。dissolveTeam 自下而上地为每一层把应用重新分配给该层自己的 owner —— 子团队的 owner 留住自己的应用,最终回退到执行删除的用户。数据库约束 parent_team_id REFERENCES teams(id) ON DELETE CASCADE 是应用层之外的一层保险。

列表中的继承成员资格

  • GET /api/teams(会话)与 GET /api/oauth/me/teams 都会把每个直接成员资格展开成它的整个子树。条目带 inherited_from 字段标识上级团队 id(直接成员资格为 null)。会话列表带分页,支持 ?page=?limit=?q= 名称搜索,返回 total
  • GET /api/teams/:id 返回:
    • team.ancestors —— [{id, name, avatar_url}] 从直接上级到根,用于面包屑。
    • team.sub_teams —— 直接子团队的第一页(20 条)及其成员数,另有 team.sub_team_count 表示总数;翻页走 GET /api/teams/:id/sub-teams
    • team.my_role —— 有效角色;当来自继承时,team.inherited_from 给出上级 id。
    • members —— 直接成员的第一页(50 条),另有 member_count 表示全团队总数。翻页与筛选走 GET /api/teams/:id/members;详情响应自带第一页,因此首屏只需一个请求。继承成员不在此列出(可在上级团队查看,这里展开会让每个子团队列表都重复一遍)。
  • 其他团队级列表也支持了分页与搜索:GET /api/teams/:id/appsGET /api/teams/:id/domainsGET /api/teams/:id/invites 均接受 ?page=?limit=?q=,返回 total

身份组

身份组是团队自建的成员标签,一个成员可以同时属于多个。它是纯标签:不进角色阶梯,发一个标签不会改变任何人在 Prism 内部能做什么。它唯一的用途,是随成员信息一起下发给团队接入的应用,由这些应用拿去鉴权。

默认关闭。只有团队所有者能在 Teams → <team> → Settings → 身份组 开启。

身份组与子团队的区别

两者都能给下游做基于分组的鉴权,所以有必要说清楚各自适用在哪:

子团队身份组
是否独立实体(独立主页、id)否 —— 团队内的一个标签
能否拥有应用与域名不能
基数关系树形层级,深度受限平面多对多,一人可挂多个
是否影响 Prism 内部鉴权影响 —— 角色随之继承不影响
在 claims 里的形态独立的 in_team_<子团队id>groups_in_team_<团队id> 数组
能否单独授权给应用能,有自己的 team: scope不能,随成员信息一起下发
与父团队的成员范围关系可以是不重叠的另一批人始终是团队现有成员的子集

需要管辖与资源分家用子团队;只是给同一批人打属性标签用身份组。有个坑值得点名:拿子团队当标签使,每个「标签」都会变成 claims 里的又一个团队 id,而且因为成员身份会向下继承,你本来只想打个标签的人,会连带在那个子团队里获得角色。

定义与分配

定义在 Teams → <team> → 身份组 中管理,每个身份组包含:

字段说明
slug下游应用用于鉴权的稳定标识。不可修改 —— 改名会静默打断线上策略。
name展示名,可随意修改。
描述可选,给人看的。
颜色可选 #rrggbb,用于标签配色。

限额:每团队 50 个身份组,每成员 20 个,slug 最长 32 字符,仅限小写字母数字与单连字符。

分配入口在成员表格 —— 成员行上的标签按钮。对话框提交的是完整的目标集合,由服务端做差集协调,且只对实际发生变化的身份组做权限校验。

谁能管理、谁能分配

所有者与共同所有者始终可以。管理员能做什么由所有者配置,通过一条回退链解析,每一级只贡献它显式设置过的键:

单组 admin_assignable  →  团队 role_permissions  →  站点默认      →  代码内置
(仅作用于分配)           (身份组 → 管理员权限)    (default_team_   (管理:关
                                                      role_permissions) 分配:开)
能力覆盖范围内置默认
groups:manage创建、编辑、删除身份组定义
groups:assign给成员挂载与取消身份组

单组的 admin_assignable 覆盖项,是为了让「整体允许管理员发标签」的团队仍能把某个敏感身份组收回给所有者。

开关本身仅所有者可改

开关功能、修改 role_permissions、设置单组 admin_assignable,这三项都限定所有者,而不是「管理员及以上」—— 这是刻意的。如果被约束的角色能编辑约束自己的配置,这个约束就等于不存在:管理员只需把所有者收走的权限给自己开回来。

继承

身份组像角色一样沿子团队树向下流动:上级团队的成员会在每个下级团队带着上级的标签,并标记 inherited_from,前端据此渲染为只读。继承来的标签在其来源团队处管理。

这一行为跟随与角色继承同一个 inherit_team_membership 开关 —— 当上下级在成员资格上已被解耦,标签也不再跨过那条边界。

关闭之后

关闭是隐藏,不是清除。定义与分配关系都留在库里,只是所有读取出口不再下发,已接入的应用从下次刷新令牌起看不到任何身份组。重新开启后,全部分配原样恢复。

继承链上同理:上级团队关掉后,不再向下级贡献任何标签,避免已关闭团队的标签借道子团队泄出去。

对下游的影响

因为应用是拿这些标签做鉴权的,关闭功能(或删除某个身份组)会让下游鉴权变严而不是变松 —— 受影响的用户只是不再出示该标签。

出现在哪些位置

出口形态
GET /api/teams/:id(会话)members[].groups —— {slug, name, color, inherited_from}
GET /api/oauth/me/team/:id/members同上,需 team:<id>:member:read
.../members/:userId/profile同上,需 team:<id>:member:profile:read
ID token / userinfogroups_in_team_<id> —— slug 数组;teams[].groupsoidc_fields 选入

不新增 scope:身份组随应用本就被信任读取的成员信息一起下发。已持有 team:<id>:member:read 的应用会在下次调用时自动看到身份组,无需重新授权 —— 之所以接受这个取舍,是因为这是团队自建的标签而非个人隐私数据。管理与分配仅限仪表盘,team:<id>:member:write 授予这些操作。

团队的 role_permissions 不会离开仪表盘 API —— 下游应用看得到成员持有哪些标签,但看不到团队是怎么配置发放权限的。

邀请链接注册

通常团队邀请只能让已有 Prism 账号的人加入。经站点管理员授权的团队,可以改为发放能创建账号的链接,入口是独立页面 /join/<团队 id>

以这种方式创建的账号是受限账号:除非站点管理员放开,所有创建资源类的功能都是关闭的。目的是让一批用途单一的大规模用户能够登录,而不必让他们每个人同时获得创建团队、应用和验证域名的能力。

这能省什么、不能省什么

限制功能省下的是数据行和滥用面。它不会减少鉴权流量 —— 一个只登录单个应用的用户,照样要跑完整的 /authorize/token → 刷新链路。

两道门

这条通道被关了两道,必须同时打开:

  1. 站点总开关 —— enable_team_invite_registration,默认关闭。
  2. 按团队授权 —— 由站点管理员在 Admin → Teams 中授予,团队所有者无法自行开启。

之后团队所有者在 设置 → 邀请链接注册 里的开关才有意义。缺了第二道,打开第一道就等于把实例上每一个团队所有者都变成了注册入口。

创建可注册的邀请

生成邀请时勾选可用于创建新账号。这类邀请:

  • 必须设置有限的使用次数,且不得超过 team_invite_registration_max_uses_cap。团队邀请的默认值 0 表示无限次 —— 这在仅供已有账号加入时无伤大雅,一旦能创建账号就意味着无限量注册。
  • 始终只授予 member。通过链接进来的陌生人,不该一开始就能管理团队。

链接指向 /join/<团队 id>?invite=<邀请码>,而不是常规的 /teams/join/<token>

注册者会经历什么

/join/<团队 id>  →  账号已创建(pending)  →  满足门槛  →  成为成员

账号先于门槛存在,因为满足门槛的每一步(挂 2FA、验证邮箱)都需要已认证的会话。这与站点开启邮箱验证时的常规注册流程是一致的。

pending 期间账号只能管理自己的安全设置,且无法登录任何应用。pending 账号还不是成员,它的令牌里不会有 in_team_*groups_in_team_*,应用收到后只会当成「非成员」,进而很可能建出一条之后还得回头修正的本地记录。

可以带 ?continue=<地址>(仅限同源),让用户完成后跳回指定位置。

被放弃的注册会在 restricted_pending_ttl_hours 之后清理。

邮箱

如果站点管理员为该团队豁免了邮箱验证,注册表单根本不会索要邮箱,账号会得到一个合成的 @users.invalid 占位地址。

这是刻意的。改成存一个未验证的真实地址反而更糟:users.emailUNIQUE,一个打错的地址会把它真正的主人永久挡在实例之外 —— 而打错的人自己也永远验证不了它,账号同样无法转换。

持有者可以随时绑定真实邮箱,转换为完整账号前则必须绑定。

防滥用

四道防线,均不可豁免:

防线约束的是
按 IP 限流5 次 / 5 分钟,与常规注册一致
Captcha / 工作量证明机器人
按邀请码限流team_invite_registration_rate_per_hour —— 峰值
max_uses,原子占用总量。唯一的硬边界

按邀请码限流之所以重要,是因为一个被广传的链接会有成千上万人各自从自己的 IP 注册一次,按 IP 限流对此完全无效。

名额在创建账号时占用,而不是完成加入时。被放弃的注册会烧掉一个名额 —— 这是可接受的:推迟到完成时占用会让并发检查重新失效,也会让用户辛苦挂完 2FA 之后才被告知邀请已满。

受限账号

受限的范围

能力默认
创建团队
创建应用
验证域名
个人访问令牌
公开主页
GPG 密钥
转换为完整账号
团队功能与自身账号安全始终开启

站点管理员通过 restricted_user_capabilities 逐项放开。默认拒绝,因此以后新增的功能对这类账号自动是关闭的,无需任何人记得去补。

账号安全永不受限 —— 一旦限制就会让注册流程死锁,因为 pending 账号必须能挂 2FA 才能完成加入。

作用范围

受限账号被限制在其来源团队的子树内:

  • 只能加入该团队及其后代,其余一律不行 —— 由管理员直接添加也不例外;
  • 只能登录该团队及其后代拥有的应用。

锚点始终是来源团队,绝不是账号当前所在的团队。若锚定在当前成员关系上,这个限制会自我瓦解:加入第二个团队,它的整个子树就跟着打开了。

应用范围只在 /authorize 处校验,不在刷新时复查 —— 否则应用被转出团队会让存量令牌突然失效。

转换为完整账号

在启用了 self:convert 的实例上,持有者可在 安全 → 账号类型 处转换。转换会:

  • 解锁全部常规功能,
  • 保留团队成员身份,
  • 要求先绑定并验证真实邮箱 —— 推迟的发件成本在此结清,于是只有真正想用 Prism 其余功能的人才需要承担,
  • 不可撤销
  • 并把账号移出「解散时会被删除」的集合。

转换后 origin_team_id 仍保留用于追溯,但不再约束任何东西。

解散

解散一个签发过账号的团队会注销这些账号。因此:

  • 只有站点管理员能做,且必须走分段流程;
  • 常规的四条解散路径全部拒绝 —— 所有者删除、最后一人退出、OAuth teams:delete scope、以及普通的管理员删除;
  • 只删除 origin_team_id 指向该团队的账号。用自己的 Prism 账号加入的成员、以及已转换的账号,都不受影响;
  • 阶段一一次性停用所有受影响账号;阶段二在 restricted_dissolve_grace_hours 之后分批删除,中间留有撤销窗口。

注册页会在任何人注册之前就把这一条讲明。

保护挂在账号上,不挂在开关上

只要团队还有存活的受限账号,它就受保护 —— 而不是看邀请注册开关是否开着。否则只需关掉开关,所有者就能把仍锚定着数千个账号的团队直接解散。等这些账号消失后,保护会自动解除。

含有受限成员的团队同样不能被移出其来源团队的子树,团队所有权也不能转让给受限账号。

团队拥有的应用与域名

OAuth 应用可以直接在团队下创建(Teams → <team> → Apps → New),或从成员个人应用转入(Apps → <app> → Settings → Transfer)。被转入的个人应用就地改主 — client_idclient_secret 保持不变,外部集成不会断。

域名同理。已在个人账户验证过的域名可以共享给团队(POST /api/teams/:id/domains/:domainId/share-to-team),之后还能取消共享(/share-to-personal)或彻底转出(/to-personal,撤销团队的编辑权)。

team-as-user 存储

每个团队都有一行合成的 users 行:kind = 'team'idteams.id 一致。它仅是为了让 oauth_apps.owner_id 在个人/团队应用上能用同一张表 join — 没有密码、没有会话、没有社交连接、不能登录。合成的邮箱与用户名(team-<id>@teams.invalid / team:<id>)使用冒号前缀,绝不会与真实注册冲突。

团队解散时,dissolveTeam 会先把团队拥有的应用重新分配给团队所有者(如果没有 owner 行就给执行删除的管理员),从而绕过 oauth_apps.owner_id 的级联删除。

团队公开资料

与用户一样,团队默认私密。团队所有者(或管理员)必须显式在 Teams → <team> → Settings → Public profile 启用,并选择展示的内容。站点级默认值与 enable_public_profiles 主开关在 配置 中。各分区的细则见 公开资料

团队公开页只会在所有者本人也开了公开资料时才链接到 /u/<username> — 否则只展示昵称,不带链接。

OAuth scope

涉及团队的 scope 分三类,作用范围差异巨大。完整表格(含同意规则与示例)在 OAuth → 团队相关 scope —— 三个层级;这里给个速览:

聚合 teams:*

一次同意作用于用户的全部团队。端点位于 /api/oauth/me/teams[/...]

Scope权限
teams:read列出当前用户加入的团队与角色
teams:create创建新团队
teams:write修改团队设置;添加/移除用户所在团队的成员
teams:delete删除团队(请求时仍校验当前用户必须是 owner)

适合「这个用户在哪些团队」型用途 — workspace 切换器、同步成员列表、给 Cloudflare Access 策略用的 OIDC claim 等。

单团队 team:*

只作用于用户在同意时选定的那一个团队。Prism 在颁发前用 bindTeamScopes()team:read 改写为 team:<team-id>:read,token 中只剩绑定后的形式。端点位于 /api/oauth/me/team/:teamId/...

请求字符串绑定后形式权限
team:readteam:<id>:read读取该团队的设置
team:writeteam:<id>:write修改该团队的设置
team:deleteteam:<id>:delete解散该团队
team:member:readteam:<id>:member:read列出成员与角色
team:member:writeteam:<id>:member:write添加/移除成员、改角色
team:member:profile:readteam:<id>:member:profile:read通过团队 scope 读取某成员的资料

同意时还有两条额外限制(worker/routes/oauth.ts:830-859):

  • 用户必须是所选团队的 ownerco-owneradmin
  • team:delete 还要求 ownerco-owner — admin 能授予读写,但只有真能解散团队的人才能授予删除权。

team:member:write 也不能越权:admin 授权后,应用提升成员的角色仍受到与该 admin 相同的上限保护,不会因 token 而获得超越授权人的能力 — 这条上限在每次成员变更时都会校验。

每次授予会在 team_scope_grants 表中独立审计(含团队 ID 与权限列表),与 OAuth 同意记录分开。

适合绑定到单个团队的集成 — 某 workspace 的部署机器人、某团队频道里的 chatbot 等。

跨实例 site:team:*

无需逐团队同意的跨团队管理员权限。授予时同意者必须是站点管理员,并通过 站点 scope 确认流程(2FA + 输入 grant site access)。仅适合站点管理工具。

oidc_fields claim

把用户角色嵌入 ID Token 用的 oidc_fields 机制同样能产出按团队的 claim — 这对依赖团队成员关系的 Cloudflare Access 策略非常有用。teams:read scope 会解锁扁平的 teams claim 以及 in_team_<id> / role_in_team_<id> 标记,启用了身份组的团队还会带上 groups_in_team_<id>。详见 Cloudflare Access 集成

怎么选

  • 集成关心用户的整个团队图谱(同步成员、注入 claim)— 用 teams:*
  • 集成只针对一个团队 — 用 team:*,更窄的爆炸半径值得多一个团队选择器。
  • 不要 同时请求 teams:*team:*:你会拿到并集,但同意页同时出现「全部团队提示」和「团队选择器」,对用户很迷惑。
  • site:team:* 留给站点管理工具用 — 这层授予会绕过团队所有者的同意。

端点速览

完整列表见 API → 团队。常用端点:

GET    /api/teams                            列出加入的团队
POST   /api/teams                            创建(管理员可用 owner_username 指定所有者)
PATCH  /api/teams/:id                        更新设置与门槛
GET    /api/teams/:id/members                列成员(分页,支持 ?q= 与 ?group=)
POST   /api/teams/:id/members                按用户名/ID 添加
PATCH  /api/teams/:id/members/:userId        改角色(站点管理员可设为 owner,也可直接降级所有者)
DELETE /api/teams/:id/members/:userId        移除(self 即退出)
GET    /api/teams/:id/groups                 列出身份组定义与有效权限
POST   /api/teams/:id/groups                 创建身份组
PATCH  /api/teams/:id/groups/:groupId        改名/改色(slug 不可改)
DELETE /api/teams/:id/groups/:groupId        删除(连带解除所有分配)
PUT    /api/teams/:id/members/:userId/groups 覆盖某成员的身份组集合
POST   /api/teams/:id/transfer-ownership     转移所有权(owner,或任意站点管理员)
GET    /api/teams/join/:token                预览邀请(认证可选)
POST   /api/teams/join/:token                接受邀请

在 GPL-3.0 许可协议下发布.