sample
turbot/flowpipe-samples/invite-pipes-organization-member
Get Involved
Version
Pipeline: 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
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 |
organization_handle | string | Yes | Specify the handle of an organization where the member need to be invited. | - |
string | Yes | Email-id of the member to be invited. | - | |
role | string | Yes | 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 |
Outputs
Name | Description |
---|---|
invitation_details | Invitation details. |
Tags
recommended = true