Skip to content

UseTenantsReturn

Property Type Description
createTenant (options) => Promise<Tenant> Create a new tenant (instance admin only)
currentTenantId string | undefined Get the current tenant ID
deleteTenant (id) => Promise<void> Delete a tenant (instance admin only)
error Error | null Any error that occurred
isLoading boolean Whether tenants are being fetched
refetch () => Promise<void> Refetch tenants
setCurrentTenant (tenantId) => void Set the current tenant context
tenants TenantWithRole[] Array of tenants the user has access to
updateTenant (id, options) => Promise<Tenant> Update a tenant (tenant admin only)