Onboard Users by Sending Email Invitations

For the complete documentation index, see llms.txt. For a full content snapshot, see llms-full.txt. Append .md to any kestra.io/docs/* URL for plain Markdown.

Available on: Enterprise EditionCloud

Add users to a tenant or instance by invitation.

Administrators can invite users with pre-configured RBAC permissions. If an email server is configured, Kestra sends the invitation link by email. Otherwise, you can copy and share the link manually.

How to invite users

  1. Go to IAM in the sidebar and open the Users tab.
  2. Click + Add.
  3. Enter the user’s email address and select a group (via the Groups tab) or assign a role directly (via the Roles tab).
  4. Click + Add to send the invitation email or display the shareable link.

Accepting invitations

Available on:

v>=2.0.10Enterprise EditionCloud

When a user receives an invitation, they open the link in the email. If they’re already signed in to Kestra, the invitation is accepted right away and they land in the tenant they were invited to.

Otherwise, the link opens a Create your Kestra account page. What it shows depends on the authentication methods enabled on the instance:

  • Password login, the default: a form with first name, last name, and password. Continue creates the account and joins the tenant. If passwordless OTP is also enabled, the password is optional.
  • Passwordless OTP without password login: the form asks only for first and last name.
  • SSO: a button for each identity provider. After signing in with the provider, the user comes back to the invitation and joins the tenant without going through the Kestra login page.

When the form is shown, Already have an account? lets an existing user log in instead and then return to the invitation.

When password login is disabled (micronaut.security.basic-auth.enabled: false) and SSO is the only method, the page shows only the identity provider buttons. The API enforces the same rule: POST /api/v1/invitation/create/{invitationId} returns 400 if the request includes a password.

If password-based login is enabled, the password they choose must satisfy the instance password policy configured under kestra.security.basic-auth. See Security and Secrets configuration for the available password policy settings.

Invite expiration time

Users have 7 days to accept the invitation. After this period, the invitation expires and must be reissued.

To change the default expiration, set expireAfter in kestra.security.invitations. For example, to set 30 days:

kestra:
security:
invitations:
expireAfter: P30D

Was this page helpful?