tenant Struct Reference

A tenant representing an isolated organisation or the system platform. More...

#include <tenant.hpp>

Collaboration diagram for tenant:

Public Attributes
int	version = 0
	Version number for optimistic locking and change tracking.
boost::uuids::uuid	id
	UUID uniquely identifying this tenant.
std::string	code
	Unique code for stable referencing.
std::string	name
	Human-readable name for the tenant.
std::string	type
	Tenant type classification (FK to tenant_types).
std::string	description
	Detailed description of the tenant.
std::string	hostname
	Unique hostname for tenant routing.
std::string	status
	Tenant lifecycle status (FK to tenant_statuses).
std::string	modified_by
	Username of the person who last modified this tenant.
std::string	change_reason_code
	Code identifying the reason for the change.
std::string	change_commentary
	Free-text commentary explaining the change.
std::string	performed_by
	Username of the account that performed this operation.
std::chrono::system_clock::time_point	recorded_at
	Timestamp when this version of the record was recorded.

Detailed Description

A tenant representing an isolated organisation or the system platform.

Core entity for multi-tenancy support. Each tenant represents an isolated organisation with its own users, roles, and data. The system tenant (max UUID, ffffffff-ffff-ffff-ffff-ffffffffffff) is a special tenant used for shared reference data and system administration.

Tenants are identified by:

• id: UUID primary key (SQL also has tenant_id = id for self-reference)
• code: Unique text code for stable referencing (e.g., 'system', 'acme')
• hostname: Unique hostname for tenant routing during login

Member Data Documentation

id

boost::uuids::uuid id

UUID uniquely identifying this tenant.

The system tenant has UUID ffffffff-ffff-ffff-ffff-ffffffffffff (max UUID). In SQL, tenant_id = id for tenant records.

code

std::string code

Unique code for stable referencing.

Examples: 'system', 'acme', 'demo'.

change_reason_code

std::string change_reason_code

Code identifying the reason for the change.

References change_reasons table (soft FK).