Back to GithubAdd team access restrictions
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.
Input
type: object
properties:
parameters:
type: object
properties:
owner:
type: string
description: The account owner of the repository. The name is not case sensitive.
repo:
type: string
description: The name of the repository. The name is not case sensitive.
branch:
type: string
description: >-
The name of the branch. Cannot contain wildcard characters. To use
wildcard characters in branch names, use [the GraphQL
API](https://docs.github.com/graphql).
required:
- owner
- repo
- branch
title: Parameters
data:
oneOf:
- type: object
properties:
teams:
type: array
description: The slug values for teams
items:
type: string
required:
- teams
example:
teams:
- my-team
- type: array
description: The slug values for teams
items:
type: string
title: Data
Output
type: array
items:
type: object
title: Team
properties:
id:
type: integer
node_id:
type: string
name:
type: string
slug:
type: string
description:
type: string
nullable: true
privacy:
type: string
notification_setting:
type: string
permission:
type: string
permissions:
type: object
properties:
pull:
type: boolean
triage:
type: boolean
push:
type: boolean
maintain:
type: boolean
admin:
type: boolean
url:
type: string
format: uri
html_url:
type: string
format: uri
example: https://github.com/orgs/rails/teams/core
members_url:
type: string
repositories_url:
type: string
format: uri
parent:
type: object
title: Team Simple
properties:
id:
description: Unique identifier of the team
type: integer
example: 1
node_id:
type: string
example: MDQ6VGVhbTE=
url:
description: URL for the team
type: string
format: uri
example: https://api.github.com/organizations/1/team/1
members_url:
type: string
example: https://api.github.com/organizations/1/team/1/members{/member}
name:
description: Name of the team
type: string
example: Justice League
description:
description: Description of the team
type: string
nullable: true
example: A great team.
permission:
description: Permission that the team will have for its repositories
type: string
example: admin
privacy:
description: The level of privacy this team should have
type: string
example: closed
notification_setting:
description: The notification setting the team has set
type: string
example: notifications_enabled
html_url:
type: string
format: uri
example: https://github.com/orgs/rails/teams/core
repositories_url:
type: string
format: uri
example: https://api.github.com/organizations/1/team/1/repos
slug:
type: string
example: justice-league
ldap_dn:
description: Distinguished Name (DN) that team maps to within LDAP environment
example: uid=example,ou=users,dc=github,dc=com
type: string