LoginResult
in package
Read onlyYes
FinalYes
Result of `AxiamClient::login()` (CONTRACT.md §1, D-09).
A readonly DTO — never thrown as an exception. Callers MUST check
self::$mfaRequired before assuming a fully-authenticated session was
established: when true, $challengeToken carries the opaque MFA challenge token
to pass to verifyMfa(); when false, $userId/$tenantId describe the
authenticated principal and $challengeToken is null.
Any token-carrying field MUST be typed Sensitive (CONTRACT.md §7 blanket
rule, mirrors the Java SDK's 20-03 challengeToken decision) — no raw token string
is ever exposed as a plain public property.
Table of Contents
Properties
- $challengeToken : Sensitive|null
- $mfaRequired : bool
- $tenantId : string|null
- $userId : string|null
Methods
- __construct() : mixed
Properties
$challengeToken
public
Sensitive|null
$challengeToken
= null
$mfaRequired
public
bool
$mfaRequired
$tenantId
public
string|null
$tenantId
= null
$userId
public
string|null
$userId
= null
Methods
__construct()
public
__construct(bool $mfaRequired[, Sensitive|null $challengeToken = null ][, string|null $userId = null ][, string|null $tenantId = null ]) : mixed
Parameters
- $mfaRequired : bool
- $challengeToken : Sensitive|null = null
- $userId : string|null = null
- $tenantId : string|null = null