teams

Overview

Name	teams
Type	Resource
Id	github.teams.teams

Fields

Name	Datatype	Description
id	integer	Unique identifier of the team
name	string	Name of the team
description	string
updated_at	string
organization	object	Organization Full
node_id	string
privacy	string	The level of privacy this team should have
repositories_url	string
members_url	string
url	string	URL for the team
ldap_dn	string	Distinguished Name (DN) that team maps to within LDAP environment
html_url	string
permission	string	Permission that the team will have for its repositories
members_count	integer
created_at	string
repos_count	integer
parent	object	Groups of organization members that gives permissions on specified repositories.
slug	string

Methods

Name	Accessible by	Required Params	Description
get_by_name	SELECT	org, team_slug	Gets a team using the team's slug. GitHub generates the slug from the team name. Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
list	SELECT	org	Lists all teams in an organization that are visible to the authenticated user.
list_for_authenticated_user	SELECT		List all of the teams across all of the organizations to which the authenticated user belongs. This method requires user, repo, or read:org scope when authenticating via OAuth.
create	INSERT	org, data__name	To create a team, the authenticated user must be a member or owner of {org}. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "Setting team creation permissions." When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see "About teams".
delete_in_org	DELETE	org, team_slug	To delete a team, the authenticated user must be an organization owner or team maintainer. If you are an organization owner, deleting a parent team will delete all of its child teams as well. Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.
update_in_org	EXEC	org, team_slug	To edit a team, the authenticated user must either be an organization owner or a team maintainer. Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.