List IdP groups for an organization
GET {{baseUrl}}/orgs/:org/team-sync/groups?per_page=30&page=1
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
List IdP groups available in an organization. You can limit your page results using the per_page
parameter. GitHub 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](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89).
The per_page
parameter provides pagination for a list of IdP groups the authenticated user can access in an organization. For example, if the user octocat
wants to see two groups per page in octo-org
via cURL, it would look like this:
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
per_page | number | Results per page (max 100) | |
page | number | Page number of the results to fetch. |
RESPONSES
status: OK
{"groups":[{"group_id":"123","group_name":"Octocat admins","group_description":"The people who configure your octoworld."},{"group_id":"456","group_name":"Octocat docs members","group_description":"The people who make your octoworld come to life."}]}