AXIAM PHP SDK

OrganizationsApi extends ManagementSupport
in package

FinalYes

Organizations an SDK client may read and configure. Creation and deletion are outside the SDK boundary (§27.0).

The organizations namespace handle (CONTRACT.md §27.2), reached as $client->management()->organizations(). 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
forTenant()  : static
A COPY of this handle scoped to `$tenantId` (§27.4 rule 3). See {@see self::inOrg()} for why it copies.
get()  : Organization
`GET /api/v1/organizations/{org_id}`
inOrg()  : static
A COPY of this handle scoped to `$orgId` (§27.4 rule 3).
listItems()  : Page<string|int, Organization>
`GET /api/v1/organizations`
update()  : Organization
`PUT /api/v1/organizations/{org_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.

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
static

inOrg()

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
static

listItems()

`GET /api/v1/organizations`

public listItems([PageRequest|null $page = null ]) : Page<string|int, Organization>

GET /api/v1/organizations.

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, Organization>
On this page

Search results