Skip to main content

Enterprise Server 3.21 は、現在リリース候補として使用できます。

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

エンタープライズ チームの REST API エンドポイント

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

Enterprise チームについて

データの再利用可能要素.企業.企業チームAPI %}

List enterprise teams

List all teams in the enterprise for the authenticated user

Fine-grained access tokens for "List enterprise teams"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

  • "Enterprise teams" enterprise permissions (read)

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

ヘッダー
名前, タイプ, 説明
accept string

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

パスパラメーター
名前, タイプ, 説明
enterprise string 必須

The slug version of the enterprise name.

クエリ パラメーター
名前, タイプ, 説明
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

HTTP response status codes for "List enterprise teams"

Status code説明
200

OK

403

Forbidden

Code samples for "List enterprise teams"

Request example

get/enterprises/{enterprise}/teams
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/teams

Response

Status: 200
[ { "id": 1, "name": "Justice League", "description": "A great team.", "slug": "justice-league", "url": "https://HOSTNAME/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://HOSTNAME/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.

Fine-grained access tokens for "Create an enterprise team"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

  • "Enterprise teams" enterprise permissions (write)

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

ヘッダー
名前, タイプ, 説明
accept string

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

パスパラメーター
名前, タイプ, 説明
enterprise string 必須

The slug version of the enterprise name.

ボディパラメータ
名前, タイプ, 説明
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.

デフォルト: disabled

次のいずれかにできます: all, disabled

organization_selection_type string

Specifies which organizations in the enterprise should have access to this team. Can be one of disabled, selected, or all. disabled: The team is not assigned to any organizations. This is the default when you create a new team. selected: The team is assigned to specific organizations. You can then use the add organization assignments API endpoint. all: The team is assigned to all current and future organizations in the enterprise.

デフォルト: disabled

次のいずれかにできます: disabled, selected, all

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.

notification_setting string

The notification setting the team is set to. The options are:

  • notifications_enabled - team members receive notifications when the team is @mentioned.
  • notifications_disabled - no one receives notifications.

Default: notifications_enabled

次のいずれかにできます: notifications_enabled, notifications_disabled

HTTP response status codes for "Create an enterprise team"

Status code説明
201

Created

Code samples for "Create an enterprise team"

Request example

post/enterprises/{enterprise}/teams
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ http(s)://HOSTNAME/api/v3/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://HOSTNAME/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://HOSTNAME/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.

Fine-grained access tokens for "Get an enterprise team"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

  • "Enterprise teams" enterprise permissions (read)

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

ヘッダー
名前, タイプ, 説明
accept string

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

パスパラメーター
名前, タイプ, 説明
enterprise string 必須

The slug version of the enterprise name.

team_slug string 必須

The slug of the team name.

HTTP response status codes for "Get an enterprise team"

Status code説明
200

OK

403

Forbidden

Code samples for "Get an enterprise team"

Request example

get/enterprises/{enterprise}/teams/{team_slug}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/teams/TEAM_SLUG

Response

Status: 200
{ "id": 1, "name": "Justice League", "description": "A great team.", "slug": "justice-league", "url": "https://HOSTNAME/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://HOSTNAME/enterprises/dc/teams/justice-league/members{/member}", "created_at": "2019-01-26T19:01:12Z", "updated_at": "2019-01-26T19:14:43Z" }

Update an enterprise team

To edit a team, the authenticated user must be an enterprise owner.

Fine-grained access tokens for "Update an enterprise team"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

  • "Enterprise teams" enterprise permissions (write)

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

ヘッダー
名前, タイプ, 説明
accept string

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

パスパラメーター
名前, タイプ, 説明
enterprise string 必須

The slug version of the enterprise name.

team_slug string 必須

The slug of the team name.

ボディパラメータ
名前, タイプ, 説明
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.

デフォルト: disabled

次のいずれかにできます: all, disabled

organization_selection_type string

Specifies which organizations in the enterprise should have access to this team. Can be one of disabled, selected, or all. disabled: The team is not assigned to any organizations. This is the default when you create a new team. selected: The team is assigned to specific organizations. You can then use the add organization assignments API. all: The team is assigned to all current and future organizations in the enterprise.

デフォルト: disabled

次のいずれかにできます: disabled, selected, all

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.

notification_setting string

The notification setting the team is set to. The options are:

  • notifications_enabled - team members receive notifications when the team is @mentioned.
  • notifications_disabled - no one receives notifications.

次のいずれかにできます: notifications_enabled, notifications_disabled

HTTP response status codes for "Update an enterprise team"

Status code説明
200

OK

403

Forbidden

Code samples for "Update an enterprise team"

Request example

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: 2026-03-10" \ http(s)://HOSTNAME/api/v3/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://HOSTNAME/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://HOSTNAME/enterprises/dc/teams/justice-league/members{/member}", "created_at": "2019-01-26T19:01:12Z", "updated_at": "2019-01-26T19:14:43Z" }

Delete an enterprise team

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

If you are an enterprise owner, deleting an enterprise team will delete all of its IdP mappings as well.

Fine-grained access tokens for "Delete an enterprise team"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

  • "Enterprise teams" enterprise permissions (write)

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

ヘッダー
名前, タイプ, 説明
accept string

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

パスパラメーター
名前, タイプ, 説明
enterprise string 必須

The slug version of the enterprise name.

team_slug string 必須

The slug of the team name.

HTTP response status codes for "Delete an enterprise team"

Status code説明
204

No Content

403

Forbidden

Code samples for "Delete an enterprise team"

Request example

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: 2026-03-10" \ http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/teams/TEAM_SLUG

Response

Status: 204