user_access_restrictions

Overview

Name	user_access_restrictions
Type	Resource
Id	github.repos.user_access_restrictions

Fields

Name	Datatype
id	integer
name	string
avatar_url	string
email	string
events_url	string
followers_url	string
following_url	string
gists_url	string
gravatar_id	string
html_url	string
login	string
node_id	string
organizations_url	string
received_events_url	string
repos_url	string
site_admin	boolean
starred_at	string
starred_url	string
subscriptions_url	string
type	string
url	string

Methods

Name	Accessible by	Required Params	Description
get_users_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 people who have push access to this branch.
add_user_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 people push access for this branch. | Type | Description | | ------- | ----------------------------------------------------------------------------------------------------------------------------- | | array | Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
remove_user_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 user to push to this branch. | Type | Description | | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | array | Usernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
set_user_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 people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people. | Type | Description | | ------- | ----------------------------------------------------------------------------------------------------------------------------- | | array | Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |