协作者

Enterprise Cloud

Enterprise Server

Enterprise Server 3.10

Enterprise Server 3.6

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

所有 GitHub 文档都是开源的。 看到错误或不清楚的内容了吗？ 提交拉取请求。

帮助我们创建出色的文档！

在 GitHub 旅程中随时为你提供帮助。

可以是以下选项之一

名称

所有 {{ name }} 指南

{{ name }} 学习路径

操作

输入搜索词以在 GitHub 文档中找到它。

协作者 - GitHub AE Docs

使用 REST API 在存储库中添加、邀请和删除协作者。

English

Simplified Chinese

Spanish

Portuguese

Russian

Japanese

French

German

Korean

快速入门

关于 GitHub 的 API

REST API 中的资源

媒体类型

身份验证

确保 API 凭据安全

故障排除

议题事件类型

GitHub 事件类型

适用于 GitHub Apps 安装令牌的终结点

适用于 GitHub Apps 用户令牌的终结点

GitHub 应用的权限

概述

使用 API

使用 JavaScript 编写脚本

为用户发现资源

交付部署

将数据渲染为图形

处理注释

分页

构建 CI 服务器

最佳实践

入门 - Git 数据库

开始 - 检查

加密机密

Guides

Artifacts

权限

机密

自托管运行器组

自托管运行程序

工作流程作业

工作流运行

工作流

事件

通知

标星

关注中

活动

GitHub 应用

安装

OAuth 授权

Webhook

应用

分支

受保护的分支

检查运行

检查套件

检查

代码扫描

行为准则

邀请

提交

提交注释

提交状态

部署密钥

部署分支策略

部署

环境

部署状态

表情符号

管理统计

公告

审核日志

全局 Webhook

许可证

组织

预接收环境

用户

企业管理

Gists

注释

Blob

reference

标记

Trees

Git 数据库

Gitignore

问题

受理人

里程碑

时间线

Markdown

元数据

统计信息

指标

迁移

成员

外部协作者

Boards

卡片

Project boards

拉取

评价注释

审查请求

审阅

速率限制

反应

发行版本

发布资产

自动链接

前叉

Git LFS

存储库

搜索

机密扫描

Teams

讨论评论

讨论

外部组

关注者

GPG 密钥

Git SSH 密钥

存储库 Webhook 配置

存储库 Webhook 交付

存储库 Webhook

仓库 web 挂钩

Collaborator

For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.
Team members will include the members of child teams.
You must authenticate using an access token with the <code>read:org</code> and <code>repo</code> scopes with push access to use this
endpoint. GitHub Apps must have the <code>members</code> organization permission and <code>metadata</code> repository permission to use this
endpoint.

The account owner of the repository. The name is not case sensitive.

owner

The name of the repository without the <code>.git</code> extension. The name is not case sensitive.

repo

Filter collaborators returned by their affiliation. <code>outside</code> means all outside collaborators of an organization-owned repository. <code>direct</code> means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. <code>all</code> means all collaborators the authenticated user can see.

affiliation

Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.

permission

The number of results per page (max 100).

per_page

Page number of the results to fetch.

page

List repository collaborators

Response if user is a collaborator

For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
Team members will include the members of child teams.
You must authenticate using an access token with the <code>read:org</code> and <code>repo</code> scopes with push access to use this
endpoint. GitHub Apps must have the <code>members</code> organization permission and <code>metadata</code> repository permission to use this
endpoint.

The handle for the GitHub user account.

username

Not Found if user is not a collaborator

Check if a user is a repository collaborator

The permission to grant the collaborator. Only valid on organization-owned repositories.

Add a collaborator with triage permissions

Response when:
<ul>
<li>an existing collaborator is added as a collaborator</li>
<li>an organization member is added as an individual collaborator</li>
<li>an existing team member (whose team is also a repository collaborator) is added as an individual collaborator</li>
</ul>

This endpoint triggers <a href="https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See "<a href="https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits">Secondary rate limits</a>" and "<a href="https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits">Dealing with secondary rate limits</a>" for details.
Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "<a href="https://docs.github.com/github-ae@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories">Enforcing repository management policies in your enterprise</a>."
For more information on permission levels, see "<a href="https://docs.github.com/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization">Repository permission levels for an organization</a>". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
<pre><code>Cannot assign {member} permission of {role name}
</code></pre>
Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see "<a href="https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs">HTTP verbs</a>."
Updating an existing collaborator's permission level
The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.

Validation failed, or the endpoint has been spammed.

Add a repository collaborator

No Content when collaborator was removed from the repository.

Removes a collaborator from a repository.
To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.
This endpoint also:
<ul>
<li>Cancels any outstanding invitations</li>
<li>Unasigns the user from any issues</li>
<li>Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.</li>
<li>Unstars the repository</li>
<li>Updates access permissions to packages</li>
</ul>
Removing a user as a collaborator has the following effects on forks:
<ul>
<li>If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.</li>
<li>If the user had their own fork of the repository, the fork will be deleted.</li>
<li>If the user still has read access to the repository, open pull requests by this user from a fork will be denied.</li>
</ul>
Note: A user can still have access to the repository through organization permissions like base repository permissions.
Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.
For more information on fork permissions, see "<a href="https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks">About permissions and visibility of forks</a>".

Remove a repository collaborator

Repository Collaborator Permission

Checks the repository permission of a collaborator. The possible repository
permissions are <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>.
Note: The <code>permission</code> attribute provides the legacy base roles of <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>, where the
<code>maintain</code> role is mapped to <code>write</code> and the <code>triage</code> role is mapped to <code>read</code>. To determine the role assigned to the
collaborator, see the <code>role_name</code> attribute, which will provide the full role name, including custom roles. The
<code>permissions</code> hash can also be used to determine which base level of access the collaborator has to the repository.