UserInfo
in package
Result of `AxiamClient::getUserInfo()` (CONTRACT.md §1.1, contract 1.3).
A readonly DTO — the typed value object the gRPC-only get_user_info operation returns,
mirroring the shape of LoginResult (D-09: a typed record, never a raw
array/stdClass or the wire GetUserInfoResponse message leaking out of the SDK).
$sub, $tenantId, and $orgId are ALWAYS populated. $email is non-null only when the
access token carried the "email" scope, and $preferredUsername only with the "profile"
scope — the server gates these exactly as the REST /oauth2/userinfo endpoint does
(§1.1.5); an absent optional claim is surfaced here as null (never an empty string).
None of these fields is token-carrying, so — unlike LoginResult::$challengeToken — none is wrapped in Sensitive (§7 applies only to secret token material, which an identity claim set is not).
Table of Contents
Properties
- $email : string|null
- $orgId : string
- $preferredUsername : string|null
- $sub : string
- $tenantId : string
Methods
- __construct() : mixed
Properties
public
string|null
$email
= null
$orgId
public
string
$orgId
$preferredUsername
public
string|null
$preferredUsername
= null
$sub
public
string
$sub
$tenantId
public
string
$tenantId
Methods
__construct()
public
__construct(string $sub, string $tenantId, string $orgId[, string|null $email = null ][, string|null $preferredUsername = null ]) : mixed
Parameters
- $sub : string
- $tenantId : string
- $orgId : string
- $email : string|null = null
- $preferredUsername : string|null = null