GetTenants
Gets all direct child tenants, or with --all every tenant of the installation.
Examples
Direct child tenants of the current tenant:
octo-cli -c GetTenants
Every tenant of the installation (system tenant context only):
octo-cli -c GetTenants -a
Options
| Short | Long | Required | Description |
|---|---|---|---|
-a | --all | no | Return every tenant registered on the installation, including sub-tenants of nested parents and re-parented tenants. Only answered on the system tenant. |
-r | --recursive | no | Also list every deeper descendant (grandchildren and below), each entry carrying its parentTenantId. Without it, only DIRECT child tenants are returned — sub-tenant hierarchies stay invisible (AB#5151). Requires a service exposing tenants/descendants; an older service fails the call instead of silently returning only the children. |
Notes
Without --all only DIRECT children of the current tenant are returned (AB#5025). A tenant that hangs below another tenant — nested from the start or re-parented later — does NOT appear in the system tenant's plain list; enumerate the full installation with --all instead (AB#5151, AB#5129).
--all reads the platform-wide routing registry and is therefore only answered on the system tenant; any other tenant receives HTTP 403.