邀请组织成员¶

POST /api/v5/orgs/{org}/memberships/{username}

该接口用于邀请指定用户加入组织，可为其设置成员权限（拉代码、推代码、管理员或自定义角色），未指定时默认授予推送权限，并返回被邀请用户的信息及所获权限集合。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`org`	path	string	是	仓库所属空间地址(企业、组织或个人的地址path)
`username`	path	string	是	用户名(username/login)
`access_token`	query	string	是	用户授权码

Request Body:

邀请时需在请求体中指定成员权限；无请求体时按默认权限 push 处理。

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "permission": {
      "description": "成员权限：拉代码(pull)，推代码(push)，管理员(admin)，customized(自定义角色)。默认：push",
      "type": "string",
      "enum": ["pull", "push", "admin", "customized"],
      "default": "push"
    },
    "role_id": {
      "description": "角色ID，如果 permission 传入了 customized 则需要传入角色 id",
      "type": "string"
    }
  },
  "required": []
}

响应参数¶

字段	类型	必返	可为空	说明
`followers_url`	string	否	是	关注者列表 URL
`html_url`	string	否	是	用户在平台的主页 URL
`id`	string	否	是	用户 ID
`login`	string	否	是	登录名
`name`	string	否	是	用户名
`type`	string	否	是	用户类型，如 `User`
`url`	string	否	是	用户 URL
`permissions`	object	否	是	邀请后授予的权限集合
`member_role`	string	否	是	成员角色

permissions 对象

字段	类型	必返	可为空	说明
`permissions.pull`	boolean	否	是	是否拥有拉取代码权限
`permissions.push`	boolean	否	是	是否拥有推送代码权限
`permissions.admin`	boolean	否	是	是否拥有管理员权限
`permissions.customized`	boolean	否	是	是否拥有自定义角色权限

失败响应¶

400 参数错误

{
  "message": "组织不存在"
}

401 未认证

{
  "message": "未登录"
}

404 用户不存在

{
  "message": "用户未找到"
}

400 权限参数非法

{
  "message": "permission must in [pull,push,admin,customized]"
}

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`400`	参数错误（如组织不存在、用户已被拉黑、permission 非法）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	用户不存在
`500`	系统内部错误

请求示例¶

参数说明¶

<org> 替换为组织路径（企业、组织或个人的地址 path）；<username> 替换为被邀请的用户名；<token> 替换为你的 AtomGit 用户访问令牌。

cURL¶

curl -X POST 'https://api.atomgit.com/api/v5/orgs/<org>/memberships/<username>?access_token=<token>' \
  -H 'Content-Type: application/json' \
  -d '{"permission": "push"}'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const url = new URL("https://api.atomgit.com/api/v5/orgs/<org>/memberships/<username>");
url.searchParams.set("access_token", "<YOUR-TOKEN>");

const response = await fetch(url, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Accept": "application/json",
  },
  body: JSON.stringify({ permission: "push" }),
});

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

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

Python¶

import requests

resp = requests.post(
    "https://api.atomgit.com/api/v5/orgs/<org>/memberships/<username>",
    params={"access_token": "<YOUR-TOKEN>"},
    json={"permission": "push"},
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "followers_url": "https://api.atomgit.com/api/v5/users/xiaogang2/followers",
  "html_url": "https://api.atomgit.com/xiaogang2",
  "id": "65ffca965079ba0d1c00f6f2",
  "login": "xiaogang2",
  "name": "肖刚2",
  "type": "User",
  "url": "https://api.atomgit.com/api/v5/xiaogang2",
  "permissions": {
    "admin": false,
    "customized": true,
    "push": true,
    "pull": true
  },
  "member_role": ""
}

错误码¶

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

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