AXIAM PHP SDK

GeneratedPgpKey
in package
implements JsonSerializable

FinalYes

Response returned when a PGP key is generated.

Table of Contents

Interfaces

JsonSerializable

Properties

$algorithm  : PgpKeyAlgorithm
$createdAt  : string
$fingerprint  : string
$id  : string
$name  : string
$privateKeyArmored  : Sensitive|null
$publicKeyArmored  : string
$purpose  : PgpKeyPurpose
$status  : PgpKeyStatus
$tenantId  : string

Methods

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

public __construct(PgpKeyAlgorithm $algorithm, string $createdAt, string $fingerprint, string $id, string $name, string $publicKeyArmored, PgpKeyPurpose $purpose, PgpKeyStatus $status, string $tenantId[, Sensitive|null $privateKeyArmored = null ]) : mixed
Parameters
$algorithm : PgpKeyAlgorithm

the server's algorithm field

$createdAt : string

the server's created_at field

$fingerprint : string

OpenPGP key fingerprint (hex).

$id : string

the server's id field

$name : string

the server's name field

$publicKeyArmored : string

the server's public_key_armored field

$purpose : PgpKeyPurpose

the server's purpose field

$status : PgpKeyStatus

the server's status field

$tenantId : string

the server's tenant_id field

$privateKeyArmored : Sensitive|null = null

ASCII-armored private key — returned only on generation for Export keys. For AuditSigning keys this is None (private key is server-side only). (optional)

fromArray()

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