TokenExchangeTrustRequest
in package
implements
JsonSerializable
X4 trust for exchanging this provider's tokens (RFC 8693, external issuer). Mirrors [`TokenExchangeTrust`] on the wire rather than reusing it directly so the API surface can carry its own defaults: an admin PUTting a partial block gets the documented default for anything they omitted, instead of a deserialization error listing fields they have never heard of.
Every property is optional, so this is a SPARSE body: what you leave unset is left unchanged, and is omitted from the wire request entirely rather than sent as null (§27.4 rule 5).
Table of Contents
Interfaces
- JsonSerializable
Properties
- $acceptedAudiences : array<string|int, mixed>|null
- $enabled : bool|null
- $maxLifetimeSecs : int|null
- $maxTokenAgeSecs : int|null
- $scopeMap : array<string|int, mixed>|null
- $subjectMapping : string|null
Methods
- __construct() : mixed
- Constructs a TokenExchangeTrustRequest.
- fromArray() : self
- Rebuilds a TokenExchangeTrustRequest 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
$acceptedAudiences read-only
public
array<string|int, mixed>|null
$acceptedAudiences
= null
$enabled read-only
public
bool|null
$enabled
= null
$maxLifetimeSecs read-only
public
int|null
$maxLifetimeSecs
= null
$maxTokenAgeSecs read-only
public
int|null
$maxTokenAgeSecs
= null
$scopeMap read-only
public
array<string|int, mixed>|null
$scopeMap
= null
$subjectMapping read-only
public
string|null
$subjectMapping
= null
Methods
__construct()
Constructs a TokenExchangeTrustRequest.
public
__construct([array<int, string>|null $acceptedAudiences = null ][, bool|null $enabled = null ][, int|null $maxLifetimeSecs = null ][, int|null $maxTokenAgeSecs = null ][, array<string, mixed>|null $scopeMap = null ][, string|null $subjectMapping = null ]) : mixed
Parameters
- $acceptedAudiences : array<int, string>|null = null
-
Audiences an incoming subject token may name. Required (non-empty) when
enabled; there is deliberately no accept-all value. (optional) - $enabled : bool|null = null
-
Off unless explicitly enabled. Configuring a provider for login* is not agreement to accept its tokens as API credentials. (optional)
- $maxLifetimeSecs : int|null = null
-
Per-provider ceiling on the issued AXIAM token's lifetime. (optional)
- $maxTokenAgeSecs : int|null = null
-
Bound on
now - iat, independent of the token's ownexp. (optional) - $scopeMap : array<string, mixed>|null = null
-
External asserted value -> AXIAM scopes. Deny-by-default: an external value with no entry contributes nothing. (optional)
- $subjectMapping : string|null = null
-
linked_only(default) orjit_provision. (optional)
fromArray()
Rebuilds a TokenExchangeTrustRequest 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.