이제 REST API의 버전이 지정되었습니다. 자세한 내용은 "API 버전 관리 정보"를 참조하세요.

엔터프라이즈 팀 구성원을 위한 REST API 엔드포인트

REST API를 사용하여 GitHub 엔터프라이즈에 엔터프라이즈 팀 멤버 자격을 만들고 관리할 수 있습니다.

엔터프라이즈 팀 구성원 정보

참고 항목

이 엔드포인트는 현재 공개 미리 보기 버전이며 변경될 수 있습니다.

이 API 문서는 GitHub Enterprise Cloud의 엔터프라이즈용입니다.

엔터프라이즈가 GHE가 아닌 Copilot Business라면, 이전에 공유된 초기 액세스 문서 링크를 참조하세요.

이 엔드포인트는 클래식 personal access tokens을 사용하는 엔터프라이즈 팀의 엔터프라이즈에 인증된 구성원만 사용할 수 있으며, 필요한 권한은 read:enterprise scope(GET API용) 및 admin:enterprise(기타 API용)입니다.

이러한 엔드포인트는 fine-grained personal access tokens 또는 GitHub 앱 액세스 토큰과는 호환되지 않습니다.

GitHub는 팀 name에서 엔터프라이즈 팀의 slug를 생성하고 ent: 접두사를 추가합니다.

List members in an enterprise team

Lists all team members in an enterprise team.

"List members in an enterprise team"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"List members in an enterprise team"에 대한 매개 변수

머리글
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
enterprise string Required

The slug version of the enterprise name.

enterprise-team string Required

The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.

쿼리 매개 변수
per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

기본값: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

기본값: 1

"List members in an enterprise team"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

OK

"List members in an enterprise team"에 대한 코드 샘플

요청 예제

get/enterprises/{enterprise}/teams/{enterprise-team}/memberships
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/enterprises/ENTERPRISE/teams/ENTERPRISE-TEAM/memberships

Response

Status: 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 } ]

Bulk add team members

Add multiple team members to an enterprise team.

"Bulk add team members"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"Bulk add team members"에 대한 매개 변수

머리글
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
enterprise string Required

The slug version of the enterprise name.

enterprise-team string Required

The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.

본문 매개 변수
usernames array of strings Required

The GitHub user handles to add to the team.

"Bulk add team members"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

Successfully added team members.

"Bulk add team members"에 대한 코드 샘플

요청 예제

post/enterprises/{enterprise}/teams/{enterprise-team}/memberships/add
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/ENTERPRISE/teams/ENTERPRISE-TEAM/memberships/add \ -d '{"usernames":["monalisa","octocat"]}'

Successfully added team members.

Status: 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 } ]

Bulk remove team members

Remove multiple team members from an enterprise team.

"Bulk remove team members"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"Bulk remove team members"에 대한 매개 변수

머리글
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
enterprise string Required

The slug version of the enterprise name.

enterprise-team string Required

The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.

본문 매개 변수
usernames array of strings Required

The GitHub user handles to be removed from the team.

"Bulk remove team members"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

Successfully removed team members.

"Bulk remove team members"에 대한 코드 샘플

요청 예제

post/enterprises/{enterprise}/teams/{enterprise-team}/memberships/remove
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/ENTERPRISE/teams/ENTERPRISE-TEAM/memberships/remove \ -d '{"usernames":["monalisa","octocat"]}'

Successfully removed team members.

Status: 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 } ]

Get enterprise team membership

Returns whether the user is a member of the enterprise team.

"Get enterprise team membership"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"Get enterprise team membership"에 대한 매개 변수

머리글
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
enterprise string Required

The slug version of the enterprise name.

enterprise-team string Required

The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.

username string Required

The handle for the GitHub user account.

"Get enterprise team membership"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

User is a member of the enterprise team.

"Get enterprise team membership"에 대한 코드 샘플

요청 예제

get/enterprises/{enterprise}/teams/{enterprise-team}/memberships/{username}
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/enterprises/ENTERPRISE/teams/ENTERPRISE-TEAM/memberships/USERNAME

User is a member of the enterprise team.

Status: 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 }

Add team member

Add a team member to an enterprise team.

"Add team member"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"Add team member"에 대한 매개 변수

머리글
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
enterprise string Required

The slug version of the enterprise name.

enterprise-team string Required

The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.

username string Required

The handle for the GitHub user account.

"Add team member"에 대한 HTTP 응답 상태 코드

상태 코드설명
201

Successfully added team member

"Add team member"에 대한 코드 샘플

요청 예제

put/enterprises/{enterprise}/teams/{enterprise-team}/memberships/{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/enterprises/ENTERPRISE/teams/ENTERPRISE-TEAM/memberships/USERNAME

Successfully added team member

Status: 201
{ "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 }

Remove team membership

Remove membership of a specific user from a particular team in an enterprise.

"Remove team membership"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"Remove team membership"에 대한 매개 변수

머리글
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
enterprise string Required

The slug version of the enterprise name.

enterprise-team string Required

The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.

username string Required

The handle for the GitHub user account.

"Remove team membership"에 대한 HTTP 응답 상태 코드

상태 코드설명
204

No Content

403

Forbidden

"Remove team membership"에 대한 코드 샘플

요청 예제

delete/enterprises/{enterprise}/teams/{enterprise-team}/memberships/{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/enterprises/ENTERPRISE/teams/ENTERPRISE-TEAM/memberships/USERNAME

Response

Status: 204