协作者的 REST API 终结点

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

Enterprise Server 3.12

Enterprise Server 3.13

Enterprise Server 3.14

Free, Pro, & Team

REST API

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

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

域名

谁可以使用此功能？

操作

需要多个权限，或者可以使用不同的权限。 有关权限的更多信息，请参阅此终结点的文档。

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

协作者的 REST API 终结点 - GitHub 文档

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

快速入门

REST API 简介

比较 GitHub 的 API

API 版本

重大更改

OpenAPI 描述

入门

速率限制

分页

Libraries

最佳做法

故障排除

时区

CORS 与 JSONP

议题事件类型

GitHub 事件类型

使用 REST API

身份验证

确保 API 凭据安全

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

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

细化 PAT 的终结点

GitHub 应用的权限

细化 PAT 的权限

使用 JavaScript 编写脚本

使用 Ruby 编写脚本

为用户发现资源

交付部署

将数据渲染为图形

处理注释

构建 CI 服务器

入门 - Git 数据库

开始 - 检查

加密机密

Guides

Artifacts

缓存

OIDC

权限

机密

自托管运行器组

自托管运行程序

变量

工作流程作业

工作流运行

工作流

事件

通知

标星

关注中

活动

GitHub Apps

安装

卖场

OAuth 授权

Webhook

应用

计费

分支

受保护的分支

检查运行

检查套件

检查

教室

代码扫描

配置

代码安全设置

行为准则

Codespaces

组织

组织机密

存储库机密

用户机密

协作者

邀请

提交

提交注释

提交状态

Copilot metrics

Copilot 使用情况

Copilot 用户管理

Copilot

警报

Dependabot

依赖项检查

依赖项提交

软件材料清单 (SBOM)

依赖关系图

部署密钥

部署分支策略

部署

环境

保护规则

部署状态

表情符号

Gists

Blob

参考

标记

Trees

Git 数据库

Gitignore

存储库

用户

交互

问题

受理人

里程碑

时间线

许可证

Markdown

元数据

社区

统计信息

交通

指标

源终结点

迁移

阻止用户

自定义属性

成员

组织角色

外部协作者

个人访问令牌

规则套件

规则

安全管理员

Boards

卡片

Projects (classic)

拉取请求

评价注释

审查请求

审阅

反应

发行版本

发布资产

自动链接

前叉

Search

机密扫描

全局安全公告

存储库安全公告

安全通知

Teams

讨论评论

讨论

证明

电子邮件

关注者

GPG 密钥

Git SSH 密钥

社交帐户

SSH 签名密钥

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.
The authenticated user must have push access to the repository to use this endpoint.
OAuth app tokens and personal access tokens (classic) need the <code>read:org</code> and <code>repo</code> scopes 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). For more information, see "<a href="https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api">Using pagination in the REST API</a>."

per_page

The page number of the results to fetch. For more information, see "<a href="https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api">Using pagination in the REST API</a>."

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.
The authenticated user must have push access to the repository to use this endpoint.
OAuth app tokens and personal access tokens (classic) need the <code>read:org</code> and <code>repo</code> scopes 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. We accept the following permissions to be set: <code>pull</code>, <code>triage</code>, <code>push</code>, <code>maintain</code>, <code>admin</code> and you can also specify a custom repository role name, if the owning organization has defined any.

Add a collaborator with triage permissions

Response when a new invitation is created

https://api.github.com/repos/octocat/Hello-World/contents/{+path}

Hello-World

This endpoint triggers <a href="https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "<a href="https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits">Rate limits for the API</a>" and "<a href="https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api">Best practices for using the REST API</a>."
Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "<a href="https://docs.github.com/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/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/rest/guides/getting-started-with-the-rest-api#http-method">HTTP method</a>."
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href="https://docs.github.com/rest/collaborators/invitations">API</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.
Rate limits
You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

Add a repository collaborator