Kestra Plugin Create

Kestra Plugin Create

Certified

Create an invitation

Sends an invitation to a user by email, optionally assigning groups and roles.

The target Kestra instance must have kestra.url configured so that invitation emails contain a valid link for the recipient to accept the invitation. Without it the invitation is created but the email link will be empty or broken.

yaml
type: io.kestra.plugin.kestra.ee.iam.invitations.Create

Invite a user by email.

yaml
id: iam_invitation_create
namespace: company.team

tasks:
  - id: invite_user
    type: io.kestra.plugin.kestra.ee.iam.invitations.Create
    email: "user@example.com"
    groupIds:
      - "group-id-1"
Properties

Email address of the user to invite

Select API authentication

Use either an API token or HTTP Basic (username/password); do not provide both.

Definitions
apiTokenstring

API token for bearer auth

autobooleanstring
Defaulttrue

Automatically retrieve credentials from Kestra's configuration if available

The default configuration can be configured globally inside the Kestra configuration file:

  • Set kestra.tasks.sdk.authentication.api-token to use an API token
  • Set kestra.tasks.sdk.authentication.username and kestra.tasks.sdk.authentication.password for HTTP basic authentication
  • Set kestra.tasks.sdk.authentication.url to also default the Kestra API endpoint (see kestraUrl above) The Enterprise edition also provides setting a default configuration at the Namespace or Tenant level by an administrator. Set to false to also opt out of the default URL.
passwordstring

Password for HTTP Basic auth

usernamestring

Username for HTTP Basic auth

SubTypestring

Group IDs to assign to the invited user

Override Kestra API endpoint

URL used for calls to the Kestra API. When null, falls back to the url configured alongside the default SDK authentication (Namespace or Tenant level, Enterprise edition), then renders {{ kestra.url }} from configuration; if still empty, defaults to http://localhost: 8080. Trailing slashes are stripped before use.

Reference (ref) of the pluginDefaults to apply to this task.

Roles to assign to the invited user

Definitions
idstring
namespacesarray
SubTypestring

Override target tenant

Tenant identifier applied to API calls; defaults to the current execution tenant.

ID of the created invitation

More Plugins in this Category

Core Plugins and tasks
Core Plugins and tasks

Tasks that provide Kestra's built-in orchestration, I/O, and observability capabilities.

Core

122 tasks

580 blueprints

Ruby
Ruby

Tasks that run Ruby scripts.

Core

4 tasks