AXIAM PHP SDK

CaCertificatesApi extends ManagementSupport
in package

FinalYes

Organization CAs and the per-tenant signing CAs chained beneath them.

The ca_certificates namespace handle (CONTRACT.md §27.2), reached as $client->management()->caCertificates(). 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.
generate()  : GeneratedCaCertificate
`POST /api/v1/organizations/{org_id}/ca-certificates`
generateSigningCa()  : GeneratedCaCertificate
`POST /api/v1/organizations/{org_id}/tenants/{tenant_id}/signing-cas`
get()  : CaCertificate
`GET /api/v1/organizations/{org_id}/ca-certificates/{id}`
importCa()  : CaCertificate
`POST /api/v1/organizations/{org_id}/ca-certificates/import`
inOrg()  : static
A COPY of this handle scoped to `$orgId` (§27.4 rule 3).
listItems()  : Page<string|int, CaCertificate>
`GET /api/v1/organizations/{org_id}/ca-certificates`
listSigningCas()  : Page<string|int, CaCertificate>
`GET /api/v1/organizations/{org_id}/tenants/{tenant_id}/signing-cas`
migrateCustody()  : MigrateCustodyResponse
`POST /api/v1/organizations/{org_id}/ca-certificates/{id}/migrate-custody`
revoke()  : void
`POST /api/v1/organizations/{org_id}/ca-certificates/{id}/revoke`
setMtlsTrustAnchor()  : MtlsTrustAnchorResponse
`PUT /api/v1/organizations/{org_id}/ca-certificates/{id}/mtls-trust-anchor`
signSigningCaCsr()  : CaCertificate
`POST /api/v1/organizations/{org_id}/tenants/{tenant_id}/signing-cas/sign-csr`

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

generateSigningCa()

`POST /api/v1/organizations/{org_id}/tenants/{tenant_id}/signing-cas`

public generateSigningCa(string $tenantId, CreateIntermediateCaRequest $body) : GeneratedCaCertificate

POST /api/v1/organizations/{org_id}/tenants/{tenant_id}/signing-cas.

The response carries a ONE-TIME secret (private_key_pem): the server will not return it again, so a caller that does not persist it here cannot recover it (§27.5).

Parameters
$tenantId : string

the {tenant_id} path parameter

$body : CreateIntermediateCaRequest

the request body

Return values
GeneratedCaCertificate

get()

`GET /api/v1/organizations/{org_id}/ca-certificates/{id}`

public get(string $id) : CaCertificate

GET /api/v1/organizations/{org_id}/ca-certificates/{id}.

Parameters
$id : string

the {id} path parameter

Return values
CaCertificate

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/{org_id}/ca-certificates`

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

GET /api/v1/organizations/{org_id}/ca-certificates.

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, CaCertificate>

listSigningCas()

`GET /api/v1/organizations/{org_id}/tenants/{tenant_id}/signing-cas`

public listSigningCas(string $tenantId[, PageRequest|null $page = null ]) : Page<string|int, CaCertificate>

GET /api/v1/organizations/{org_id}/tenants/{tenant_id}/signing-cas.

Returns ONE page. Page::$total is the server's count across all pages and is not count($page) — see §27.4 rule 4.

Parameters
$tenantId : string

the {tenant_id} path parameter

$page : PageRequest|null = null

which page to fetch; defaults to the first

Return values
Page<string|int, CaCertificate>

migrateCustody()

`POST /api/v1/organizations/{org_id}/ca-certificates/{id}/migrate-custody`

public migrateCustody(string $id) : MigrateCustodyResponse

POST /api/v1/organizations/{org_id}/ca-certificates/{id}/migrate-custody.

Parameters
$id : string

the {id} path parameter

Return values
MigrateCustodyResponse

revoke()

`POST /api/v1/organizations/{org_id}/ca-certificates/{id}/revoke`

public revoke(string $id) : void

POST /api/v1/organizations/{org_id}/ca-certificates/{id}/revoke.

Returns nothing; the server answers with an empty body.

Parameters
$id : string

the {id} path parameter

On this page

Search results