협력자

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

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 Docs에서 찾으려면 검색어를 입력하세요.

협력자 - GitHub AE Docs

REST API를 사용하면 리포지토리에서 협력자를 추가, 초대 및 제거할 수 있습니다.

빠른 시작

GitHub의 API 비교

REST API의 리소스

Rate limits

미디어 유형

인증

해당 API 자격 증명 보안 유지

문제 해결

Libraries

이슈 이벤트 유형

GitHub 이벤트 유형

GitHub 앱 설치 액세스 토큰에 대한 엔드포인트

GitHub 앱 사용자 토큰에 대한 엔드포인트

GitHub 앱에 필요한 권한

개요

API 사용

JavaScript를 사용하여 스크립트

Ruby를 사용하여 스크립트

사용자에 대한 리소스 검색

배포 제공

데이터를 그래프로 렌더링

주석 작업

페이지 매김

CI 서버 빌드

모범 사례

시작 - Git 데이터베이스

시작 - 검사

비밀 암호화

Guides

Artifacts

사용 권한

비밀

자체 호스팅 실행기 그룹

자체 호스팅 실행기

워크플로 작업

워크플로 실행

워크플로

이벤트

피드

알림

별 지정

확인

활동

GitHub 앱

설치

OAuth 권한 부여

Webhooks

분기

보호된 분기

실행 확인

체크 스위트

코드 검사

사용 규정

초대

커밋

{b>커밋 주석<b}

커밋 상태

배포 키

키 배포

배포 분기 정책

배포

환경

배포 상태

이모지

관리자 통계

감사 로그

전역 webhook

라이선스

조직

사전 수신 환경

사용자

엔터프라이즈 관리자

Gists

설명

Blob

참조

Trees

Git 데이터베이스

gitignore

이슈

담당자

레이블

마일스톤

시간

마크다운

메타

통계

메트릭

마이그레이션

멤버

외부 협력자

페이지

Boards

카드

Project boards

가져오기

메모 검토

요청 검토

검토

속도 제한

{b>반응<b}

릴리스

릴리스 자산

자동 링크

콘텐츠

포크

Git LFS

리포지토리

검색

비밀 검사

Teams

토론 의견

토론

외부 그룹

팔로워

GPG 키

Git 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.
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. For more information, see "<a href="https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits">Rate limits for the API</a>" and "<a href="https://docs.github.com/github-ae@latest/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/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.