TenantsApi
extends ManagementSupport
in package
Tenants within an organization -- the isolation boundary every other namespace is scoped to.
The tenants namespace handle (CONTRACT.md §27.2), reached as
$client->management()->tenants(). Every method here goes through the one shared ManagementTransport, so §3 CSRF, the §4 cookie jar, the §5 tenant header, §6 TLS, §16 retry
and §19 telemetry apply without this class doing anything to opt in (§27.8).
Table of Contents
Methods
- __construct() : mixed
- create() : Tenant
- `POST /api/v1/organizations/{org_id}/tenants`
- delete() : void
- `DELETE /api/v1/organizations/{org_id}/tenants/{tenant_id}`
- exportAudit() : void
- `POST /api/v1/organizations/{org_id}/tenants/{tenant_id}/audit-export`
- forTenant() : static
- A COPY of this handle scoped to `$tenantId` (§27.4 rule 3). See {@see self::inOrg()} for why it copies.
- get() : Tenant
- `GET /api/v1/organizations/{org_id}/tenants/{tenant_id}`
- inOrg() : static
- A COPY of this handle scoped to `$orgId` (§27.4 rule 3).
- listItems() : Page<string|int, Tenant>
- `GET /api/v1/organizations/{org_id}/tenants`
- update() : Tenant
- `PUT /api/v1/organizations/{org_id}/tenants/{tenant_id}`
Methods
__construct()
public
__construct(ManagementTransport $transport[, NamespaceScope $scope = new NamespaceScope() ][, string|null $clientOrgId = null ][, string|null $clientTenantId = null ]) : mixed
Parameters
- $transport : ManagementTransport
-
The one wire path (§27.8).
- $scope : NamespaceScope = new NamespaceScope()
-
Per-handle
{org_id}/{tenant_id}overrides. - $clientOrgId : string|null = null
-
The client's own organization id, or
null. - $clientTenantId : string|null = null
-
The client's own tenant id, or
null.
create()
`POST /api/v1/organizations/{org_id}/tenants`
public
create(CreateTenantRequest $body) : Tenant
POST /api/v1/organizations/{org_id}/tenants.
Parameters
- $body : CreateTenantRequest
-
the request body
Return values
Tenantdelete()
`DELETE /api/v1/organizations/{org_id}/tenants/{tenant_id}`
public
delete(string $tenantId) : void
DELETE /api/v1/organizations/{org_id}/tenants/{tenant_id}.
Returns nothing; the server answers with an empty body.
NOT idempotent (§27.4 rule 6): deleting something already deleted raises NotFoundError rather than succeeding quietly.
Parameters
- $tenantId : string
-
the
{tenant_id}path parameter
exportAudit()
`POST /api/v1/organizations/{org_id}/tenants/{tenant_id}/audit-export`
public
exportAudit(string $tenantId) : void
POST /api/v1/organizations/{org_id}/tenants/{tenant_id}/audit-export.
Returns nothing; the server answers with an empty body.
Parameters
- $tenantId : string
-
the
{tenant_id}path parameter
forTenant()
A COPY of this handle scoped to `$tenantId` (§27.4 rule 3). See {@see self::inOrg()} for why it copies.
public
forTenant(string $tenantId) : static
Parameters
- $tenantId : string
Return values
staticget()
`GET /api/v1/organizations/{org_id}/tenants/{tenant_id}`
public
get(string $tenantId) : Tenant
GET /api/v1/organizations/{org_id}/tenants/{tenant_id}.
Parameters
- $tenantId : string
-
the
{tenant_id}path parameter
Return values
TenantinOrg()
A COPY of this handle scoped to `$orgId` (§27.4 rule 3).
public
inOrg(string $orgId) : static
Returns a new handle rather than mutating this one. An administrator holding a handle to their own organization should not find it repointed at someone else's because an unrelated code path re-scoped a shared object — and on a management surface that failure mode writes to the wrong tenant rather than merely reading from it.
Parameters
- $orgId : string
Return values
staticlistItems()
`GET /api/v1/organizations/{org_id}/tenants`
public
listItems([PageRequest|null $page = null ]) : Page<string|int, Tenant>
GET /api/v1/organizations/{org_id}/tenants.
Returns ONE page. Page::$total is the server's count across all pages and is not
count($page) — see §27.4 rule 4.
Parameters
- $page : PageRequest|null = null
-
which page to fetch; defaults to the first
Return values
Page<string|int, Tenant>update()
`PUT /api/v1/organizations/{org_id}/tenants/{tenant_id}`
public
update(string $tenantId, UpdateTenant $body) : Tenant
PUT /api/v1/organizations/{org_id}/tenants/{tenant_id}.
Parameters
- $tenantId : string
-
the
{tenant_id}path parameter - $body : UpdateTenant
-
the request body