samples
turbot/flowpipe-samples/invite-pipes-organization-member
OverviewPipelines
0
Triggers
0
Variables
GitHub

Invite Organization Member by Email

Invite a member to an organization by email.

Run the pipeline

To run this pipeline from your terminal:

flowpipe pipeline run invite_pipes_organization_member.pipeline.invite_organization_member_by_email \
--arg 'organization_handle=<string>' \
--arg 'email=<string>'

Use this pipeline

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

step "pipeline" "step_name" {
pipeline = invite_pipes_organization_member.pipeline.invite_organization_member_by_email
args = {
organization_handle = <string>
email = <string>
}
}

Params

NameTypeRequiredDescriptionDefault
organization_handlestringYesSpecify the handle of an organization where the member need to be invited.-
emailstringYesEmail-id of the member to be invited.-
rolestringYes The role for the new member at organization level. Supported values are:

member: Can be granted permissions in workspaces and see members of the organization.
owner: Has full administrative rights to the organization including complete access to all workspaces, connections, users, groups and permissions.
member
pipes_credstringYesName for Pipes credentials to use. If not provided, the default credentials will be used.default

Outputs

NameDescription
invitation_detailsInvitation details.