跳转至

获取仓库的所有成员

GET /api/v5/repos/{owner}/{repo}/collaborators

该接口用于获取指定仓库的所有成员信息,支持按页码与每页数量分页查询。返回内容包括成员的基础资料(如成员 ID、登录名、头像、主页等)以及各项权限信息(拉取、推送、是否管理员),便于查看仓库成员的构成及访问权限。

访问令牌支持说明

  • AtomGit 用户访问令牌(AtomGit user access tokens)

是否允许匿名访问

此接口不允许匿名访问

请求参数

参数名 位置 类型 必填 说明
owner path string 是 仓库所属空间地址(组织或个人的地址path)
repo path string 是 仓库路径(path)
access_token query string 是 用户授权码
page query integer 否 当前的页码,默认为 1
per_page query integer 否 每页的数量,最大为 100,默认 20

响应参数

接口返回成员对象数组(array<object>),每个元素表示一个仓库成员。各字段含义如下:

成员对象

字段 类型 必返 可为空 说明
id string 是 否 成员 ID
name string 是 否 成员名称
username string 是 否 成员登录名
nick_name — 否 是 昵称
state — 否 是 用户状态
avatar — 否 是 头像
avatar_url — 否 是 头像地址
email — 否 是 邮箱
name_cn — 否 是 中文名
web_url string 是 否 成员主页地址
access_level — 否 是 访问级别
expires_at — 否 是 到期时间
limited — 否 是 是否受限
type string 是 否 成员类型(如 ProjectMember)
last_owner — 否 是 上一任仓库所有者
is_current_source_member — 否 是 是否为当前来源成员
last_source_owner — 否 是 上一任来源所有者
join_way — 否 是 加入方式
source_name — 否 是 来源名称
member_roles — 否 是 成员角色
iam_id — 否 是 IAM ID
committer_system_from — 否 是 提交者系统来源
permissions object 是 否 权限信息

permissions 对象

字段 类型 必返 可为空 说明
permissions.pull — 否 是 拉取(pull)权限
permissions.push — 否 是 推送(push)权限
permissions.admin integer 是 否 是否为管理员(参考文档示例中返回布尔值 true/false)

Note: 参考文档未明确给出部分字段的具体类型(其示例中值为 null,表中以 — 标注),实际类型以接口返回为准。

失败响应

400 参数错误

{
  "error": "invalid_request",
  "message": "请求参数不合法"
}

401 未认证

{
  "error": "unauthorized",
  "message": "缺少或无效的访问令牌"
}

403 禁止访问

{
  "error": "forbidden",
  "message": "没有权限查看该仓库的成员"
}

Note: 以上失败响应仅为通用示例,具体错误字段名以后端实际返回为准。

HTTP 响应状态码

状态码 说明
200 成功(OK)
401 需要认证(Requires authentication)
403 禁止访问(Forbidden)

请求示例

参数说明

示例中的占位符含义如下:

<owner> 替换为仓库所属空间地址(组织或个人的地址 path); <repo> 替换为仓库路径(path); <token> 替换为你的 AtomGit 用户访问令牌。

cURL

curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/collaborators?access_token=<token>&page=1&per_page=20' \
  -H 'Accept: application/json'

JavaScript

// 原生 fetch (Node.js 18+ / 浏览器)
const params = new URLSearchParams({
  access_token: "<YOUR-TOKEN>",
  page: "1",
  per_page: "20",
});

const response = await fetch(
  `https://api.atomgit.com/api/v5/repos/<owner>/<repo>/collaborators?${params}`,
  {
    headers: {
      "Accept": "application/json",
    },
  }
);

if (!response.ok) {
  throw new Error(`请求失败: ${response.status}`);
}

const data = await response.json();
console.log(data);

Python

import requests

resp = requests.get(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/collaborators",
    params={
        "access_token": "<YOUR-TOKEN>",
        "page": 1,
        "per_page": 20,
    },
    headers={
        "Accept": "application/json",
    },
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例

状态码: 200

[
  {
    "id": "708",
    "name": "Lzm_0916",
    "username": "Lzm_0916",
    "nick_name": null,
    "state": null,
    "avatar": null,
    "avatar_url": null,
    "email": null,
    "name_cn": null,
    "web_url": "https://api.atomgit.com/Lzm_0916",
    "access_level": null,
    "expires_at": null,
    "limited": null,
    "type": "ProjectMember",
    "last_owner": null,
    "is_current_source_member": null,
    "last_source_owner": null,
    "join_way": null,
    "source_name": null,
    "member_roles": null,
    "iam_id": null,
    "committer_system_from": null,
    "permissions": {
      "pull": null,
      "push": null,
      "admin": true
    }
  }
]

错误码

错误码 说明
401 未认证或凭证无效(缺少/无效的访问凭证)
403 禁止访问,无权限操作
404 请求路径不存在
429 请求过于频繁,触发限流
500 系统内部错误

本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc