org-invites: Create Organization Invitations

In coatless/ghapi: GitHub v3 API Implementation

Create Organization Invitations

Description

Invite multiple people to an organization using their GitHub user ID or their e-mail address.

Usage

create_org_invitation_ghname(
  org,
  invitee_id,
  role = c("admin", "direct_member", "billing_manager"),
  team_ids = NULL
)

create_org_invitation_email(
  org,
  email,
  role = c("admin", "direct_member", "billing_manager"),
  team_ids = NULL
)

Arguments

org	Name of the organization
invitee_id	GitHub user ID for the person you are inviting. Not required if you provide email.
role	Specify role for new member. Can be one of:
team_ids	Specify IDs for the teams you want to invite new members to.
email	Email address of the person you are inviting, which can be an existing GitHub user. Not required if you provide invitee_id.

Details

This set of API bindings is a WIP and requires additional values.

Role

Specify 'role' for new member. Can be one of:

- 'admin' - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. - 'direct_member' - Non-owner organization members with ability to see other members and join teams by invitation. - 'billing_manager' - Non-owner organization members with ability to manage the billing settings of your organization.

References

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

coatless/ghapi documentation built on Jan. 4, 2024, 4:37 a.m.