v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2023-11-288093493.9 MB
teams

List external groups in an organization

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 Enterprise Server 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.

get/orgs/{org}/external-groups

Path parameters

orgstring required

The organization name. The name is not case sensitive.

Query parameters

per_pageinteger

The number of results per page (max 100).

pageinteger

Page token

display_namestring

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

Response

Response

Example response

{
  "groups": [
    {
      "group_id": 1,
      "group_name": "group-azuread-test",
      "updated_at": "2021-01-03 22:27:15:000 -700"
    },
    {
      "group_id": 2,
      "group_name": "group-azuread-test2",
      "updated_at": "2021-06-03 22:27:15:000 -700"
    }
  ]
}