SetVerificationError
extends AuthError
in package
FinalYes
A Security Event Token refused by {@see SsfReceiver::verifySet()} (CONTRACT.md §32.7) — an {@see AuthError}, as §32.7 requires, carrying the step that failed as a typed {@see SetFailureReason}. {@see AuthError::getReason()} returns the same code as a string.
The message names the rule, never a claim value or the token.
Table of Contents
Properties
Methods
- __construct() : mixed
- getReason() : string|null
- A stable, machine-readable failure code, when this `AuthError` was raised for one of the §12.4 ID-token validation rules. `null` for every other `AuthError` in this SDK (wrong credentials, expired session, MFA failure, 401 on refresh, …).
Properties
$failureReason read-only
public
SetFailureReason
$failureReason
Methods
__construct()
public
__construct(SetFailureReason $failureReason, string $detail) : mixed
Parameters
- $failureReason : SetFailureReason
-
Which verification step refused the SET.
- $detail : string
-
A fixed description of the rule that failed.
getReason()
A stable, machine-readable failure code, when this `AuthError` was raised for one of the §12.4 ID-token validation rules. `null` for every other `AuthError` in this SDK (wrong credentials, expired session, MFA failure, 401 on refresh, …).
public
getReason() : string|null