AXIAM PHP SDK

CreateCaCertificateRequest
in package
implements JsonSerializable

FinalYes

The `CreateCaCertificateRequest` schema from the server's OpenAPI document.

Table of Contents

Interfaces

JsonSerializable

Properties

$intermediateSubject  : string|null
$intermediateValidityDays  : int|null
$issueFromRoot  : bool|null
$keyAlgorithm  : KeyAlgorithm
$subject  : string
$validityDays  : int

Methods

__construct()  : mixed
Constructs a CreateCaCertificateRequest.
fromArray()  : self
Rebuilds a CreateCaCertificateRequest from one decoded JSON object.
jsonSerialize()  : array<string, mixed>
Renders this object for `json_encode()`.
toArray()  : array<string, mixed>
Renders this object back to its wire form.
unknownEnumValue()  : string|null
The string the server sent for an open-enum member this SDK has no name for, or `null`.

Properties

Methods

__construct()

Constructs a CreateCaCertificateRequest.

public __construct(KeyAlgorithm $keyAlgorithm, string $subject, int $validityDays[, string|null $intermediateSubject = null ][, int|null $intermediateValidityDays = null ][, bool|null $issueFromRoot = null ]) : mixed
Parameters
$keyAlgorithm : KeyAlgorithm

the server's key_algorithm field

$subject : string

The CA's common name, e.g. ACME Corp Root CA. A common name, not a distinguished name. A single CN= prefix is accepted and stripped; anything else containing = — O=Acme, CN=ACME Corp Root CA — is refused with 400, as is a name of more than 64 characters (RFC 5280 ub-common-name) or one holding a control character, a tab or line break, an invisible or bidirectional formatting character, or two spaces in a row.

$validityDays : int

Validity duration in days.

$intermediateSubject : string|null = null

Common name for the signing intermediate — vault_pki custody only. Under that custodian Vault generates a root and an intermediate beneath it, and this names the second. Defaults to the root's subject with Intermediate Authority appended. Ignored by every other custodian, which produces one self-signed CA and has no second certificate to name. (optional)

$intermediateValidityDays : int|null = null

Validity of the signing intermediate, in days. Defaults to the root's. (optional)

$issueFromRoot : bool|null = null

Issue leaves straight from the generated root instead of creating an intermediate. vault_pki custody only, and off by default. The default is the safer one: a root that signs only an intermediate can have that intermediate revoked and replaced without redistributing the trust anchor, and a root that signs leaves cannot. (optional)

fromArray()

Rebuilds a CreateCaCertificateRequest from one decoded JSON object.

public static fromArray(array<string, mixed> $data) : self
Parameters
$data : array<string, mixed>

The raw wire object.

Return values
self

jsonSerialize()

Renders this object for `json_encode()`.

public jsonSerialize() : array<string, mixed>

Any Sensitive it carries stays WRAPPED here, so a log line or a json_encode($model) in application code prints [SENSITIVE]. The one place a secret is revealed is ManagementTransport, on the way to the wire and nowhere else (§27.5).

Rendering for a log line never fails: an unknown union arm renders its discriminator and an unrecognised enum value its empty Unknown spelling here, and only self::toArray() -- the request path -- refuses to send it (CONTRACT.md §31.2, §34.2 P12.2).

Return values
array<string, mixed>

toArray()

Renders this object back to its wire form.

public toArray() : array<string, mixed>

§27.4 rule 5: a null property is OMITTED, not emitted as null. On a sparse update those two say opposite things — "leave this alone" versus "set this to nothing" — and only omission means the first.

Return values
array<string, mixed>

unknownEnumValue()

The string the server sent for an open-enum member this SDK has no name for, or `null`.

public unknownEnumValue(string $wire) : string|null

Only a model decoded by self::fromArray() knows it, and only for a member that decoded to Unknown (CONTRACT.md §27.6.2 item 4, §34.8 (c)): it lets a refusal name the value. It is for messages -- it is never rendered by self::toArray() or self::jsonSerialize() and so is never sent.

Parameters
$wire : string

The member's wire name.

Return values
string|null
On this page

Search results