Create or update IdP group connections

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups array will remove all connections for a team.

Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings.

curl --location --request PATCH 'https://api.github.com/orgs//teams//team-sync/group-mappings' \ --header 'Content-Type: application/json' \ --data-raw '{ "groups": [ { "group_description": "string", "group_id": "123", "group_name": "Octocat admins" } ] }'

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

org

string

required

team_slug

string

required

team_slug parameter

Body Params application/json

groups

array [object {3}]

required

The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.

group_description

string

required

Description of the IdP group.

group_id

string

required

ID of the IdP group.

group_name

string

required

Name of the IdP group.

Examples

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