列出企业的所有成员¶
GET /api/v8/enterprises/{enterprise}/members
用户调用此接口,进行列出企业的所有成员操作.
访问令牌支持说明¶
- AtomGit 用户访问令牌(AtomGit user access tokens)
是否允许匿名访问¶
此接口不允许匿名访问
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
enterprise |
path | integer | 是 | 企业 id |
access_token |
query | string | 是 | 用户授权码 |
page |
query | integer | 否 | 当前的页码,默认为 1 |
per_page |
query | integer | 否 | 每页的数量,最大为 100,默认 20 |
role |
query | string | 否 | 根据角色筛选成员,枚举:all / admin / member |
响应参数¶
响应体为 JSON 数组,每个数组元素代表一名企业成员。
| 字段 | 类型 | 必返 | 可为空 | 说明 |
|---|---|---|---|---|
user |
object | 是 | 否 | 成员的用户信息 |
active |
boolean | 是 | 否 | 成员是否处于活跃状态 |
role |
string | 是 | 否 | 成员角色标识 |
role_name |
string | 是 | 否 | 成员角色名称 |
role_id |
string | 是 | 否 | 角色 ID |
role_name_cn |
string | 是 | 否 | 角色中文名称 |
enterprise_email |
string | 否 | 是 | 成员的企业邮箱 |
user 对象
| 字段 | 类型 | 必返 | 可为空 | 说明 |
|---|---|---|---|---|
user.html_url |
string | 是 | 否 | 用户主页地址 |
user.id |
string | 是 | 否 | 用户 ID |
user.object_id |
string | 是 | 否 | 用户对象 ID |
user.login |
string | 是 | 否 | 用户登录名 |
user.name |
string | 是 | 否 | 用户名称 |
user.url |
string | 是 | 否 | 用户地址 |
user.user_id |
string | 是 | 否 | 用户 ID |
user.avatar_url |
string | 是 | 否 | 用户头像地址 |
失败响应¶
400 参数错误
401 未认证
错误字段名以后端实际返回为准。
HTTP 响应状态码¶
| 状态码 | 说明 |
|---|---|
200 |
成功(OK) |
400 |
参数错误 |
401 |
需要认证(Requires authentication) |
403 |
禁止访问(Forbidden) |
请求示例¶
参数说明¶
<enterprise>替换为企业 id;<token>替换为你的 AtomGit 用户访问令牌。
cURL¶
curl -X GET 'https://api.atomgit.com/api/v8/enterprises/<enterprise>/members?access_token=<token>&page=1&per_page=20&role=all' \
-H 'Accept: application/json'
JavaScript¶
// 原生 fetch (Node.js 18+ / 浏览器)
const enterprise = "<enterprise>";
const token = "<YOUR-TOKEN>";
const url = new URL(`https://api.atomgit.com/api/v8/enterprises/${enterprise}/members`);
url.searchParams.set("access_token", token);
url.searchParams.set("page", "1");
url.searchParams.set("per_page", "20");
url.searchParams.set("role", "all");
const response = await fetch(url, {
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/v8/enterprises/<enterprise>/members",
params={
"access_token": "<YOUR-TOKEN>",
"page": 1,
"per_page": 20,
"role": "all",
},
headers={"Accept": "application/json"},
timeout=10,
)
resp.raise_for_status()
print(resp.json())
响应示例¶
状态码: 200
[
{
"user": {
"html_url": "https://api.atomgit.com/u/octocat",
"id": "123456",
"object_id": "789012",
"login": "octocat",
"name": "Octo Cat",
"url": "https://api.atomgit.com/octocat",
"user_id": "123456",
"avatar_url": "https://api.atomgit.com/avatar.png"
},
"active": true,
"role": "member",
"role_name": "成员",
"role_id": "1",
"role_name_cn": "成员",
"enterprise_email": "octocat@atomgit.com"
}
]
错误码¶
| 错误码 | 说明 |
|---|---|
400 |
参数错误或请求无法解析 |
401 |
未认证或凭证无效(缺少/无效的访问凭证) |
403 |
禁止访问 |
404 |
请求路径不存在 |
429 |
请求过于频繁,触发限流 |
500 |
系统内部错误 |
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc