Create or update IdP group connections (Legacy)

PATCH {{baseUrl}}/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 Create or update IdP group connections endpoint.

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.

Request Body

{"groups"=>[{"group_id"=>"<string>", "group_name"=>"<string>", "group_description"=>"<string>", "id"=>"<string>", "name"=>"<string>", "description"=>"<string>"}, {"group_id"=>"<string>", "group_name"=>"<string>", "group_description"=>"<string>", "id"=>"<string>", "name"=>"<string>", "description"=>"<string>"}], "synced_at"=>"<string>"}

HEADERS

RESPONSES

status: OK

{"groups":[{"group_id":"123","group_name":"Octocat admins","group_description":"The people who configure your octoworld."}]}