获取项目自定义角色¶

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

该接口用于获取指定仓库（项目）下的自定义角色列表，返回包含角色名称、权限级别、成员数量、创建时间及更新时间等信息的角色对象数组。

访问令牌支持说明¶

AtomGit 用户访问令牌（AtomGit user access tokens）

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址（企业、组织或个人的地址 path）
`repo`	path	string	是	仓库路径（path）
`access_token`	query	string	是	用户授权码

响应参数¶

字段	类型	必返	可为空	说明
`role_id`	string	是	否	角色 ID
`access_level`	integer	是	否	权限级别（示例值为 `15`）
`role_name`	string	是	否	角色名称
`role_chinese_name`	string	是	否	角色中文名称
`role_description`	string	是	否	角色描述
`role_type`	string	是	否	角色类型；本接口固定返回 `project-customized`
`member_count`	integer	是	否	角色成员数量
`created_at`	string	是	否	创建时间（格式如 `2024-04-17 08:00`）
`updated_at`	string	是	否	更新时间（格式如 `2024-04-17 08:00`）
`role_from`	string	是	—	角色来源（该字段定义于响应 DTO，取值含义未能解析）

接口返回一个自定义角色对象数组，上表描述的是数组元素（单个角色对象）的字段结构。

失败响应¶

该接口需要认证且要求具备项目访问权限，认证失败或权限不足时返回对应错误。以下为常见失败响应示例（错误字段名以后端实际返回为准）：

401 未认证

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

403 禁止访问

{
  "error": "forbidden",
  "message": "没有权限访问该项目"
}

404 资源不存在

{
  "error": "not_found",
  "message": "仓库不存在"
}

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	请求路径或资源不存在（Not found）

请求示例¶

参数说明¶

<owner> — 替换为仓库所属空间地址（企业、组织或个人的地址 path）； <repo> — 替换为仓库路径（path）； <token> — 替换为你的 AtomGit 用户访问令牌。

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/customized_roles?access_token=<token>' \
  -H 'Accept: application/json'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch(
  "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/customized_roles?access_token=<token>",
  {
    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>/customized_roles",
    params={"access_token": "<token>"},
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

[
  {
    "role_id": "e6cd76d6c82f46c78c71fd7f67eaf3bf",
    "access_level": 15,
    "role_name": "测试角色",
    "role_chinese_name": "测试角色",
    "role_description": "测试角色",
    "role_type": "project-customized",
    "member_count": 1,
    "created_at": "2024-04-17 08:00",
    "updated_at": "2024-04-17 08:00"
  }
]

错误码¶

错误码	说明
`401`	未认证或凭证无效（缺少/无效的访问凭证）
`403`	禁止访问（无权限）
`404`	请求路径或资源不存在
`400`	参数错误或请求无法解析
`500`	系统内部错误

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