Invite User to Tenant

Implement OAM::IAM::0006::0004.UC from Identity and Access Management Behaviors.

MVP2 Constraints

1. Any user of a tenant can send an invitation.
2. The system does not send the email automatically; it provides a sample message with an invitation link that the user sends manually.
3. Invitation inbox is not part of the system. Invitees are expected to manage their invitations in their email inbox.
4. Batch operations (creation, management) of invitations is out-of-scope.

Requirements

For any tenant user

1. Create an invitation to a user (identified by email) to join the tenant.
2. View all invitations sorted by creation date (descending), filterable by status (PENDING, ACCEPTED, EXPIRED, REJECTED, CANCELLED, ARCHIVED) with pagination.
3. Cancel an invitation in PENDING status.
4. Reopen an invitation in CANCELLED or EXPIRED status, returning it to PENDING.
5. Archive an invitation from any status, moving it to ARCHIVED.
6. Refresh an invitation in PENDING status, updating its invitationDate to the current date and time and its expirationDate to the current date and time plus the configured expiration interval.

For the invitee

1. Accept the invitation (joining the tenant).
2. Reject the invitation.

For the system

1. Provide the invitation as a link encoding the invitation identifier and (for convenience) the invitee’s email.
2. Validate the invitation:
   • Exists
   • Is in PENDING status
   • Is addressed to the logged-in user

Information Model

General Information Contents

All entities will include the following information:

Field Name	Type	Description	Notes
id	UUID	A unique identifier for the entity in the system	Generated by the system. Not editable
rId	UUID	A unique identifier for a particular version of the entity	Not editable
createdBy	Text	The identification of the user that created the entity	Not Editable
createdAt	TimeCoordinates	The time when the entity was created, specifying when it was created in the real world and when it was recorded by the system.
author	Text	The identification of the users that made the latest change (version) of the entity.
asOf	TimeCoordinates	The time when the latest change was made (effective and recorded).

In addition, Invitations belong to a tenant, so they will also have:

Field Name	Type	Description	Notes
tenantId	UUID	The identification of the tenant that owns this entity.

Entities

Invitation

Field	Type	Default	Editable	Description
invitationDate	Date	Created at	No	Date invitation was created
expirationDate	Date	invitationDate + configurable interval	No	Expiry date
status	Enum	PENDING	No	Current lifecycle status
invitee	String	Blank	Yes	Email of invited user
inviterId	UUID	Current user id	No	ID of inviting user
tenantId	UUID	Current tenant id	No	Tenant being invited to

Invitation Lifecycle

The state diagram annotates those states and transitions that are triggered by the invitee or the system events. All other transitions (e.g. cancel, archive) are triggered by a user in the inviting tenant.

These operations (refresh, cancel, …) are implemented as update of the status field on the invitation entity, as dewxcibed by the transiotion diagram below.

Sequence Overview

1. Inviter creates invitations via the Organization Page.
2. System registers a PENDING invitation and returns an invitation URL.
3. Inviter shares the URL (email, message, QR code).
4. Invitee opens the URL, signs in or creates an account if needed.
5. System validates the invitation.
6. On accept:
   • invitation transitions to ACCEPTED.
   • a new AgentFor is created linking the invitee’s UserAccount to the tenant;
   • the invitee’s role in the tenant is set to USER;
   • invitee’s active tenant is set to the new tenant.
7. On reject:
   • invitation transitions to REJECTED.

Activities