组织与企业¶
组织与企业是仓库的归属空间。通过 API 可以创建组织、查询与更新组织资料,管理组织成员、成员关系(memberships)与自定义角色,并查询企业成员及其角色权限。
组织(org)与企业(enterprise)是两条并列的路径前缀,成员接口两边都有,字段与角色枚举不完全相同。
对象¶
| 对象 | 说明 | 相关接口 |
|---|---|---|
| 组织 | 组织名称、登录名、头像、描述、所属企业等 | 获取组织信息 |
| 组织成员 | 组织下的成员列表与单个成员详情 | 列出组织的所有成员 |
| 成员关系 | 邀请、移除、查询与退出组织 | 邀请组织成员 |
| 自定义角色 | 组织自定义角色的 ID、名称、访问级别、成员数 | 获取组织自定义角色 |
| 关注者 | 关注该组织的用户列表 | 列出指定组织的所有关注者 |
| 企业成员 | 企业成员及其活跃状态、角色 | 列出企业的所有成员 |
| Issue 扩展配置 | 组织下 Issue 类型与状态配置(只读) | 获取 issue 扩展配置 |
标识方式¶
- 组织用路径参数
org标识(组织路径),企业用enterprise标识。 - 成员用
username标识;授权用户在组织内的身份用/user/memberships/orgs/{org}表示。 - 用户所属组织有
/users/{username}/orgs与/users/orgs两个入口,后者是当前授权用户。
常见任务¶
注意事项¶
- 邀请与移除成员用的是同一条路径
…/orgs/{org}/memberships/{username},靠 HTTP 方法区分:POST邀请、DELETE移除。 - 「列出授权用户所属的组织」是
GET /api/v5/users/orgs,路径里没有{username};带{username}的版本查的是任意用户的公开组织。 - 退出组织、查询自己在组织内的成员资料走
/api/v5/user/memberships/orgs/{org},属于「授权用户视角」,不在/orgs/下。 - 企业侧成员接口前缀是
/api/v5/enterprises/{enterprise}/…,与组织侧/api/v5/orgs/{org}/…并列,角色枚举也不同(企业侧含浏览者、测试人、研发等)。 - 组织的 Issue 状态与看板配置有独立接口,Issue 本身的接口在 Issue 分组。
接口列表¶
本模块共 17 个接口。
| # | 接口 | 方法与路径 | 说明 |
|---|---|---|---|
| 1 | 列出用户所属的组织 | GET /api/v5/users/{username}/orgs |
用户调用此接口,进行列出用户所属的组织操作. |
| 2 | 列出授权用户所属的组织 | GET /api/v5/users/orgs |
用户调用此接口,进行列出授权用户所属的组织操作. |
| 3 | 获取组织成员详情 | GET /api/v5/orgs/{org}/members/{username} |
该接口用于获取指定组织下某一成员的详细信息,返回内容包括成员记录ID、组织路径、名称、地址、头像地址,以及成员对应的… |
| 4 | 获取组织信息 | GET /api/v5/orgs/{org} |
该接口用于按组织路径获取单个组织的详细信息,返回组织名称、登录名、头像、描述、所属企业、仓库、动态、成员等关联地址,… |
| 5 | 更新授权用户所管理的组织资料 | PATCH /api/v5/orgs/{org} |
该接口用于更新授权用户所管理的组织资料,可修改组织的名称、公开邮箱、所在地、简介及站点等信息。通过这个接口,用户可以… |
| 6 | 获取企业的某个成员信息 | GET /api/v5/enterprises/{enterprise}/members/{username} |
该接口用于获取指定企业下的一个成员信息,返回成员的用户信息、主页地址、活跃状态、角色及所属企业信息。 |
| 7 | 修改企业成员权限 | PUT /api/v5/enterprises/{enterprise}/members/{username} |
该接口用于修改指定企业成员在企业中的角色权限,通过设置浏览者、测试人、研发、维护者、管理员或自定义角色等角色来调整成… |
| 8 | 获取授权用户在某个组织的成员资料 | GET /api/v5/user/memberships/orgs/{org} |
用户调用此接口,进行获取授权用户在一个组织的成员资料操作. |
| 9 | 退出组织 | DELETE /api/v5/user/memberships/orgs/{org} |
用户调用此接口,进行退出一个组织操作. |
| 10 | 列出组织的所有成员 | GET /api/v5/orgs/{org}/members |
该接口用于获取指定组织的全部成员列表,支持分页查询,并可依据成员角色(管理员或普通成员)进行筛选,返回成员的头像、昵… |
| 11 | 列出企业的所有成员 | GET /api/v5/enterprises/{enterprise}/members |
该接口用于列出指定企业的所有成员,支持按角色筛选成员,并分页返回企业成员列表,包含成员角色及用户信息。 |
| 12 | 移除授权用户所管理组织中的成员 | DELETE /api/v5/orgs/{org}/memberships/{username} |
该接口用于从指定组织中移除指定成员,通过组织路径与用户名定位目标成员,移除成功后返回空对象,帮助组织管理者调整组织成… |
| 13 | 邀请组织成员 | POST /api/v5/orgs/{org}/memberships/{username} |
该接口用于邀请指定用户加入组织,可为其设置成员权限(拉代码、推代码、管理员或自定义角色),未指定时默认授予推送权限,… |
| 14 | 列出指定组织的所有关注者 | GET /api/v5/orgs/{org}/followers |
该接口用于获取指定组织的所有关注者列表,支持分页查询,返回关注者的用户ID、登录名、昵称、头像地址及关注时间等信息。 |
| 15 | 获取 issue 扩展配置 | GET /api/v5/orgs/{org}/issue/extend/settings |
该接口用于获取指定组织下 issue 的扩展配置,返回各 issue 类型(如需求、咨询)及其对应的状态配置信息。 |
| 16 | 获取组织自定义角色 | GET /api/v5/orgs/{org}/customized_roles |
该接口用于获取指定组织的自定义角色列表,返回各角色的 ID、名称、访问级别、成员数量等详细信息,便于查看组织的自定义… |
| 17 | 创建组织 | POST /api/v5/orgs |
该接口用于创建组织,提交组织路径、名称、可见性及描述等信息后,在平台中新建一个组织,并返回所创建组织的 ID、网页地… |
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc