AuthenticationError
extends APIError
in package
API error indicating that the supplied secret key was missing, invalid, or unauthorized.
Table of Contents
Properties
- $body : mixed
- Decoded or raw error response body.
- $cause : string|null
- Public cause description returned by the API.
- $code : mixed
- Machine-readable API error code, when present.
- $data : mixed
- Structured API error data.
- $detail : string|null
- Human-readable detail returned by the API.
- $fixCode : string|null
- Machine-readable remediation code, when the API supplies one.
- $report : ErrorReport|null
- Privacy-safe terminal failure report when application-owned reporting is enabled.
- $requestId : string|null
- Server request identifier used to correlate logs and support cases.
- $status : int
- HTTP response status.
- $type : string|null
- Broad machine-readable error type.
- $url : string|null
- Static request URL or route associated with the failure, when safe to expose.
Methods
- __construct() : mixed
- Creates a structured API response error.
Properties
$body
Decoded or raw error response body.
public
mixed
$body
@var mixed
$cause
Public cause description returned by the API.
public
string|null
$cause
$code
Machine-readable API error code, when present.
public
mixed
$code
@var string|int|null
$data
Structured API error data.
public
mixed
$data
@var mixed
$detail
Human-readable detail returned by the API.
public
string|null
$detail
$fixCode
Machine-readable remediation code, when the API supplies one.
public
string|null
$fixCode
$report
Privacy-safe terminal failure report when application-owned reporting is enabled.
public
ErrorReport|null
$report
= null
$requestId
Server request identifier used to correlate logs and support cases.
public
string|null
$requestId
$status
HTTP response status.
public
int
$status
$type
Broad machine-readable error type.
public
string|null
$type
$url
Static request URL or route associated with the failure, when safe to expose.
public
string|null
$url
Methods
__construct()
Creates a structured API response error.
public
__construct(string $message, int $status[, string|null $code = null ][, string|null $type = null ][, string|null $url = null ][, string|null $detail = null ][, string|null $fixCode = null ][, string|null $cause = null ][, mixed $body = null ][, mixed $data = null ][, string|null $requestId = null ]) : mixed
Parameters
- $message : string
-
Exception message.
- $status : int
-
HTTP response status.
- $code : string|null = null
-
Machine-readable API error code.
- $type : string|null = null
-
Broad error category.
- $url : string|null = null
-
Safe request URL or static route.
- $detail : string|null = null
-
Human-readable API detail.
- $fixCode : string|null = null
-
Machine-readable remediation code.
- $cause : string|null = null
-
Public cause description.
- $body : mixed = null
-
Decoded or raw error response body.
- $data : mixed = null
-
Structured API error data.
- $requestId : string|null = null
-
Server request identifier.