CreateCaCertificateRequest
in package
implements
JsonSerializable
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.
Properties
$intermediateSubject read-only
public
string|null
$intermediateSubject
= null
$intermediateValidityDays read-only
public
int|null
$intermediateValidityDays
= null
$issueFromRoot read-only
public
bool|null
$issueFromRoot
= null
$keyAlgorithm read-only
public
KeyAlgorithm
$keyAlgorithm
$subject read-only
public
string
$subject
$validityDays read-only
public
int
$validityDays
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_algorithmfield - $subject : string
-
the server's
subjectfield - $validityDays : int
-
Validity duration in days.
- $intermediateSubject : string|null = null
-
Common name for the signing intermediate —
vault_pkicustody only. Under that custodian Vault generates a root and an intermediate beneath it, and this names the second. Defaults to the root's subject withIntermediate Authorityappended. 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_pkicustody 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
selfjsonSerialize()
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).
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.