List IdP groups for an organization

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."

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:

{ "groups": [ { "group_description": "A group of Developers working on AzureAD SAML SSO", "group_id": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa", "group_name": "saml-azuread-test" }, { "group_description": "Another group of Developers working on AzureAD SAML SSO", "group_id": "2bb2bb2b-bb22-22bb-2bb2-bb2bbb2bb2b2", "group_name": "saml-azuread-test2" } ] }

Responses

🟢200response

application/json

Body

External Groups to be mapped to a team for membership

groups

array [object {5}]

optional

Array of groups to be mapped to this team

Example:

[{"group_description":"A group of Developers working on AzureAD SAML SSO","group_id":"111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa","group_name":"saml-azuread-test"},{"group_description":"Another group of Developers working on AzureAD SAML SSO","group_id":"2bb2bb2b-bb22-22bb-2bb2-bb2bbb2bb2b2","group_name":"saml-azuread-test2"}]

group_description

string

required

a description of the group

Example:

A group of Developers working on AzureAD SAML SSO

group_id

string

required

The ID of the group

Example:

111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa

group_name

string

required

The name of the group

Example:

saml-azuread-test

status

string

optional

synchronization status for this group mapping

Example:

unsynced

synced_at

string

optional

the time of the last sync for this group-mapping

Example:

2019-06-03 22:27:15:000 -700

List IdP groups for an organization

Request

Responses