DirectoryLinkResult
in package
implements
JsonSerializable
What linking did.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $certificatesRevoked : int
- $directoryExternalId : string
- $userId : string
- $wasAlreadyLinked : bool
- $webauthnCredentialsDeleted : int
Methods
- __construct() : mixed
- Constructs a DirectoryLinkResult.
- fromArray() : self
- Rebuilds a DirectoryLinkResult 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
$certificatesRevoked read-only
public
int
$certificatesRevoked
$directoryExternalId read-only
public
string
$directoryExternalId
$userId read-only
public
string
$userId
$wasAlreadyLinked read-only
public
bool
$wasAlreadyLinked
$webauthnCredentialsDeleted read-only
public
int
$webauthnCredentialsDeleted
Methods
__construct()
Constructs a DirectoryLinkResult.
public
__construct(int $certificatesRevoked, string $directoryExternalId, string $userId, bool $wasAlreadyLinked, int $webauthnCredentialsDeleted) : mixed
Parameters
- $certificatesRevoked : int
-
User-type certificates revoked. - $directoryExternalId : string
-
The entry's
entryUUIDorobjectGUIDas text: an identifier, not a secret. - $userId : string
-
The account that was linked.
- $wasAlreadyLinked : bool
-
truewhen the account was already linked to that very entry and the call only re-ran the revocations (an interrupted link completed). - $webauthnCredentialsDeleted : int
-
Passkeys and security keys deleted.
fromArray()
Rebuilds a DirectoryLinkResult 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.