AXIAM PHP SDK

CreateCertificateRequest
in package
implements JsonSerializable

FinalYes

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

Table of Contents

Interfaces

JsonSerializable

Properties

$certType  : CertificateType
$issuerCaId  : string
$keyAlgorithm  : KeyAlgorithm
$metadata  : mixed
$subject  : string
$subjectAltNames  : array<string|int, mixed>|null
$userId  : string|null
$validityDays  : int

Methods

__construct()  : mixed
Constructs a CreateCertificateRequest.
fromArray()  : self
Rebuilds a CreateCertificateRequest 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 CreateCertificateRequest.

public __construct(CertificateType $certType, string $issuerCaId, KeyAlgorithm $keyAlgorithm, string $subject, int $validityDays[, mixed $metadata = null ][, array<int, SubjectAltNameVariant>|null $subjectAltNames = null ][, string|null $userId = null ]) : mixed
Parameters
$certType : CertificateType

the server's cert_type field

$issuerCaId : string

the server's issuer_ca_id field

$keyAlgorithm : KeyAlgorithm

the server's key_algorithm field

$subject : string

The certificate's common name, e.g. device-001: a bare name or one CN= component, at most 64 characters (RFC 5280 ub-common-name), printable — a control character, tab or line break, an invisible or bidirectional formatting character, or two spaces in a row is refused with 400. A name that is to be written into another system's configuration (a FreeRADIUS table, an ACL) should match ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$.

$validityDays : int

Validity duration in days.

$metadata : mixed = null

the server's metadata field (optional)

$subjectAltNames : array<int, SubjectAltNameVariant>|null = null

The names a Server certificate is issued for, as [{"dns": "api.lakeside.internal"}, {"ip": "10.0.0.5"}]. Required for cert_type: Server and refused for every other type. Each name, and the common name, must be admitted by the tenant's effective server_cert_allowed_names, which is empty — refusing every Server request — until an organization administrator lists names. (optional)

$userId : string|null = null

The user account a User certificate is issued for (#533), returned as the certificate's user_id. Optional; accepted only for cert_type: User, and it must name a user of this tenant that has not been deleted or erased. A metadata.user_id in the same request must agree with it. Revoking the account's certificates — directory linking, deletion, erasure — matches on it. (optional)

fromArray()

Rebuilds a CreateCertificateRequest 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