Manage Tenants
For detailed request and response formats, refer to the Tenants API Documentation.
Tenants List
Create new Tenant
To create a new tenant, you can use the create tenant form:
| Property | Type | Required | Description |
|---|---|---|---|
| Tenant Name | string | yes | The name of the tenant. |
| Tenant ID | string | no | The ID of the tenant. |
Update Tenant
The update tenant form allows you to update a tenant’s information.
Tenant Status
The tenant status is used to determine if the tenant is active or not.
| Status | Description |
|---|---|
| Active | The tenant is active and can be used. |
| Inactive | The tenant is inactive and cannot be used. |
| Blocked | The tenant is blocked and cannot be used. |
When a tenant is blocked or inactive, all users associated with the tenant will be logged out and will not be able to access the application.
Tenant context (X-Tenant-Id)
Multi-tenant requests can include an optional header:
X-Tenant-Id: {{tenantId}}| Caller | Behavior |
|---|---|
| Standard users | Always scoped to their own tenant. If X-Tenant-Id does not match their tenant, the request is denied. |
BSH_ADMIN | May send X-Tenant-Id to operate in a specific tenant, or omit it for unscoped admin operations. |
In the SDK, use tenantFn or withTenant() to attach this header. See Configuration and Tenants service.
Tenant records are not manageable through /api/entities/BshTenants; use the Tenants API.
