AgentbaseDocs
文档目录

团队

这是什么 / 何时用

项目内的团队与成员管理:把用户组织成 Team,用 Role.team(teamId[, role]) 在行 / 文件权限里做批量授权。何时用:协作空间(看板、共享文档)、按团队粒度的数据共享、成员角色分层(如 owner / member)。

注意区分:项目内 Team(本页)与管理面的组织(Console 场景的 Organization = Team,见 organization.md)。两者 API 同形但边界不同——组织管项目与成员计费,项目内团队只服务该项目的授权。

前置

使用骨架

关键参数与返回

调用关键参数返回
createteamId、name、roles?(创建者角色)Models.Team($id、name、total)
createMembershipteamId、roles[]、email?/userId?/phone?、url?、name?Models.Membership(confirm 状态、roles)
updateMembershipteamId、membershipId、roles[]Membership
updateMembershipStatusteamId、membershipId、userId、secretMembership(邮件邀请链接携带凭据)
listMembershipsteamId、queries?MembershipList

错误与边界

SDK 类别差异

各语言调用示例

以下按使用骨架逐项给出各语言调用示例;每个卡片可切换语言(全页同步)。

建团队

import { Client, Teams, ID } from 'agentbase-node-sdk';

const teams = new Teams(client);   // client 初始化见 server-sdk/nodejs.md

const team = await teams.create({ teamId: ID.unique(), name: 'backend', roles: ['owner'] });
// roles 为创建者角色,缺省 ["owner"];teamId 自定义或 ID.unique()

查询 / 维护

Server SDK 在管理员视角列出项目内全部团队;Web(用户 Session)只看到自己所在的团队。

await teams.list();                                        // 项目内全部团队,支持 queries / search
const team = await teams.get('backend-team');

await teams.updateName('backend-team', 'backend-core');    // 团队 ID 不可变,仅改名

await teams.getPrefs('backend-team');                      // 团队偏好(自由键值 JSON)
await teams.updatePrefs('backend-team', { theme: 'dark' }); // 整体覆盖写,全量替换既有偏好

await teams.delete('backend-team');   // 需 owner;级联删除成员关系,引用该团队的权限字符串立即失效

邀请成员

email 邀请依赖实例消息通道可达,也可直接用 userId / phone。

const membership = await teams.createMembership({
    teamId: team.$id,
    roles: ['member'],                              // 自由字符串,team:<teamId>/<role> 按此判定
    email: 'newbie@example.com',                    // email / userId / phone 至少其一
    url: 'https://<project-domain>/accept-invite',  // 邀请回跳地址;须在项目平台列表内,带 API Key 可省略
    name: 'New Member'
});
// 响应中的 secret 供受邀人确认加入(邀请邮件同样下发),服务端应转发而不是代为确认

成员管理

confirm: false 的成员关系尚未生效;依赖「已是成员」的授权前先检查确认状态。

const members = await teams.listMemberships(team.$id);   // 可传 queries 过滤分页
const one = await teams.getMembership(team.$id, membership.$id);

await teams.updateMembership({ teamId: team.$id, membershipId: membership.$id, roles: ['admin'] });
// roles 为完整的新角色数组(全量替换语义)

// 受邀人侧确认(邮件链接携带 userId + secret),确认后 confirm=true、joined 填充:
await teams.updateMembershipStatus({ teamId: team.$id, membershipId: membership.$id, userId: '<userId>', secret: '<secret>' });

await teams.deleteMembership(team.$id, membership.$id);   // 该成员的 team:<teamId> 系权限立即失效

授权使用

在行 / 文件 / 表的 permissions 中用 Role.team() 授权;Client SDK 只能授予自己已加入的团队。

import { Permission, Role } from 'agentbase-node-sdk';

// 行 / 文件 / 表等资源的 permissions 参数:
const permissions = [
    Permission.read(Role.team('backend-team')),             // 全体成员
    Permission.update(Role.team('backend-team', 'owner')),  // 仅 owner 角色
];

示例指引

事实源