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

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

REST API を使用して、GitHub 企業でエンタープライズチームの組織の割り当てを作成および管理します。

About enterprise team organizations

メモ

These endpoints are currently in public preview 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.

Get organization assignments

Get all organizations assigned to an enterprise team

"Get organization assignments" のきめ細かいアクセストークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:

"Enterprise teams" enterprise permissions (read)

"Get organization assignments" のパラメーター

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

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

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

"Get organization assignments" の HTTP 応答状態コード

状態コード	説明
`200`	An array of organizations the team is assigned to

"Get organization assignments" のコードサンプル

要求の例

get/enterprises/{enterprise}/teams/{enterprise-team}/organizations

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/teams/ENTERPRISE-TEAM/organizations

An array of organizations the team is assigned to

Status: 200

{
  "login": "github",
  "id": 1,
  "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
  "url": "https://HOSTNAME/orgs/github",
  "repos_url": "https://HOSTNAME/orgs/github/repos",
  "events_url": "https://HOSTNAME/orgs/github/events",
  "hooks_url": "https://HOSTNAME/orgs/github/hooks",
  "issues_url": "https://HOSTNAME/orgs/github/issues",
  "members_url": "https://HOSTNAME/orgs/github/members{/member}",
  "public_members_url": "https://HOSTNAME/orgs/github/public_members{/member}",
  "avatar_url": "https://github.com/images/error/octocat_happy.gif",
  "description": "A great organization"
}

Add organization assignments

Assign an enterprise team to multiple organizations.

"Add organization assignments" のきめ細かいアクセストークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:

"Enterprise teams" enterprise permissions (write)

"Add organization assignments" のパラメーター

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

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

ボディパラメータ
名前, タイプ, 説明
`organization_slugs` array of strings 必須 Organization slug to assign the team to.

"Add organization assignments" の HTTP 応答状態コード

状態コード	説明
`200`	Successfully assigned the enterprise team to organizations.

"Add organization assignments" のコードサンプル

要求の例

post/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/teams/ENTERPRISE-TEAM/organizations/add \
  -d '{"organization_slugs":["github"]}'

Successfully assigned the enterprise team to organizations.

Status: 200

[
  {
    "login": "github",
    "id": 1,
    "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
    "url": "https://HOSTNAME/orgs/github",
    "repos_url": "https://HOSTNAME/orgs/github/repos",
    "events_url": "https://HOSTNAME/orgs/github/events",
    "hooks_url": "https://HOSTNAME/orgs/github/hooks",
    "issues_url": "https://HOSTNAME/orgs/github/issues",
    "members_url": "https://HOSTNAME/orgs/github/members{/member}",
    "public_members_url": "https://HOSTNAME/orgs/github/public_members{/member}",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "description": "A great organization"
  }
]

Remove organization assignments

Unassign an enterprise team from multiple organizations.

"Remove organization assignments" のきめ細かいアクセストークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:

"Enterprise teams" enterprise permissions (write)

"Remove organization assignments" のパラメーター

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

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

ボディパラメータ
名前, タイプ, 説明
`organization_slugs` array of strings 必須 Organization slug to unassign the team from.

"Remove organization assignments" の HTTP 応答状態コード

状態コード	説明
`204`	Successfully unassigned the enterprise team from organizations.

"Remove organization assignments" のコードサンプル

要求の例

post/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/teams/ENTERPRISE-TEAM/organizations/remove \
  -d '{"organization_slugs":["github"]}'

Successfully unassigned the enterprise team from organizations.

Status: 204

Get organization assignment

Check if an enterprise team is assigned to an organization

"Get organization assignment" のきめ細かいアクセストークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:

"Enterprise teams" enterprise permissions (read)

"Get organization assignment" のパラメーター

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

パスパラメーター
名前, タイプ, 説明
`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.
`org` string 必須 The organization name. The name is not case sensitive.

"Get organization assignment" の HTTP 応答状態コード

状態コード	説明
`200`	The team is assigned to the organization
`404`	The team is not assigned to the organization

"Get organization assignment" のコードサンプル

要求の例

get/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/teams/ENTERPRISE-TEAM/organizations/ORG

The team is assigned to the organization

Status: 200

{
  "login": "github",
  "id": 1,
  "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
  "url": "https://HOSTNAME/orgs/github",
  "repos_url": "https://HOSTNAME/orgs/github/repos",
  "events_url": "https://HOSTNAME/orgs/github/events",
  "hooks_url": "https://HOSTNAME/orgs/github/hooks",
  "issues_url": "https://HOSTNAME/orgs/github/issues",
  "members_url": "https://HOSTNAME/orgs/github/members{/member}",
  "public_members_url": "https://HOSTNAME/orgs/github/public_members{/member}",
  "avatar_url": "https://github.com/images/error/octocat_happy.gif",
  "description": "A great organization"
}

Add an organization assignment

Assign an enterprise team to an organization.

"Add an organization assignment" のきめ細かいアクセストークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:

"Enterprise teams" enterprise permissions (write)

"Add an organization assignment" のパラメーター

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

パスパラメーター
名前, タイプ, 説明
`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.
`org` string 必須 The organization name. The name is not case sensitive.

"Add an organization assignment" の HTTP 応答状態コード

状態コード	説明
`201`	Successfully assigned the enterprise team to the organization.

"Add an organization assignment" のコードサンプル

要求の例

put/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/teams/ENTERPRISE-TEAM/organizations/ORG

Successfully assigned the enterprise team to the organization.

Status: 201

{
  "login": "github",
  "id": 1,
  "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
  "url": "https://HOSTNAME/orgs/github",
  "repos_url": "https://HOSTNAME/orgs/github/repos",
  "events_url": "https://HOSTNAME/orgs/github/events",
  "hooks_url": "https://HOSTNAME/orgs/github/hooks",
  "issues_url": "https://HOSTNAME/orgs/github/issues",
  "members_url": "https://HOSTNAME/orgs/github/members{/member}",
  "public_members_url": "https://HOSTNAME/orgs/github/public_members{/member}",
  "avatar_url": "https://github.com/images/error/octocat_happy.gif",
  "description": "A great organization"
}

Delete an organization assignment

Unassign an enterprise team from an organization.

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

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンには次のアクセス許可セットが設定されている必要があります:

"Enterprise teams" enterprise permissions (write)

"Delete an organization assignment" のパラメーター

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

パスパラメーター
名前, タイプ, 説明
`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.
`org` string 必須 The organization name. The name is not case sensitive.

"Delete an organization assignment" の HTTP 応答状態コード

状態コード	説明
`204`	Successfully unassigned the enterprise team from the organization.

"Delete an organization assignment" のコードサンプル

要求の例

delete/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/teams/ENTERPRISE-TEAM/organizations/ORG

Successfully unassigned the enterprise team from the organization.

Status: 204

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

要求の例

An array of organizations the team is assigned to

要求の例

Successfully assigned the enterprise team to organizations.

要求の例

Successfully unassigned the enterprise team from organizations.

要求の例

The team is assigned to the organization

要求の例

Successfully assigned the enterprise team to the organization.

要求の例

Successfully unassigned the enterprise team from the organization.

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