Scopes
应用能申请的全部 scope。
应用能申请的 scope 共 88 个,下表按领域分组。名字格式是 领域:资源:动作。怎么申请、怎么算实际权限、敏感级别,见调用平台能力。
- 用途:「调用接口」= 调 Apps API;「订阅事件」= 收事件推送;「仅应用」= 不对应任何接口,作用在换令牌上(例如
offline_access让换令牌时多发 refresh token,见调用平台能力)。 - 每个接口需要哪个 scope:下表「覆盖的接口」一列链到 Apps API 参考里要这个 scope 的接口;那边每个接口也写了它要的 scope。标题和说明取自平台的 scope 清单。
agents
apps
| Scope | 标题和说明 | 用于 | 覆盖的接口 |
|---|---|---|---|
apps:badge:write |
在 Workspace 显示角标 仅应用:应用后端为本组织成员设置应用入口上的数字或小红点(只对该成员本人可见) | 调用接口 | PUT /api/v1/app-badges |
automations
billing
connections
kb
messages
org
| Scope | 标题和说明 | 用于 | 覆盖的接口 |
|---|---|---|---|
offline_access |
离线访问(续期) 仅应用:换 token 时同时签发 refresh token(30 天,每次刷新轮换),用户不在场时应用也能续期 | 仅应用 | — |
org:analytics:read |
查看组织统计 管理员概览统计 | 调用接口 | GET /api/v1/analytics/overview |
org:invitation:accept |
接受邀请 接受发给我的邀请(含邀请链接 token),加入新组织,与网页行为一致 | 调用接口 | POST /api/v1/invitations/{invitation_id}/acceptPOST /api/v1/me/invitations/{invitation_id}/accept |
org:invitation:read |
查看邀请 组织邀请列表、发给我的邀请 | 调用接口 | GET /api/v1/invitationsGET /api/v1/me/invitations |
org:invitation:write |
管理邀请 发出邀请、撤销邀请(可邀请的角色与网页一致) | 调用接口 | POST /api/v1/invitationsDELETE /api/v1/invitations/{invitation_id} |
org:me.email:read |
在登录令牌中提供本人邮箱 仅应用:决定换 token 时 user.email 与 id_token 的 email 是否携带当前成员的登录邮箱;只作用于这两处,不限制 GET /api/v1/me(由 org:me:read 授予,按网页口径返回登录邮箱) | 仅应用 | — |
org:me:read |
查看本人基础信息 GET /api/v1/me(返回内容与网页一致,含登录邮箱 email、未经验证的联系邮箱与主手机号 phone_cc / phone_number)、本人星标列表(GET /api/v1/stars) | 调用接口 | GET /api/v1/meGET /api/v1/stars |
org:me:write |
修改本人资料 修改本人头像、语言、联系邮箱 / 手机、成员显示名,加星标 / 取消星标(PUT / DELETE /api/v1/stars/{object_type}/{object_id}) | 调用接口 | POST /api/v1/avatars/uploads/finalizePOST /api/v1/avatars/uploads/preparePATCH /api/v1/mePATCH /api/v1/me/display-nameDELETE /api/v1/stars/{object_type}/{object_id}PUT /api/v1/stars/{object_type}/{object_id} |
org:member:read |
查看成员 成员列表 / 详情(含邮箱,与网页一致)、批量解析显示名、成员名下 Agent | 调用接口 | GET /api/v1/membersPOST /api/v1/members/batch-display-infoGET /api/v1/members/{member_id}GET /api/v1/members/{member_id}/owned-agents |
org:member:write |
管理成员 修改成员资料 / 状态 / 角色、移除成员(与网页一致,handler 内仍要求 owner/admin) | 调用接口 | POST /api/v1/members/batch-removeDELETE /api/v1/members/{member_id}PATCH /api/v1/members/{member_id} |
org:observation:read |
查看成员观察关系 我观察的成员、某成员的观察者 | 调用接口 | GET /api/v1/me/observed-membersGET /api/v1/members/{member_id}/observers |
org:organization:read |
查看组织信息 组织资料、我所在的组织列表、删除前预检(只读) | 调用接口 | GET /api/v1/organizationsGET /api/v1/organizations/{org_id}GET /api/v1/organizations/{org_id}/deletion-precheckGET /api/v1/organizations/{org_id}/storage-quota |
org:organization:write |
修改组织资料 修改组织名称、头像等资料(handler 内仍要求 owner/admin) | 调用接口 | PATCH /api/v1/organizations/{org_id} |
org:presence:read |
接收在线状态事件 成员 / Agent 在线状态变更(presence 帧) | 订阅事件 | — |
org:role:read |
查看角色 可用角色列表 | 调用接口 | GET /api/v1/roles |
