Skip to main content

Enterprise Server 3.21 está disponível no momento como versão candidata a lançamento.

A API REST agora é versionada. Para obter mais informações, confira "Sobre o controle de versão da API".

Pontos de extremidade da API REST para organizações de equipes empresariais

Use a API REST para criar e gerenciar atribuições de organização para equipes empresariais em sua empresa GitHub enterprise.

Sobre organizações de equipe corporativa

Observação

Esses pontos de extremidade estão em prévia pública e estão sujeitos a alterações.

Esta documentação de API é para empresas no GitHub Enterprise Cloud.

Se sua empresa for do Copilot Business para não GHE, consulte o link da documentação de acesso antecipado que foi compartilhado com você.

Esses pontos de extremidade só estão disponíveis para membros autenticados da equipe corporativa com o personal access tokens clássico com o escopo read:enterprise para APIs do GET e admin:enterprise para outras APIs.

Esses pontos de extremidade não são compatíveis com fine-grained personal access tokens ou tokens de acesso do Aplicativo GitHub.

O GitHub gera o slug da equipe corporativa com base no name da equipe e adiciona o prefixo ent:.

Get organization assignments

Get all organizations assigned to an enterprise team

Fine-grained access tokens for "Get organization assignments"

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)

Parâmetros para "Get organization assignments"

Cabeçalhos
Nome, Tipo, Descrição
accept string

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

Parâmetros de caminho
Nome, Tipo, Descrição
enterprise string Obrigatório

The slug version of the enterprise name.

enterprise-team string Obrigatório

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

Parâmetros de consulta
Nome, Tipo, Descrição
per_page integer

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

Padrão: 30

page integer

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

Padrão: 1

HTTP response status codes for "Get organization assignments"

Status codeDescrição
200

An array of organizations the team is assigned to

Code samples for "Get organization assignments"

Request example

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: 2026-03-10" \ 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.

Fine-grained access tokens for "Add organization assignments"

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)

Parâmetros para "Add organization assignments"

Cabeçalhos
Nome, Tipo, Descrição
accept string

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

Parâmetros de caminho
Nome, Tipo, Descrição
enterprise string Obrigatório

The slug version of the enterprise name.

enterprise-team string Obrigatório

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

Parâmetros do corpo
Nome, Tipo, Descrição
organization_slugs array of strings Obrigatório

Organization slug to assign the team to.

HTTP response status codes for "Add organization assignments"

Status codeDescrição
200

Successfully assigned the enterprise team to organizations.

Code samples for "Add organization assignments"

Request example

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: 2026-03-10" \ 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.

Fine-grained access tokens for "Remove organization assignments"

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)

Parâmetros para "Remove organization assignments"

Cabeçalhos
Nome, Tipo, Descrição
accept string

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

Parâmetros de caminho
Nome, Tipo, Descrição
enterprise string Obrigatório

The slug version of the enterprise name.

enterprise-team string Obrigatório

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

Parâmetros do corpo
Nome, Tipo, Descrição
organization_slugs array of strings Obrigatório

Organization slug to unassign the team from.

HTTP response status codes for "Remove organization assignments"

Status codeDescrição
204

Successfully unassigned the enterprise team from organizations.

Code samples for "Remove organization assignments"

Request example

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: 2026-03-10" \ 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

Fine-grained access tokens for "Get organization assignment"

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)

Parâmetros para "Get organization assignment"

Cabeçalhos
Nome, Tipo, Descrição
accept string

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

Parâmetros de caminho
Nome, Tipo, Descrição
enterprise string Obrigatório

The slug version of the enterprise name.

enterprise-team string Obrigatório

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

org string Obrigatório

The organization name. The name is not case sensitive.

HTTP response status codes for "Get organization assignment"

Status codeDescrição
200

The team is assigned to the organization

404

The team is not assigned to the organization

Code samples for "Get organization assignment"

Request example

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: 2026-03-10" \ 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.

Fine-grained access tokens for "Add an organization assignment"

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)

Parâmetros para "Add an organization assignment"

Cabeçalhos
Nome, Tipo, Descrição
accept string

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

Parâmetros de caminho
Nome, Tipo, Descrição
enterprise string Obrigatório

The slug version of the enterprise name.

enterprise-team string Obrigatório

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

org string Obrigatório

The organization name. The name is not case sensitive.

HTTP response status codes for "Add an organization assignment"

Status codeDescrição
201

Successfully assigned the enterprise team to the organization.

Code samples for "Add an organization assignment"

Request example

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: 2026-03-10" \ 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.

Fine-grained access tokens for "Delete an organization assignment"

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)

Parâmetros para "Delete an organization assignment"

Cabeçalhos
Nome, Tipo, Descrição
accept string

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

Parâmetros de caminho
Nome, Tipo, Descrição
enterprise string Obrigatório

The slug version of the enterprise name.

enterprise-team string Obrigatório

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

org string Obrigatório

The organization name. The name is not case sensitive.

HTTP response status codes for "Delete an organization assignment"

Status codeDescrição
204

Successfully unassigned the enterprise team from the organization.

Code samples for "Delete an organization assignment"

Request example

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

Successfully unassigned the enterprise team from the organization.

Status: 204