Skip to main content

User Invitations

Invite users to join your tenant via email. Invitation-based onboarding ensures only authorized users can create accounts.

Sending Invitations​

Via Portal​

  1. Go to /t/{tenantSlug}/portal/access-management/users
  2. Click Invite User
  3. Enter:
    • Email address - Recipient's email
    • Roles (optional) - Pre-assign roles to the invited user
    • Groups (optional) - Pre-assign group memberships
  4. Click Send Invitation

The user receives an email with a link to complete registration.

Via API​

curl -X POST https://your-domain.com/t/{tenantSlug}/api/v1/invitations \
  -H "Authorization: Bearer {admin_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "newuser@example.com",
    "roles": ["editor"],
    "groups": ["engineering"]
  }'

Bulk Invitations​

Invite multiple users at once:

curl -X POST https://your-domain.com/t/{tenantSlug}/api/v1/invitations/bulk \
  -H "Authorization: Bearer {admin_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "invitations": [
      {"email": "alice@example.com", "roles": ["editor"]},
      {"email": "bob@example.com", "roles": ["viewer"]},
      {"email": "carol@example.com", "roles": ["admin"]}
    ]
  }'

Invitation Flow​

Invitation Settings​

SettingDescriptionDefault
ExpirationHow long the invitation link is valid7 days
Registration Modeinvitation-only or openOpen

Configure at /t/{tenantSlug}/portal/configuration/auth-settings.

When registration mode is set to invitation-only, users cannot self-register - they must receive an invitation.

Managing Invitations​

ActionDescription
View PendingSee all outstanding invitations
ResendSend the invitation email again
RevokeCancel a pending invitation

Customizing Invitation Emails​

Customize the invitation email template at /t/{tenantSlug}/portal/configuration/email-templates:

  • Subject line
  • Body content
  • Branding (logo, colors)
  • Custom message from the admin

See Email Templates for details.