Skip to Content
🎉 New release with new features and improvements! V0.0.5 Release →

Manage Tenants

For detailed request and response formats, refer to the Tenants API Documentation.

Tenants List

Tenants List

Create new Tenant

To create a new tenant, you can use the create tenant form:

Create Tenant

PropertyTypeRequiredDescription
Tenant NamestringyesThe name of the tenant.
Tenant IDstringnoThe ID of the tenant.

Update Tenant

The update tenant form allows you to update a tenant’s information.

Update Tenant

Tenant Status

The tenant status is used to determine if the tenant is active or not.

Tenant Status

StatusDescription
ActiveThe tenant is active and can be used.
InactiveThe tenant is inactive and cannot be used.
BlockedThe 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.