List IdP groups for a team (Legacy)

Deprecated

GET

/teams/{team_id}/team-sync/group-mappings

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List IdP groups for a team endpoint.

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 connected to a team on GitHub.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/teams//team-sync/group-mappings'

Response Example

200 - Example 1

{
    "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"
        }
    ]
}

Request

Path Params

team_id

integer

required

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

🟠403403

🟠404404

Modified at 2022-09-10 00:54:32

List teams for the authenticated user

Create or update IdP group connections (Legacy)