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

REST API endpoints for enterprise team members

Use the REST API to create and manage enterprise teams in your GitHub enterprise.

About enterprise teams

メモ

These endpoints are currently in パブリックプレビュー and subject to change.

This API documentation is for enterprises on GitHub Enterprise Cloud.

If your enterprise is Copilot Business for non-GHE, please refer to the early access documentation link that was previously shared to you.

These endpoints are only available to authenticated members of the enterprise team's enterprise with classic personal access tokens with the read:enterprise scope for GET APIs and admin:enterprise for other APIs.

These endpoints are not compatible with fine-grained personal access tokens or GitHub App access tokens.

GitHub generates the enterprise team's slug from the team name and adds the ent: prefix.

List enterprise teams

List all teams in the enterprise for the authenticated user

"List enterprise teams" のきめ細かいアクセストークン

このエンドポイントは、GitHub アプリのユーザーアクセストークン、GitHub アプリのインストールアクセストークン、またはきめ細かい個人用アクセストークンでは機能しません。

"List enterprise teams" のパラメーター

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

パスパラメーター
名前, Type, 説明
`enterprise` string 必須 The slug version of the enterprise name.

クエリパラメーター
名前, 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 enterprise teams" の HTTP 応答状態コード

状態コード	説明
`200`	OK
`403`	Forbidden

"List enterprise teams" のコードサンプル

GHE.com で GitHub にアクセスする場合は、api.github.com を api.SUBDOMAIN.ghe.com にあるエンタープライズの専用サブドメインに置き換えます。

要求の例

get/enterprises/{enterprise}/teams

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

Response

Status: 200

[
  {
    "id": 1,
    "name": "Justice League",
    "description": "A great team.",
    "slug": "justice-league",
    "url": "https://api.github.com/enterprises/dc/teams/justice-league",
    "group_id": "62ab9291-fae2-468e-974b-7e45096d5021",
    "html_url": "https://github.com/enterprises/dc/teams/justice-league",
    "members_url": "https://api.github.com/enterprises/dc/teams/justice-league/members{/member}",
    "created_at": "2019-01-26T19:01:12Z",
    "updated_at": "2019-01-26T19:14:43Z"
  }
]

Create an enterprise team

To create an enterprise team, the authenticated user must be an owner of the enterprise.

"Create an enterprise team" のきめ細かいアクセストークン

"Create an enterprise team" のパラメーター

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

パスパラメーター
名前, Type, 説明
`enterprise` string 必須 The slug version of the enterprise name.

本文のパラメーター
名前, Type, 説明
`name` string 必須 The name of the team.
`description` string or null A description of the team.
`sync_to_organizations` string Retired: this field is no longer supported. Whether the enterprise team should be reflected in each organization. This value cannot be set. Default: `disabled` 次のいずれかにできます: `all`, `disabled`
`group_id` string or null The ID of the IdP group to assign team membership with. You can get this value from the REST API endpoints for SCIM.

"Create an enterprise team" の HTTP 応答状態コード

状態コード	説明
`201`	Created

"Create an enterprise team" のコードサンプル

GHE.com で GitHub にアクセスする場合は、api.github.com を api.SUBDOMAIN.ghe.com にあるエンタープライズの専用サブドメインに置き換えます。

要求の例

post/enterprises/{enterprise}/teams

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 \
  -d '{"name":"Justice League","description":"A great team.","group_id":"62ab9291-fae2-468e-974b-7e45096d5021"}'

Response

Status: 201

[
  {
    "id": 1,
    "name": "Justice League",
    "description": "A great team.",
    "slug": "justice-league",
    "url": "https://api.github.com/enterprises/dc/teams/justice-league",
    "group_id": "62ab9291-fae2-468e-974b-7e45096d5021",
    "html_url": "https://github.com/enterprises/dc/teams/justice-league",
    "members_url": "https://api.github.com/enterprises/dc/teams/justice-league/members{/member}",
    "created_at": "2019-01-26T19:01:12Z",
    "updated_at": "2019-01-26T19:14:43Z"
  }
]

Get an enterprise team

Gets a team using the team's slug. To create the slug, GitHub replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator and adds the "ent:" prefix. For example, "My TEam Näme" would become ent:my-team-name.

"Get an enterprise team" のきめ細かいアクセストークン

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

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

パスパラメーター
名前, Type, 説明
`enterprise` string 必須 The slug version of the enterprise name.
`team_slug` string 必須 The slug of the team name.

"Get an enterprise team" の HTTP 応答状態コード

状態コード	説明
`200`	OK
`403`	Forbidden

"Get an enterprise team" のコードサンプル

GHE.com で GitHub にアクセスする場合は、api.github.com を api.SUBDOMAIN.ghe.com にあるエンタープライズの専用サブドメインに置き換えます。

要求の例

get/enterprises/{enterprise}/teams/{team_slug}

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/TEAM_SLUG

Response

Status: 200

[
  {
    "id": 1,
    "name": "Justice League",
    "description": "A great team.",
    "slug": "justice-league",
    "url": "https://api.github.com/enterprises/dc/teams/justice-league",
    "group_id": "62ab9291-fae2-468e-974b-7e45096d5021",
    "html_url": "https://github.com/enterprises/dc/teams/justice-league",
    "members_url": "https://api.github.com/enterprises/dc/teams/justice-league/members{/member}",
    "created_at": "2019-01-26T19:01:12Z",
    "updated_at": "2019-01-26T19:14:43Z"
  }
]

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

パスパラメーター
名前, Type, 説明
`enterprise` string 必須 The slug version of the enterprise name.
`team_slug` string 必須 The slug of the team name.

本文のパラメーター
名前, Type, 説明
`name` string or null A new name for the team.
`description` string or null A new description for the team.
`sync_to_organizations` string Retired: this field is no longer supported. Whether the enterprise team should be reflected in each organization. This value cannot be changed. Default: `disabled` 次のいずれかにできます: `all`, `disabled`
`group_id` string or null The ID of the IdP group to assign team membership with. The new IdP group will replace the existing one, or replace existing direct members if the team isn't currently linked to an IdP group.

"Update an enterprise team" の HTTP 応答状態コード

状態コード	説明
`200`	OK
`403`	Forbidden

"Update an enterprise team" のコードサンプル

GHE.com で GitHub にアクセスする場合は、api.github.com を api.SUBDOMAIN.ghe.com にあるエンタープライズの専用サブドメインに置き換えます。

要求の例

patch/enterprises/{enterprise}/teams/{team_slug}

curl -L \
  -X PATCH \
  -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/TEAM_SLUG \
  -d '{"name":"Justice League","description":"A great team.","group_id":"62ab9291-fae2-468e-974b-7e45096d5021"}'

Response

Status: 200

[
  {
    "id": 1,
    "name": "Justice League",
    "description": "A great team.",
    "slug": "justice-league",
    "url": "https://api.github.com/enterprises/dc/teams/justice-league",
    "group_id": "62ab9291-fae2-468e-974b-7e45096d5021",
    "html_url": "https://github.com/enterprises/dc/teams/justice-league",
    "members_url": "https://api.github.com/enterprises/dc/teams/justice-league/members{/member}",
    "created_at": "2019-01-26T19:01:12Z",
    "updated_at": "2019-01-26T19:14:43Z"
  }
]

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

パスパラメーター
名前, Type, 説明
`enterprise` string 必須 The slug version of the enterprise name.
`team_slug` string 必須 The slug of the team name.

"Delete an enterprise team" の HTTP 応答状態コード

状態コード	説明
`204`	No Content
`403`	Forbidden

"Delete an enterprise team" のコードサンプル

GHE.com で GitHub にアクセスする場合は、api.github.com を api.SUBDOMAIN.ghe.com にあるエンタープライズの専用サブドメインに置き換えます。

要求の例

delete/enterprises/{enterprise}/teams/{team_slug}

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/TEAM_SLUG

Response

Status: 204

REST API endpoints for enterprise team members

About enterprise teams

List enterprise teams

"List enterprise teams" のきめ細かいアクセストークン

"List enterprise teams" のパラメーター

"List enterprise teams" の HTTP 応答状態コード

"List enterprise teams" のコードサンプル

要求の例

Response

Create an enterprise team

"Create an enterprise team" のきめ細かいアクセストークン

"Create an enterprise team" のパラメーター

"Create an enterprise team" の HTTP 応答状態コード

"Create an enterprise team" のコードサンプル

要求の例

Response

Get an enterprise team

"Get an enterprise team" のきめ細かいアクセストークン

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

"Get an enterprise team" の HTTP 応答状態コード

"Get an enterprise team" のコードサンプル

要求の例

Response

Update an enterprise team

"Update an enterprise team" のきめ細かいアクセストークン

"Update an enterprise team" のパラメーター

"Update an enterprise team" の HTTP 応答状態コード

"Update an enterprise team" のコードサンプル

要求の例

Response

Delete an enterprise team

"Delete an enterprise team" のきめ細かいアクセストークン

"Delete an enterprise team" のパラメーター

"Delete an enterprise team" の HTTP 応答状態コード

"Delete an enterprise team" のコードサンプル

要求の例

Response