Pipeline: Create Organization Invitation

Invites a user to an organization.

Run the pipeline

To run this pipeline from your terminal:

flowpipe pipeline run github.pipeline.create_organization_invitation \
  --arg 'organization=<string>' \
  --arg 'email=<string>'

Use this pipeline

To call this pipeline from your pipeline, use a step:

step "pipeline" "step_name" {
  pipeline = github.pipeline.create_organization_invitation  
  args = {
    organization = <string>
    email = <string>
  }
}

Params

Name	Type	Required	Description	Default
conn	connection.github	Yes	Name of Github connection to use. If not provided, the default Github connection will be used.	`connection.github.default`
organization	string	Yes	The organization name. The name is not case sensitive.	-
email	string	Yes	Email address of the person you are inviting, which can be an existing GitHub user.	-
role	string	Yes	"The role for the new member." `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."	`direct_member`

Outputs

Name	Description
invitation	Invitation details.