RegistrationTokenResponse
in package
implements
JsonSerializable
Metadata only. The handle exists in plaintext exactly once, in [`CreateRegistrationTokenResponse`].
Table of Contents
Interfaces
- JsonSerializable
Properties
- $createdAt : string
- $createdBy : string
- $expiresAt : string
- $id : string
- $name : string
- $tenantId : string
- $usedAt : string|null
- $usedByClientId : string|null
Methods
- __construct() : mixed
- Constructs a RegistrationTokenResponse.
- fromArray() : self
- Rebuilds a RegistrationTokenResponse 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
$createdAt read-only
public
string
$createdAt
$createdBy read-only
public
string
$createdBy
$expiresAt read-only
public
string
$expiresAt
$id read-only
public
string
$id
$name read-only
public
string
$name
$tenantId read-only
public
string
$tenantId
$usedAt read-only
public
string|null
$usedAt
= null
$usedByClientId read-only
public
string|null
$usedByClientId
= null
Methods
__construct()
Constructs a RegistrationTokenResponse.
public
__construct(string $createdAt, string $createdBy, string $expiresAt, string $id, string $name, string $tenantId[, string|null $usedAt = null ][, string|null $usedByClientId = null ]) : mixed
Parameters
- $createdAt : string
-
Row creation time.
- $createdBy : string
-
The administrator who minted it.
- $expiresAt : string
-
When it stops being usable.
- $id : string
-
Row identity.
- $name : string
-
The operator-facing label.
- $tenantId : string
-
The tenant a registration on this token lands in.
- $usedAt : string|null = null
-
When it was spent, if it was. (optional)
- $usedByClientId : string|null = null
-
Reserved; always absent in this build. See
axiam_core::models::oauth2_registration_token::OAuth2RegistrationToken::used_by_client_id— the registration a token produced is recorded in the audit log, not here. (optional)
fromArray()
Rebuilds a RegistrationTokenResponse 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.