external_groups

Overview

Name	external_groups
Type	Resource
Id	github.teams.external_groups

Fields

Name	Datatype	Description
group_id	integer	The internal ID of the group
group_name	string	The display name of the group
updated_at	string	The time of the last update for this group

Methods

Name	Accessible by	Required Params	Description
list_external_idp_groups_for_org	SELECT	org	Lists external groups available in an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also 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." You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "GitHub's products" in the GitHub Help documentation.
list_linked_external_idp_groups_to_team_for_org	SELECT	org, team_slug	Lists a connection between a team and an external group. You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "GitHub's products" in the GitHub Help documentation.
external_idp_group_info_for_org	EXEC	group_id, org	Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "GitHub's products" in the GitHub Help documentation.
link_external_idp_group_to_team_for_org	EXEC	org, team_slug, data__group_id	Creates a connection between a team and an external group. Only one external group can be linked to a team. You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "GitHub's products" in the GitHub Help documentation.
unlink_external_idp_group_from_team_for_org	EXEC	org, team_slug	Deletes a connection between a team and an external group. You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.