Member¶
成员(Collaborator)接口管理仓库层面的协作者与权限。通过 API 可以列出仓库成员,添加成员或修改其权限,移除成员,并查询成员或自己在仓库里的权限点。
组织成员、企业成员有各自的分组,本组只覆盖仓库协作者。
对象¶
标识方式¶
- 仓库用
owner+repo,成员用username标识。 - 自助查询用固定段
self-permission,不需要username。
常见任务¶
注意事项¶
- 添加成员与修改权限是同一个
PUT,重复调用即覆盖权限,不需要先删再建。 - 判断成员与查询成员详情共用
GET …/collaborators/{username},权限点在它的/permission子路径下。 self-permission是固定字面量路径段,不要替换成用户名字面量。- 仓库级的角色与自定义角色在仓库分组(
…/members/{username}、…/customized_roles),与本组的collaborators路径不通用。
接口列表¶
本模块共 6 个接口。
| # | 接口 | 方法与路径 | 说明 |
|---|---|---|---|
| 1 | 添加项目成员或更新项目成员权限 | PUT /api/v5/repos/{owner}/{repo}/collaborators/{username} |
该接口用于添加项目成员或更新项目成员权限:当目标用户尚未成为仓库成员时,将其添加为成员;当目标用户已是仓库成员时,更… |
| 2 | 移除项目成员 | DELETE /api/v5/repos/{owner}/{repo}/collaborators/{username} |
该接口用于移除指定仓库中的指定项目成员(协作者)。通过该接口,可以按用户名定位并移除仓库中的指定协作者成员。 |
| 3 | 判断用户是否为仓库成员 | GET /api/v5/repos/{owner}/{repo}/collaborators/{username} |
该接口用于判断指定用户是否为指定仓库的成员,通过仓库所属空间地址、仓库路径和用户名进行查询;若该用户为仓库成员则返回… |
| 4 | 获取仓库的所有成员 | GET /api/v5/repos/{owner}/{repo}/collaborators |
该接口用于获取指定仓库的所有成员信息,支持按页码与每页数量分页查询。返回内容包括成员的基础资料(如成员 ID、登录名… |
| 5 | 查看仓库成员的权限 | GET /api/v5/repos/{owner}/{repo}/collaborators/{username}/permission |
该接口用于查询指定仓库中某个成员的权限信息,包括成员的基础资料、权限级别(admin/write/read)及权限明… |
| 6 | 查看当前成员仓库的权限点 | GET /api/v5/repos/{owner}/{repo}/collaborators/self-permission |
该接口用于查询当前成员在指定仓库中的角色及权限点,返回角色信息和权限矩阵树,展示其在项目、代码、成员等资源上的具体操… |
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc