Die REST-API ist jetzt versioniert. Weitere Informationen findest du unter Informationen zur API-Versionsverwaltung.

REST-API-Endpunkte für Unternehmensteamorganisationen

Verwenden Sie die REST-API, um Organisationszuweisungen für Unternehmensteams in Ihren GitHub Enterprise zu erstellen und zu verwalten.

Informationen zu Unternehmensteamorganisationen

Hinweis

Diese Endpunkte befinden sich derzeit in öffentliche Vorschau. Änderungen sind vorbehalten.

Diese API-Dokumentation ist für Unternehmen mit GitHub Enterprise Cloud bestimmt.

Wenn dein Unternehmen Copilot Business für Nicht-GHE nutzt, lies den Link zur Early-Access-Dokumentation, der zuvor geteilt wurde.

Diese Endpunkte sind lediglich für authentifizierte Mitglieder des Unternehmens im Unternehmensteams mit klassischen personal access tokens mit dem read:enterprise-Bereich für GET-APIs und admin:enterprise für weitere APIs verfügbar.

Diese Endpunkte sind nicht mit fine-grained personal access tokens oder GitHub-App-Zugriffstoken kompatibel.

GitHub generiert das slug-Element des Unternehmensteams aus dem Team name und fügt das Präfix ent: hinzu.

Get organization assignments

Get all organizations assigned to an enterprise team

Feinkörnige Zugriffstoken für "Get organization assignments"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:

  • "Enterprise teams" enterprise permissions (read)

Parameter für "Get organization assignments"

Header
accept string

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

Pfadparameter
enterprise string Erforderlich

The slug version of the enterprise name.

enterprise-team string Erforderlich

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

Abfrageparameter
per_page integer

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

Standard: 30

page integer

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

Standard: 1

HTTP-Antwortstatuscodes für "Get organization assignments"

StatuscodeBESCHREIBUNG
200

An array of organizations the team is assigned to

Codebeispiele für "Get organization assignments"

Anforderungsbeispiel

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.

Feinkörnige Zugriffstoken für "Add organization assignments"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:

  • "Enterprise teams" enterprise permissions (write)

Parameter für "Add organization assignments"

Header
accept string

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

Pfadparameter
enterprise string Erforderlich

The slug version of the enterprise name.

enterprise-team string Erforderlich

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

Körperparameter
organization_slugs array of strings Erforderlich

Organization slug to assign the team to.

HTTP-Antwortstatuscodes für "Add organization assignments"

StatuscodeBESCHREIBUNG
200

Successfully assigned the enterprise team to organizations.

Codebeispiele für "Add organization assignments"

Anforderungsbeispiel

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.

Feinkörnige Zugriffstoken für "Remove organization assignments"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:

  • "Enterprise teams" enterprise permissions (write)

Parameter für "Remove organization assignments"

Header
accept string

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

Pfadparameter
enterprise string Erforderlich

The slug version of the enterprise name.

enterprise-team string Erforderlich

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

Körperparameter
organization_slugs array of strings Erforderlich

Organization slug to unassign the team from.

HTTP-Antwortstatuscodes für "Remove organization assignments"

StatuscodeBESCHREIBUNG
204

Successfully unassigned the enterprise team from organizations.

Codebeispiele für "Remove organization assignments"

Anforderungsbeispiel

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

Feinkörnige Zugriffstoken für "Get organization assignment"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:

  • "Enterprise teams" enterprise permissions (read)

Parameter für "Get organization assignment"

Header
accept string

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

Pfadparameter
enterprise string Erforderlich

The slug version of the enterprise name.

enterprise-team string Erforderlich

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

org string Erforderlich

The organization name. The name is not case sensitive.

HTTP-Antwortstatuscodes für "Get organization assignment"

StatuscodeBESCHREIBUNG
200

The team is assigned to the organization

404

The team is not assigned to the organization

Codebeispiele für "Get organization assignment"

Anforderungsbeispiel

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.

Feinkörnige Zugriffstoken für "Add an organization assignment"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:

  • "Enterprise teams" enterprise permissions (write)

Parameter für "Add an organization assignment"

Header
accept string

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

Pfadparameter
enterprise string Erforderlich

The slug version of the enterprise name.

enterprise-team string Erforderlich

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

org string Erforderlich

The organization name. The name is not case sensitive.

HTTP-Antwortstatuscodes für "Add an organization assignment"

StatuscodeBESCHREIBUNG
201

Successfully assigned the enterprise team to the organization.

Codebeispiele für "Add an organization assignment"

Anforderungsbeispiel

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.

Feinkörnige Zugriffstoken für "Delete an organization assignment"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:

  • "Enterprise teams" enterprise permissions (write)

Parameter für "Delete an organization assignment"

Header
accept string

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

Pfadparameter
enterprise string Erforderlich

The slug version of the enterprise name.

enterprise-team string Erforderlich

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

org string Erforderlich

The organization name. The name is not case sensitive.

HTTP-Antwortstatuscodes für "Delete an organization assignment"

StatuscodeBESCHREIBUNG
204

Successfully unassigned the enterprise team from the organization.

Codebeispiele für "Delete an organization assignment"

Anforderungsbeispiel

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