teams
Get an external group
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.
get/orgs/{org}/external-group/{group_id}
Path parameters
orgstring required
The organization name. The name is not case sensitive.
group_idinteger required
The unique identifier of the group.
Query parameters
per_pageinteger
The number of results per page for the "members" array (max 100). For more information, see "Using pagination in the REST API."
pageinteger
The page number of the "members" array results to fetch. For more information, see "Using pagination in the REST API."
Response
Response
Example response
{
"group_id": 1,
"group_name": "group-azuread-test",
"updated_at": "2021-01-03 22:27:15:000 -700",
"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"
}
]
}