Managing User Invitation

Overview

This guide covers how to create, view, edit, and delete user invitations. Because this project does not include a built-in mail server, invitations are not sent automatically via email. Instead, the dashboard generates a unique invitation link that you must manually copy and send to the invitee.

Creating a New User Invitation

Prerequisites

• You must be signed in to the dashboard.
• You should have permission to invite users.

Steps to Create

1. Navigate to the User Management page and click the Invite User button in the top-right corner.
2. In the modal, fill in the required fields.
3. Click on the Create Invite button.
4. Switch to the Pending Invitations tab to find the new entry.
5. Click the Copy Invite (link) icon on the card to copy the unique URL to your clipboard.
6. Manually send this link to the user via your preferred communication method (e.g., Slack, Discord, or personal email).

Example sequence:
1. Dashboard > User Management
2. Click Invite User > Fill details > Click Create Invite
3. Go to Pending Invitations
4. Click Copy Invite
5. Manually paste and send the link to the user

Tip: The form ensures the user always has at least read access to projects. This keeps invites usable for viewing the projects you assign.

Required Fields

• Email Address: Enter value in the Email Address field (example: user@example.com). This is required.
• Permission: Select at least one permission using the Permission selector. The UI enforces a minimum permission (read access) automatically.
• Projects: Optionally assign one or more projects using the Projects selector.

Viewing User Invitation

User Invitation List

• Open User Management and switch to the Pending Invitations tab. Invitations are displayed as cards showing:
  • email (invitee address)
  • assigned projects count
  • permissions badges
  • actions: Edit, Copy Invite, Delete

Filtering Options

The UI currently lists all pending invitations. The backend supports query parameters for pagination and filtering; however, the dashboard presents the full list in the Pending Invitations tab. Use your browser's find/search to quickly locate an email or permission on the page.

Filter	Description
Email	Search for an invitation by the invited email address (use browser search)
Project	Look for invitations that list assigned projects (project names shown on the card)
Permission	Look for permission badges shown on each invitation card

Search Functionality

• There is no dedicated search box in the invitations tab. To find a specific invitation, open Pending Invitations and use your browser's search (Ctrl/Cmd+F) to locate an email, project name, or permission badge.

Editing User Invitation

To Edit an User Invitation

1. In Pending Invitations find the invitation you want to change
2. Click on the Edit (pencil) icon on the invitation card
3. Update the fields in the modal and click Send Invite (or Submit depending on context) to save changes

Warning: Editing an invitation updates what the recipient will receive. If you change the email, the previous invite link will not be valid for the new address.

Deleting User Invitation

Steps to Delete

1. In Pending Invitations, locate the card for the invitation
2. Click on the Delete (trash) icon
3. Confirm the deletion if prompted

Note: This action cannot be undone. Deleting an invitation removes the pending invite and invalidates the associated invite link.

Best Practices

Do's

• Use descriptive permission names so recipients understand their access level
• Assign only the projects necessary for the invitee's role
• Keep invitation list tidy: remove stale invitations regularly

Don'ts

• Don't invite users to more projects than they need
• Don't share invite links publicly

Troubleshooting

Issue: Invite recipient reports they did not receive the invitation

Solution: Verify the email address shown on the invitation card. If correct, resend by editing the invitation or create a new one.

Issue: Invitation appears but user cannot sign up

Solution: Confirm the invitation has not been deleted and the invitee used the correct email and invite link. If needed, delete and recreate the invitation.

Frequently Asked Questions

Can I restrict which projects an invited user can see?

Yes — when creating the invite, pick specific projects in the Projects field to limit access.

Can I change permissions after an invitation is sent?

Yes — use the Edit action on the invitation card to modify permissions before the invite is accepted.