delete_membership: Remove a member from an organization or team.

In ChadGoymer/githapi: User-friendly access to the GitHub API for R

Description

This function removes a user from an organization or team. Removing someone from a team does not remove them from the organization, whereas removing them from an organization also removes them from any teams within the organization.

Usage

delete_membership(user, org, team, ...)

Arguments

user	(string) The login of the user.
org	(string) The login of the organization.
team	(integer or string, optional) The ID or name of the team.
...	Parameters passed to gh_request().

Details

Note: you can only remove a user if the authenticate user is an organization "owner" or a team "maintainer".

For more details see the GitHub API documentation:

• https://docs.github.com/en/rest/reference/orgs#remove-organization-membership-for-a-user

• https://docs.github.com/en/rest/reference/teams#remove-team-membership-for-a-user

Value

delete_membership() returns a TRUE if successfully deleted.

Examples

## Not run: 

  # Remove a user from an organization
  delete_membership("ChadGoymer", "HairyCoos")

  # Remove a user from a team
  delete_membership("ChadGoymer", "HairyCoos", "HeadCoos")


## End(Not run)

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