Platform And Tenants
Explains platform tenant lists, tenant creation, tenant details, onboarding steps, and tenant API app management.
Workflow
- Tenant createPlatform admin: Creates a new company workspace and owner account.
- Tenant API appTenant admin / IT: Creates API credentials for integrations and device-style clients.
- Tenant onboarding statusAdmin / Success team: Tracks implementation steps such as domain, branding, master data, staff, and go-live.
| Stage | Actor | Action | Result |
|---|---|---|---|
| Tenant create | Platform admin | Creates a new company workspace and owner account. | The app validates the values, saves the record, and refreshes the relevant table or w. |
| Tenant API app | Tenant admin / IT | Creates API credentials for integrations and device-style clients. | The app validates the values, saves the record, and refreshes the relevant table or w. |
| Tenant onboarding status | Admin / Success team | Tracks implementation steps such as domain, branding, master data, staff, and go-live. | The app validates the values, saves the record, and refreshes the relevant table or w. |
Essential fields
Platform admin
Tenant create form
Creates a new company workspace and owner account.
| Essential field | Plain meaning | Example | Required / notes |
|---|---|---|---|
| Tenant name | Company or workspace name. | Lahore Retail |
Required. |
| Slug | Workspace identifier. | lahore-retail |
Used for domain/database naming. |
| Domain | Host users will visit. | lahore.attendpro.test |
Must resolve to the app. |
| Owner name/email | First tenant admin. | Owner / owner@company.com |
Required. |
| Owner password | Initial password or generated password. | Tenant@12345 |
Private. |
Essential fields
Tenant admin / IT
Tenant API app form
Creates API credentials for integrations and device-style clients.
| Essential field | Plain meaning | Example | Required / notes |
|---|---|---|---|
| App name | Friendly integration label. | Head Office Device Sync |
Required. |
| Allowed IPs | IP addresses allowed to use it. | 203.0.113.10 |
Optional but safer. |
| Scopes | What the app can access. | attendance:punches |
Use least access. |
| Rotate secret | Creates a replacement secret. | Rotate |
Old secret stops working. |
Essential fields
Admin / Success team
Tenant onboarding status form
Tracks implementation steps such as domain, branding, master data, staff, and go-live.
| Essential field | Plain meaning | Example | Required / notes |
|---|---|---|---|
| Status | Current progress. | todo / doing / done |
Keep honest for rollout tracking. |
| Notes | Implementation detail. | Waiting for shift list. |
Useful for handoff. |
Essential table
Database listing
Tenant listing table
Shows each workspace and its operational status.
Filters: Search, Status, Domain
| Column | What it means | Where it comes from | Example interpretation |
|---|---|---|---|
| Tenant | Workspace name and slug. | tenants table. | lahore-retail. |
| Domain | Login address. | domains table. | lahore.attendpro.test. |
| Owner | Primary admin contact. | tenant provisioning record. | owner@company.com. |
| Status | Provisioning or activity state. | tenant metadata. | Active means users can log in. |
| Status | Current workflow state for the row. | The record status field or computed workflow state. | Pending means someone still needs to act. |
| Created / Updated | When the row entered or last changed in the system. | Audit timestamps. | Recent updates usually explain why the list order changed. |
Available actions
- Open or edit the record when permission allows it.
- Filter the list without losing the current page context.
- Use status badges to decide which item needs attention first.
Full field appendix
Main docs show essential fields only. Open Documentation Coverage for every detected source field, action, column, route hint, controller hint, and test hint.