REST API 现在已版本化。 有关更多信息，请参阅“关于 API 版本控制”。

供外部协作者使用的 REST API 端点

使用 REST API 管理外部协作者。

列出组织的外部协作者

列出所有作为组织外部协作者的用户。

“列出组织的外部协作者”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “成员”组织权限（读取）

“列出组织的外部协作者”的参数

标头
accept 字符串

建议设置为 application/vnd.github+json。

路径参数
org 字符串 必填

组织名称。名称不区分大小写。

查询参数
filter 字符串

筛选外部协作者列表。2fa_disabled 表示仅返回未启用双因素身份验证的外部协作者。

默认值： all

可以是以下之一： 2fa_disabled, all

per_page 整数

每页结果数（最大 100）。有关更多信息，请参阅“在 REST API 中使用分页”。

默认值： 30

page 整数

要获取的结果的页码。有关更多信息，请参阅“在 REST API 中使用分页”。

默认值： 1

“列出组织的外部协作者”的 HTTP 响应状态代码

状态代码描述
200

好的

“列出组织的外部协作者”的代码示例

请求示例

获取/orgs/{org}/outside_collaborators
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/outside_collaborators

回应

状态：200
[ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ]

将组织成员转换为外部协作者

将组织成员转换为外部协作者时，他们将只能访问其当前团队成员资格允许的代码库。用户将不再是组织的成员。有关更多信息，请参阅“将组织成员转换为外部协作者”。企业管理员可能会限制将组织成员转换为外部协作者。有关更多信息，请参阅“在您的企业中执行代码库管理策略”。

“将组织成员转换为外部协作者”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “成员”组织权限（写入）

“将组织成员转换为外部协作者”的参数

标头
accept 字符串

建议设置为 application/vnd.github+json。

路径参数
org 字符串 必填

组织名称。名称不区分大小写。

username 字符串 必填

GitHub 用户帐户的句柄。

主体参数
async 布尔值

设置为 true 时，请求将异步执行。当作业成功排队时，返回 202 状态代码。

默认值： false

“将组织成员转换为外部协作者”的 HTTP 响应状态代码

状态代码描述
202

用户正在异步转换

204

用户已转换

403

如果用户是组织的最后一个所有者，不是组织的成员，或者如果企业强制执行邀请外部协作者的策略，则禁止。有关更多信息，请参阅“在您的企业中执行代码库管理策略”。

404

资源未找到

“将组织成员转换为外部协作者”的代码示例

请求示例

放置/orgs/{org}/outside_collaborators/{username}
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/outside_collaborators/USERNAME \ -d '{"async":true}'

用户正在异步转换

状态：202

从组织中删除外部协作者

从该列表中删除用户将将其从组织的所有代码库中删除。

“从组织中删除外部协作者”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “成员”组织权限（写入）

“从组织中删除外部协作者”的参数

标头
accept 字符串

建议设置为 application/vnd.github+json。

路径参数
org 字符串 必填

组织名称。名称不区分大小写。

username 字符串 必填

GitHub 用户帐户的句柄。

“从组织中删除外部协作者”的 HTTP 响应状态代码

状态代码描述
204

无内容

422

如果用户是组织的成员，则为不可处理的实体

“从组织中删除外部协作者”的代码示例

请求示例

删除/orgs/{org}/outside_collaborators/{username}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/outside_collaborators/USERNAME

回应

状态：204