Create or update IdP group connections

PATCH {{baseUrl}}/orgs/:org/teams/:team_slug/team-sync/group-mappings

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.

Request Body

{"groups"=>[{"group_id"=>"<string>", "group_name"=>"<string>", "group_description"=>"<string>"}, {"group_id"=>"<string>", "group_name"=>"<string>", "group_description"=>"<string>"}]}

HEADERS

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