Skip to main content
We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.
GitHub AE is currently under limited release.

Externe Gruppen

Verwende die REST-API, um die externen Identitätsanbietergruppen anzeigen, die für deine Organisation verfügbar sind, und um die Verbindung zwischen externen Gruppen und Teams in deiner Organisation zu verwalten.

Informationen zu externen Gruppen

Um diese Endpunkte verwenden zu können, müssen authentifizierte Benutzer entweder Teambetreuer oder Besitzer der Organisation sein, die dem Team zugeordnet ist.

Get an external group

Works with GitHub Apps

Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "GitHub's products" in the GitHub Help documentation.

Parameters

Headers
Name, Type, BESCHREIBUNG
acceptstring

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

Path parameters
Name, Type, BESCHREIBUNG
orgstringRequired

The organization name. The name is not case sensitive.

group_idintegerRequired

The unique identifier of the group.

HTTP response status codes

Status codeBESCHREIBUNG
200

OK

Code samples

get/orgs/{org}/external-group/{group_id}
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ https://HOSTNAME/api/v3/orgs/ORG/external-group/GROUP_ID

Response

Status: 200
{ "group_id": "123", "group_name": "Octocat admins", "updated_at": "2021-01-24T11:31:04-06:00", "teams": [ { "team_id": 1, "team_name": "team-test" }, { "team_id": 2, "team_name": "team-test2" } ], "members": [ { "member_id": 1, "member_login": "mona-lisa_eocsaxrs", "member_name": "Mona Lisa", "member_email": "mona_lisa@github.com" }, { "member_id": 2, "member_login": "octo-lisa_eocsaxrs", "member_name": "Octo Lisa", "member_email": "octo_lisa@github.com" } ] }

List external groups in an organization

Works with GitHub Apps

Lists external groups available in an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub AE generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see "Offset and Cursor Pagination explained."

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "GitHub's products" in the GitHub Help documentation.

Parameters

Headers
Name, Type, BESCHREIBUNG
acceptstring

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

Path parameters
Name, Type, BESCHREIBUNG
orgstringRequired

The organization name. The name is not case sensitive.

Query parameters
Name, Type, BESCHREIBUNG
per_pageinteger

The number of results per page (max 100).

Default: 30

pageinteger

Page token

display_namestring

Limits the list to groups containing the text in the group name

HTTP response status codes

Status codeBESCHREIBUNG
200

OK

Code samples

get/orgs/{org}/external-groups
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ https://HOSTNAME/api/v3/orgs/ORG/external-groups

Response

Status: 200
{ "groups": [ { "group_id": "123", "group_name": "Octocat admins", "updated_at": "2021-01-24T11:31:04-06:00" }, { "group_id": "456", "group_name": "Octocat docs members", "updated_at": "2021-03-24T11:31:04-06:00" } ] }

Update the connection between an external group and a team

Creates a connection between a team and an external group. Only one external group can be linked to a team.

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "GitHub's products" in the GitHub Help documentation.

Parameters

Headers
Name, Type, BESCHREIBUNG
acceptstring

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

Path parameters
Name, Type, BESCHREIBUNG
orgstringRequired

The organization name. The name is not case sensitive.

team_slugstringRequired

The slug of the team name.

Body parameters
Name, Type, BESCHREIBUNG
group_idintegerRequired

External Group Id

HTTP response status codes

Status codeBESCHREIBUNG
200

OK

Code samples

patch/orgs/{org}/teams/{team_slug}/external-groups
curl \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ https://HOSTNAME/api/v3/orgs/ORG/teams/TEAM_SLUG/external-groups \ -d '{"group_id":123}'

Response

Status: 200
{ "group_id": "123", "group_name": "Octocat admins", "updated_at": "2021-01-24T11:31:04-06:00", "teams": [ { "team_id": 1, "team_name": "team-test" }, { "team_id": 2, "team_name": "team-test2" } ], "members": [ { "member_id": 1, "member_login": "mona-lisa_eocsaxrs", "member_name": "Mona Lisa", "member_email": "mona_lisa@github.com" }, { "member_id": 2, "member_login": "octo-lisa_eocsaxrs", "member_name": "Octo Lisa", "member_email": "octo_lisa@github.com" } ] }

Remove the connection between an external group and a team

Deletes a connection between a team and an external group.

You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

Parameters

Headers
Name, Type, BESCHREIBUNG
acceptstring

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

Path parameters
Name, Type, BESCHREIBUNG
orgstringRequired

The organization name. The name is not case sensitive.

team_slugstringRequired

The slug of the team name.

HTTP response status codes

Status codeBESCHREIBUNG
204

No Content

Code samples

delete/orgs/{org}/teams/{team_slug}/external-groups
curl \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ https://HOSTNAME/api/v3/orgs/ORG/teams/TEAM_SLUG/external-groups

Response

Status: 204