REST API はバージョン管理になりました。詳細については、「API のバージョン管理について」を参照してください。

Enterprise チームメンバーシップの REST API エンドポイント

REST API を使って、GitHub Enterprise 内の Enterprise チームのメンバーシップを作成および管理します。

Enterprise チームメンバーについて

メモ

現在、このエンドポイントはパブリックプレビュー段階であり、変更される可能性があります。

この API ドキュメントは、GitHub Enterprise Cloud 上の Enterprise を対象としています。

Enterprise が GHE を利用していない Copilot Business である場合は、以前に共有された早期アクセス用ドキュメントリンクを参照してください。

これらのエンドポイントは、GET API の場合は read:enterprise スコープ、その他の API の場合は admin:enterprise であり、クラシック personal access tokens を利用する Enterprise チームの Enterprise に属する認証済みメンバーのみが使用できます。

これらのエンドポイントは、fine-grained personal access tokens または GitHub App アクセストークンと互換性がありません。

GitHub により、チーム name から Enterprise チームの 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" のパラメーター

ヘッダー
名前, Type, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, Type, 説明
`enterprise` string 必須 The slug version of the enterprise name.
`enterprise-team` string 必須 The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.

クエリパラメーター
名前, Type, 説明
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: `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" のきめ細かいアクセストークン

"Bulk add team members" のパラメーター

ヘッダー
名前, Type, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, Type, 説明
`enterprise` string 必須 The slug version of the enterprise name.
`enterprise-team` string 必須 The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.

本文のパラメーター
名前, Type, 説明
`usernames` array of strings 必須 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" のきめ細かいアクセストークン

"Bulk remove team members" のパラメーター

ヘッダー
名前, Type, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, Type, 説明
`enterprise` string 必須 The slug version of the enterprise name.
`enterprise-team` string 必須 The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.

本文のパラメーター
名前, Type, 説明
`usernames` array of strings 必須 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" のきめ細かいアクセストークン

"Get enterprise team membership" のパラメーター

ヘッダー
名前, Type, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, Type, 説明
`enterprise` string 必須 The slug version of the enterprise name.
`enterprise-team` string 必須 The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.
`username` string 必須 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" のきめ細かいアクセストークン

"Add team member" のパラメーター

ヘッダー
名前, Type, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, Type, 説明
`enterprise` string 必須 The slug version of the enterprise name.
`enterprise-team` string 必須 The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.
`username` string 必須 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" のきめ細かいアクセストークン

"Remove team membership" のパラメーター

ヘッダー
名前, Type, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, Type, 説明
`enterprise` string 必須 The slug version of the enterprise name.
`enterprise-team` string 必須 The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.
`username` string 必須 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

Enterprise チーム メンバーシップの REST API エンドポイント

要求の例

Response

要求の例

Successfully added team members.

要求の例

Successfully removed team members.

要求の例

User is a member of the enterprise team.

要求の例

Successfully added team member

要求の例

Response

Enterprise チームメンバーシップの REST API エンドポイント