获取企业的某个成员信息¶
GET /api/v5/enterprises/{enterprise}/members/{username}
该接口用于获取指定企业下的一个成员信息,返回成员的用户信息、主页地址、活跃状态、角色及所属企业信息。
访问令牌支持说明¶
- AtomGit 用户访问令牌(AtomGit user access tokens)
是否允许匿名访问¶
此接口不允许匿名访问
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
enterprise |
path | string | 是 | 企业的路径(path/login) |
username |
path | string | 是 | 用户名(username/login) |
access_token |
query | string | 是 | 用户授权码 |
响应参数¶
| 字段 | 类型 | 必返 | 可为空 | 说明 |
|---|---|---|---|---|
user |
object | 是 | 否 | 企业成员的用户信息 |
url |
string | 是 | 否 | 成员主页地址 |
active |
integer | 是 | 否 | 是否活跃(示例值为布尔值 true) |
role |
string | 是 | 否 | 成员角色 |
enterprise |
object | 是 | 否 | 成员所属企业信息 |
user 对象
| 字段 | 类型 | 必返 | 可为空 | 说明 |
|---|---|---|---|---|
user.avatar_url |
string | 是 | 否 | 用户头像地址 |
user.html_url |
string | 是 | 否 | 用户的 HTML 主页地址 |
user.id |
string | 是 | 否 | 用户 ID |
user.login |
string | 是 | 否 | 用户名(登录名) |
user.name |
string | 是 | 否 | 用户昵称 |
user.user_id |
string | 是 | 否 | 用户唯一标识 |
user.object_id |
string | 是 | 否 | 对象唯一标识 |
enterprise 对象
| 字段 | 类型 | 必返 | 可为空 | 说明 |
|---|---|---|---|---|
enterprise.id |
integer | 是 | 否 | 企业 ID |
enterprise.url |
string | 是 | 否 | 企业主页地址 |
失败响应¶
仅列出本接口可能返回的常见失败场景;错误字段名以后端实际返回为准。
401 未认证
404 资源不存在
HTTP 响应状态码¶
| 状态码 | 说明 |
|---|---|
200 |
成功(OK) |
401 |
需要认证(Requires authentication) |
403 |
禁止访问(Forbidden) |
404 |
资源不存在(Not found) |
请求示例¶
参数说明¶
<enterprise>替换为企业的路径(path/login);<username>替换为成员的用户名(username/login);<token>替换为你的 AtomGit 用户访问令牌。
cURL¶
curl -X GET 'https://api.atomgit.com/api/v5/enterprises/<enterprise>/members/<username>?access_token=<token>' \
-H 'Accept: application/json'
JavaScript¶
// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch(
"https://api.atomgit.com/api/v5/enterprises/<enterprise>/members/<username>?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/enterprises/<enterprise>/members/<username>",
params={"access_token": "<token>"},
headers={
"Accept": "application/json",
},
timeout=10,
)
resp.raise_for_status()
print(resp.json())
响应示例¶
状态码: 200
{
"user": {
"avatar_url": "https://cdn-img.gitcode.com/ec/fb/430ecf07b9ee91bbbbf341d92a36783d06e69086f82ce8cf5a6406f79f1c9cf4.png",
"html_url": "https://api.atomgit.com/dengmengmian",
"id": "268",
"login": "dengmengmian",
"name": "dengmengmian"
},
"url": "https://api.atomgit.com/dengmengmian",
"active": true,
"role": "admin",
"enterprise": {
"id": 0,
"url": "https://api.atomgit.com/dengmengmian"
}
}
错误码¶
| 错误码 | 说明 |
|---|---|
401 |
未认证或凭证无效(缺少/无效的访问凭证) |
403 |
禁止访问(无权限) |
404 |
企业或成员不存在 |
500 |
系统内部错误 |
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc