library
turbot/pipes
Get Involved
Version
Pipeline: Invite Organization Member by Email
Invite member to an organization by user email address.
Run the pipeline
To run this pipeline from your terminal:
flowpipe pipeline run pipes.pipeline.invite_organization_member_by_email \ --arg 'org_handle=<string>' \ --arg 'email=<string>' \ --arg 'role=<string>'
Use this pipeline
To call this pipeline from your pipeline, use a step:
step "pipeline" "step_name" { pipeline = pipes.pipeline.invite_organization_member_by_email args = { org_handle = <string> email = <string> role = <string> }}
Params
Name | Type | Required | Description | Default |
---|---|---|---|---|
conn | connection.pipes | Yes | Name of Pipes connection to use. If not provided, the default Pipes connection will be used. | connection.pipes.default |
org_handle | string | Yes | Specify the handle of an organization where the member need to be invited. | - |
string | Yes | The email of the user to be invited. | - | |
role | string | Yes | The role to be assigned to the member. Supported values are member and owner. | - |
Outputs
Name | Description |
---|---|
invitation | The details of the invitation. |