Integrate
Platforms and tenant apps
A Platform app can create one isolated Tenant app per customer, each with its own users, key and callbacks.
A Platform app (a website builder, say) manages its tenants with the platform's own API key:
| Action | Call |
|---|---|
| Create a tenant | POST /v1/platform/tenants { parentAppId, name, homepageUrl, allowedCallbackUrls? } → { childAppId, apiKey }: the tenant's first key. Store it for that customer. |
| List tenants | GET /v1/platform/tenants?parentAppId=…&cursor=…&limit=10 → { items, nextCursor, hasMore } |
| Update details | PUT /v1/platform/tenants/{tenantAppId} { parentAppId, name, description, homepageUrl } |
| Add a callback | POST /v1/platform/tenants/{tenantAppId}/callbacks { url }, with the tenant's own key or the platform's |
| Session limit | PUT /v1/platform/tenants/{tenantAppId}/token-settings?parentAppId=… { maxActiveSessions }. When a user goes over it, their oldest sessions are signed out within seconds. |
| Delete | DELETE /v1/platform/tenants/{tenantAppId}?parentAppId=… |
Then sign users in to a tenant exactly as for any app, with the tenant's App ID and key.
Tenants can also be created by hand: open the Platform app in the dashboard and press Spawn Tenant.