team_sync

Overview

Name	team_sync
Type	Resource
Id	github.teams.team_sync

Fields

Name	Datatype	Description
group_id	string	The ID of the group
group_name	string	The name of the group
status	string	synchronization status for this group mapping
synced_at	string	the time of the last sync for this group-mapping
group_description	string	a description of the group

Methods

Name	Accessible by	Required Params	Description
list_idp_groups_for_legacy	SELECT	team_id	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.
list_idp_groups_for_org	SELECT	org	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."
list_idp_groups_in_org	SELECT	org, team_slug	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. Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings.
create_or_update_idp_group_connections_in_org	INSERT	org, team_slug	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.
create_or_update_idp_group_connections_legacy	INSERT	team_id, data__groups	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.