Skip to main content

​
Get Tenant Status

Retrieve status information for a specific tenant. 
GET /api/v1/tenants/acme-corp/status

​
Path Parameters

​
id
string
required
Tenant identifier

​
Authorization

Requires Permissions.Multitenancy.View permission.

​
Response

​
id
string
Tenant identifier
​
name
string
Tenant display name
​
isActive
boolean
Whether the tenant is currently active
​
validUpto
datetime
Subscription expiration date
​
hasConnectionString
boolean
Whether tenant has a custom database connection
​
adminEmail
string
Administrator email address
​
issuer
string
JWT issuer for the tenant
{
  "id": "acme-corp",
  "name": "Acme Corporation",
  "isActive": true,
  "validUpto": "2026-06-30T23:59:59Z",
  "hasConnectionString": true,
  "adminEmail": "[email protected]",
  "issuer": "https://acme.example.com"
}

​
Change Tenant Activation

Activate or deactivate a tenant. 
POST /api/v1/tenants/acme-corp/activation
Content-Type: application/json

{
  "tenantId": "acme-corp",
  "isActive": false
}

​
Path Parameters

​
id
string
required
Tenant identifier (must match the tenantId in request body)

​
Request Body

​
tenantId
string
required
Tenant identifier (must match path parameter)
​
isActive
boolean
required
Set to true to activate, false to deactivate

​
Authorization

Requires Permissions.Multitenancy.Update permission.

​
Response

​
tenantId
string
The tenant identifier
​
isActive
boolean
New activation status
​
validUpto
datetime
Subscription validity date
​
message
string
Descriptive message about the status change
{
  "tenantId": "acme-corp",
  "isActive": false,
  "validUpto": "2026-06-30T23:59:59Z",
  "message": "Tenant has been deactivated successfully"
}
Deactivating a tenant will prevent all users from that tenant from accessing the system.

​
Upgrade Tenant Subscription

Extend or upgrade a tenant’s subscription. 
POST /api/v1/tenants/acme-corp/upgrade
Content-Type: application/json

{
  "tenant": "acme-corp",
  "extendedExpiryDate": "2027-12-31T23:59:59Z"
}

​
Path Parameters

​
id
string
required
Tenant identifier (must match the tenant in request body)

​
Request Body

​
tenant
string
required
Tenant identifier (must match path parameter)
​
extendedExpiryDate
datetime
required
New subscription expiration date (must be in the future)

​
Authorization

Requires Permissions.Multitenancy.Update permission.

​
Response

​
tenant
string
The tenant identifier
​
newValidity
datetime
Updated subscription expiration date
{
  "tenant": "acme-corp",
  "newValidity": "2027-12-31T23:59:59Z"
}

Build docs developers (and LLMs) love

Get started for freeTalk to us