应用在访问用户数据时需申请数据访问权限,配置应用的“令牌权限”后可在应用安装或 OAuth2 授权流程中向用户展示应用申请的权限范围。
OAuth2 应用在授权流程填写 scope 时,需要以 scope 值配合读写情况来配置。以“项目信息”为例,若勾选了只读则传入的 scope 值为 project:profile:ro
;若勾选了读写,则传入的 scope 值为 project:profile:rw
。
以下为 OpenAPI 支持的各个功能模块 scope:
功能 |
描述 |
scope 值 |
读写支持 |
用户信息 |
管理用户的基础信息。 |
user:profile |
ro |
用户邮箱 |
管理用户的电子邮件地址。 |
user:email |
ro |
用户通知 |
管理用户的站内通知。 |
user:notification |
rw,ro |
用户公钥 |
管理用户配置的公钥信息。 |
user:public-key |
rw,ro |
功能 |
描述 |
scope 值 |
读写支持 |
团队信息 |
管理团队基本信息。 |
team:profile |
ro |
团队成员 |
管理团队成员信息以及团队成员相关操作。 |
team:member |
rw,ro |
功能 |
描述 |
scope 值 |
读写支持 |
项目信息 |
管理项目基本信息。 |
project:profile |
rw,ro |
项目成员 |
管理项目成员。 |
project:member |
rw,ro |
项目令牌 |
管理项目令牌。 |
project:token |
rw,ro |
项目公告 |
管理项目公告。 |
project:notice |
rw,ro |
功能 |
描述 |
scope 值 |
读写支持 |
项目集信息 |
管理项目集基本信息。 |
program:profile |
rw,ro |
项目集项目 |
管理项目集下的项目列表。 |
program:project |
rw,ro |
功能 |
描述 |
scope 值 |
读写支持 |
关联资源 |
管理团队和项目资源关联关系。 |
related-resource:resource |
rw,ro |
功能 |
描述 |
scope 值 |
读写支持 |
凭据信息 |
管理团队凭据。 |
credential:profile |
rw,ro |
Service Hooks
功能 |
描述 |
scope 值 |
读写支持 |
Service Hooks |
管理和配置 Service Hooks。 |
service-hook:profile |
rw,ro |
功能 |
描述 |
scope 值 |
读写支持 |
权限组 |
管理权限组。 |
ram:policy |
rw,ro |
授权 |
配置权限授权。 |
ram:grant |
rw,ro |
用户组 |
管理权限用户组。 |
ram:user-group |
ro |
功能 |
描述 |
scope 值 |
读写支持 |
研发度量数据集 |
研发度量数据集 |
performance:dataset |
ro |
功能 |
描述 |
scope 值 |
读写支持 |
项目协同 |
配置和使用项目协同功能。 |
collaboration:issue |
rw,ro |
功能 |
描述 |
scope 值 |
读写支持 |
知识管理 |
管理知识空间和撰写知识文档。 |
document:knowledge |
rw,ro |
文件网盘 |
管理上传、分享和下载文件等。 |
document:file |
rw,ro |
API 文档 |
发布、授权发布 API 文档。 |
document:api-doc |
rw,ro |
功能 |
描述 |
scope 值 |
读写支持 |
代码仓库 |
管理仓库 |
vcs:repository |
rw,ro |
合并请求 |
管理代码仓库的合并请求。 |
vcs:merge |
rw,ro |
部署公钥 |
管理代码仓库的部署公钥。 |
vcs:ssh-key |
rw,ro |
版本管理 |
管理代码仓库的版本信息。 |
vcs:release |
rw,ro |
外部仓库 |
管理关联的外部仓库信息。 |
depot:external-repository |
rw,ro |
功能 |
描述 |
scope 值 |
读写支持 |
制品库仓库 |
管理制品库仓库。 |
artifact:repository |
rw,ro |
制品库版本 |
管理制品版本信息。 |
artifact:version |
rw,ro |
制品库配置 |
管理制品库配置。 |
artifact:properties |
rw,ro |
制品库包 |
管理制品库包。 |
artifact:package |
ro |