team_access_restrictions

Overview

Name	team_access_restrictions
Type	Resource
Id	github.repos.team_access_restrictions

Fields

Name	Datatype	Description
id	integer
name	string
description	string
privacy	string
notification_setting	string
permission	string
node_id	string
repositories_url	string
html_url	string
members_url	string
parent	object	Groups of organization members that gives permissions on specified repositories.
permissions	object
slug	string
url	string

Methods

Name	Accessible by	Required Params	Description
get_teams_with_access_to_protected_branch	SELECT	branch, owner, repo	Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation. Lists the teams who have push access to this branch. The list includes child teams.
add_team_access_restrictions	INSERT	branch, owner, repo	Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation. Grants the specified teams push access for this branch. You can also give push access to child teams.
remove_team_access_restrictions	DELETE	branch, owner, repo	Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation. Removes the ability of a team to push to this branch. You can also remove push access for child teams.
set_team_access_restrictions	EXEC	branch, owner, repo	Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation. Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.