TenantController
| Permissions |
|---|
| 10207 |
get/tenants
Query parameters
Response
Array of Tenant model instances
deletedboolean
deletedOnstring date-time nullable
deletedBystring nullable
createdOnstring date-time
modifiedOnstring date-time
createdBystring
modifiedBystring
idstring
namestring required
name of the tenant
status0 | 1 | 2 | 3 | 4 | 5 required
status of a tenant, it can be - 0(active), 1(provisioning),2(deprovisioning),3(inactive)
keystring required
a short string used to identify a tenant. This is also used as the namespace and subdomain for this particular tenant
spocUserIdstring
user id of the admin user who acts as a spoc for this tenant.
domainsstring[] required
leadIdstring
id of the lead from which this tenant was generated. this is optional as a tenant can be created without this lead.
addressIdstring
id of the address of the tenant
{"stackTrail":"components:schemas:TenantWithRelations:properties:foreignKey","oasType":"schema","type":"unknown"}