Theme
Landlord Portal Module User Guide (Non-Technical)
This guide explains how platform owners manage all school tenants from the landlord portal.
Who should use this
- SaaS platform owner
- Super admin of the platform (not school-level admin)
- Central operations team managing tenants
Landlord portal scope
Landlord portal is separate from school admin panels.
Main sections:
- Landlord Login
- Dashboard
- Tenant Management (list, create, edit, view, status toggle, delete)
1) Landlord login
Path: /landlord/login
- Enter landlord email.
- Enter password.
- Optional: remember me.
- Click Log in.
On success, you are redirected to landlord dashboard.
2) Dashboard overview
Dashboard provides quick tenant metrics:
- total tenants
- active tenants
- inactive tenants
It also shows a recent tenant table with quick view access.
3) Open tenant management
Path: Landlord -> Tenants
You can:
- search by name/subdomain/custom domain
- filter by status (all/active/inactive)
- open tenant details
- edit tenant
- activate/deactivate tenant
- delete tenant
4) Create a new tenant
Path: Tenants -> Create Tenant
Required fields:
- School name
- Subdomain
- Timezone
- Currency
- Active status
Optional field:
- custom domain
Subdomain rules:
- lowercase letters, numbers, hyphens only
- must be unique
Click Create Tenant to save.
5) Edit tenant
Path: Tenants -> Edit
You can update:
- school name
- subdomain
- custom domain
- timezone
- currency
- active status
Click Update Tenant to save changes.
6) View tenant details
Path: Tenants -> View
Details page shows:
- tenant status
- subdomain/custom domain
- timezone and currency
- created and updated dates
- total users and active users in that tenant
7) Activate/deactivate tenant
From tenant list, use status toggle action.
Effects:
- Active: tenant is operational
- Inactive: tenant access is disabled/suspended
Use with caution to avoid service interruption for schools.
8) Delete tenant
From tenant list, use delete action and confirm.
Warning:
- deleting tenant is destructive and should only be done when policy allows permanent removal
Best practice: prefer deactivation first, deletion only when absolutely necessary.
Landlord navigation tips
- Dashboard: health and summary view
- Tenants: operational management
- User menu: logout
Common issues and quick fixes
- Login failed: verify landlord credentials and correct landlord login URL.
- Subdomain validation error: use only lowercase letters, numbers, and hyphens.
- Duplicate domain/subdomain: choose a unique value.
- Tenant cannot be accessed by school: verify tenant is active.
- Accidental status change: toggle tenant status again from tenant list.
If users do not see latest UI updates, ask technical support to run frontend build/dev commands (npm run build or npm run dev).