GrantScopeConsent
in package
implements
JsonSerializable
Body for recording an OIDC scope-release consent.
Table of Contents
Interfaces
- JsonSerializable
Properties
Methods
- __construct() : mixed
- Constructs a GrantScopeConsent.
- fromArray() : self
- Rebuilds a GrantScopeConsent 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
$clientId read-only
public
string
$clientId
$scopes read-only
public
array<string|int, mixed>
$scopes
Methods
__construct()
Constructs a GrantScopeConsent.
public
__construct(string $clientId, array<int, string> $scopes) : mixed
Parameters
- $clientId : string
-
The relying party the claims would be released to.
- $scopes : array<int, string>
-
The sensitive scopes being consented to. Order does not matter; the record is written in the canonical order so that the same consent has one name.
fromArray()
Rebuilds a GrantScopeConsent 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.