Tenants
Catalog id: platform.tenants
Platform operator surface for customer tenants: inventory, registration, lifecycle, and switching into a tenant context for product administration.
Guide with decisions and REST dual path: Onboard a tenant.
Open it
| Navigation | Platform > Tenants (operator landing after sign-in) |
| Deep link | Platform console root /admin-console |
| Scope | Platform |
What you can do
- See existing customer tenants and lifecycle status.
- Register a new tenant (wizard below).
- Open a tenant to work in tenant-scoped Resources and Protocols.
Register wizard
Register tenant collects durable identity, contacts, login policy, and provisioning capabilities, then starts async setup. Do not treat the wizard as a form dump: each step is a decision that is expensive to reverse after provision (especially slug and enabled protocols).
| Step | Decision |
|---|---|
| Tenant URL | Name and permanent slug / host label |
| People | Technical and administrative contacts; owner/admin person |
| Login | Whether the owner receives admin login delivery; AS and key store are always required |
| Capabilities | Issuer, verifier, keys/DIDs, sample data |
| Review | Confirm, then provision and watch setup complete |
Tenant URL
Slug is the durable host label. Prefer short, stable values.
People
Who receives operational mail and who owns the first admin account.
Login
Owner activation delivery. Default authorization server and key store stay mandatory.
Capabilities
Which protocol and resource defaults setup should create for this tenant.
Review
Last confirmation before anything is created.
Provisioning progress
Timeline until setup completes. Use Done when the list has refreshed.
REST
Platform origin and operator bearer token.
List
- Overview
- Request
- Response
List tenants
Endpoint: GET /api/platform/admin/v1/tenants
Captured response: 200 OK
This captured endpoint is shown from the E2E run; it is not mapped to one of the generated EDK REST API reference pages.
Connect an environment to rewrite this call to real service bases and run it.
Register
- Overview
- Request
- Response
Register tenant
Endpoint: POST /api/platform/admin/v1/tenants
Captured response: 201 Created
This captured endpoint is shown from the E2E run; it is not mapped to one of the generated EDK REST API reference pages.
Connect an environment to rewrite this call to real service bases and run it.
Onboarding status
- Overview
- Request
- Response
Get tenant onboarding status
Endpoint: GET /api/platform/admin/v1/tenant-onboarding/00000000-0000-4000-8000-000000000000
Captured response: 200 OK
This captured endpoint is shown from the E2E run; it is not mapped to one of the generated EDK REST API reference pages.
Connect an environment to rewrite this call to real service bases and run it.
Get tenant
- Overview
- Request
- Response
Get tenant
Endpoint: GET /api/platform/admin/v1/tenants/00000000-0000-4000-8000-000000000000
Captured response: 200 OK
This captured endpoint is shown from the E2E run; it is not mapped to one of the generated EDK REST API reference pages.
Connect an environment to rewrite this call to real service bases and run it.
Platform Admin API. Guide: Onboard a tenant.