[API-Domeinen]

Tenant Domain

The Tenant domain provides organizational tenant lifecycle management, enabling platform administrators to create, configure, and manage tenant organizations. It includes status management, quota enforcement, usage monit

Modulemetadata

The Tenant domain provides organizational tenant lifecycle management, enabling platform administrators to create, configure, and manage tenant organizations. It includes status management, quota enforcement, usage monit

Terug naar Lijst

Bronverwijzing

content/modules/domain-tenant.md

Laatst bijgewerkt

5 feb 2026

Categorie

API-Domeinen

Inhoudschecksum

c30d4d03fbe78074

Tags

api-domainscompliance

Gerenderde documentatie

Deze pagina rendert de Markdown en Mermaid van de module direct vanuit de publieke documentatiebron.

Overview#

The Tenant domain provides organizational tenant lifecycle management, enabling platform administrators to create, configure, and manage tenant organizations. It includes status management, quota enforcement, usage monitoring, health checks, feature flag configuration, and backup and restore capabilities.

Key Features#

  • Tenant Lifecycle Management - Manage tenants through a structured lifecycle from creation through activation, suspension, archival, and deletion, with controlled state transitions at each stage.

  • Quota Management - Define and enforce usage quotas for each tenant including storage limits, user counts, and feature usage thresholds to ensure fair resource distribution.

  • Usage Monitoring - Track tenant resource consumption in real time to provide visibility into how each organization uses the platform and when they approach quota limits.

  • Health Monitoring - Continuously assess tenant operational health to proactively identify issues and ensure consistent service delivery across all organizations.

  • Feature Flag Configuration - Control which platform features are available to each tenant, supporting customized capability sets and phased feature rollouts.

  • Backup and Restore - Create tenant data backups and restore from backup when needed, providing data protection and disaster recovery capabilities.

  • Audit Logging - Record all tenant management actions for compliance tracking and administrative review, maintaining a complete history of configuration changes.

Tenant Lifecycle States#

StatusDescription
CreatedInitial state after registration
ActiveFully operational tenant
SuspendedTemporarily disabled (billing, policy)
ArchivedData preserved, access removed

Use Cases#

  • Organization Onboarding - Create and configure new tenant organizations with appropriate quotas, feature flags, and initial settings for rapid deployment.

  • Capacity Management - Monitor usage across tenants and adjust quotas to optimize resource allocation and prevent service degradation.

  • Feature Customization - Enable or disable specific features per tenant to match contractual agreements, operational requirements, or phased rollout plans.

  • Compliance Management - Use audit logs and lifecycle controls to demonstrate proper tenant management practices for regulatory compliance.

Integration#

The Tenant domain provides foundational organization management across the platform:

  • User Management - Users are associated with their organizational tenant
  • Feature Management - Feature availability is controlled at the tenant level
  • Systems Integrator - Tenants are linked to their systems integrator partnerships
  • Audit and Compliance - Tenant management actions feed into compliance reporting

Last Reviewed: 2026-02-05