update_team: Update a team's properties in GitHub

Description Usage Arguments Details Value Examples

View source: R/teams.R

Description

This function updates a team's properties in GitHub. You can only update a team if you have the appropriate permissions.

Usage

1
update_team(team, name, description, privacy, parent_team, org, ...)

Arguments

team

(integer or string) The Id or current name of the team.

name

(string, optional) The new name of the team.

description

(string, optional) The description of the team.

privacy

(string, optional) The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:

For a non-nested team:

  • "secret": only visible to organization owners and members of this team.

  • "closed": visible to all members of this organization.

For a parent or child team:

  • "closed": visible to all members of this organization.

parent_team

(integer or string, optional) The ID or name of a team to set as the parent team.

org

(string, optional) The organization the team is associated with. Not required if your are specifying team and/or parent_team set by ID.

...

Parameters passed to gh_request().

Details

For more details see the GitHub API documentation:

Value

update_team() returns a list of the team's properties.

Team Properties:

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
## Not run: 

  # Update a team
  update_team(
    team        = "TestTeam",
    description = "This is a test team",
    privacy     = "closed",
    parent_team = "TestTeam3",
    org         = "HairyCoos"
  )


## End(Not run)

ChadGoymer/githapi documentation built on Oct. 22, 2021, 10:56 a.m.