PlatformTenant

Creating, suspending and restoring tenants, and appointing their administrators.

📄️Provision a tenant

Creates a tenant — an isolated customer workspace with its own data, configuration and users. Isolation is enforced in the database, so one tenant's records are invisible to another rather than merely filtered out. Requires `platform.tenant.create`.

📄️List tenants

Returns every tenant on the platform with its tier and status. This is a platform-level view, outside any single tenant. Requires `platform.tenant.read`.

📄️Get a tenant

Returns one tenant's configuration and status. Requires `platform.tenant.read`.

📄️Update a tenant

Changes a tenant's display name or tier. Requires `platform.tenant.update`.

📄️Delete a tenant

Soft-deletes a tenant. Its data is retained and the tenant can be restored. Requires `platform.tenant.delete`.

📄️Restore a deleted tenant

Reinstates a soft-deleted tenant with its data and configuration intact. Requires `platform.tenant.restore`.

📄️Suspend a tenant

Blocks access without deleting anything. Users are refused at sign-in; the data is untouched and returns when the tenant is reactivated. Requires `platform.tenant.update`.

📄️Reactivate a suspended tenant

Restores access to a suspended tenant. Its users can sign in again immediately. Requires `platform.tenant.update`.

📄️Get a tenant's statistics

Returns record counts and usage for one tenant. Requires `platform.tenant.read`.

📄️Get a tenant's audit trail

Returns platform-level actions taken against this tenant — provisioning, suspension, admin grants. Requires `platform.tenant.read`.

📄️Grant a tenant administrator

Gives a person, or everyone in an identity-provider group, administrator rights in the tenant. Supply exactly one of the two. This is the bootstrap step: until a tenant has an administrator, nobody can configure it. Requires `platform.tenant.admin.grant`.