org_member: Invite, Remove, or Modify User Membership in an Organization

In coatless/ghapi3: GitHub v3 API Implementation

Invite, Remove, or Modify User Membership in an Organization

Description

Sends an invitation, removes, or modifies a user role within an organization.

Usage

add_org_member(org, username, role = c("member", "admin"))

remove_org_member(org, username)

update_org_member_role(org, username, role = c("member", "admin"))

check_org_private_membership(org, username)

check_org_public_membership(org, username)

Arguments

org	Name of the organization.
username	Name of the user on GitHub.
role	The role to give the user in the organization. Can be one of: '"admin"' or '"member"'. Default: '"member"'

Details

To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.

Role

- '"admin"' - The user will become an owner of the organization. - '"member"' - The user will become a non-owner member of the organization.

Private Membership

This function is a work in progress.

References

<https://developer.github.com/v3/orgs/members/#add-or-update-organization-membership>

<https://developer.github.com/v3/orgs/members/#remove-a-member>

GitHub API Documentation reference for private membership check <https://developer.github.com/v3/orgs/members/#check-membership>

GitHub API Documentation reference for public membership check <https://developer.github.com/v3/orgs/members/#check-public-membership>

coatless/ghapi3 documentation built on Dec. 12, 2023, 3:52 a.m.