跳转至

获取企业的一个成员

GET /api/v8/enterprises/{enterprise}/members/{username}

用户调用此接口，进行获取企业的一个成员操作。

访问令牌支持说明

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

是否允许匿名访问

此接口不允许匿名访问

请求参数

参数名 位置 类型 必填 说明
enterprise path integer 是 企业id
username path string 是 用户名(username/login)
access_token query string 是 用户授权码

响应参数

字段 类型 必返 可为空 说明
user object 是 否 成员对应的用户信息
active boolean 是 否 是否已激活
role string 是 否 成员角色
role_name string 是 否 角色名称
role_id string 是 否 角色 ID
role_name_cn string 是 否 角色中文名称
enterprise_email string 是 否 企业邮箱

user 对象

字段 类型 必返 可为空 说明
user.avatar_url string 是 否 头像地址
user.html_url string 是 否 主页地址
user.id string 是 否 用户 ID
user.object_id string 是 否 对象 ID
user.login string 是 否 登录名（username/login）
user.name string 是 否 姓名
user.url string 是 否 用户主页地址
user.user_id string 是 否 用户 ID

失败响应

只有 200/成功响应是不够的：调用方需要知道失败长什么样才能写错误处理。

400 参数错误

{
  "error": "invalid_request",
  "message": "参数 username 不能为空",
  "field": "username"
}

401 未认证

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

404 资源不存在

{
  "error": "not_found",
  "message": "企业或成员不存在"
}

错误字段名以后端实际返回为准。

HTTP 响应状态码

状态码 说明
200 成功（OK）
400 参数错误（Bad request）
401 需要认证（Requires authentication）
403 禁止访问（Forbidden）
404 资源不存在（Not found）

请求示例

参数说明

<enterprise> 替换为企业的 ID；<username> 替换为成员的用户名（username/login）；<token> 替换为你的 AtomGit 用户访问令牌。

cURL

curl -X GET 'https://api.atomgit.com/api/v8/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/v8/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/v8/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://api.atomgit.com/avatars/octocat.png",
    "html_url": "https://api.atomgit.com/octocat",
    "id": "268",
    "object_id": "268",
    "login": "octocat",
    "name": "Octocat",
    "url": "https://api.atomgit.com/octocat",
    "user_id": "268"
  },
  "active": true,
  "role": "admin",
  "role_name": "admin",
  "role_id": "1",
  "role_name_cn": "管理员",
  "enterprise_email": "octocat@example.com"
}

错误码

错误码 说明
400 参数错误或请求无法解析
401 未认证或凭证无效（缺少/无效的访问凭证）
403 禁止访问
404 请求路径不存在
429 请求过于频繁，触发限流
500 系统内部错误

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