AuthorizationCodeSessionAuthenticateRequest
in package
implements
JsonSerializable
uses
JsonSerializableTrait
Read onlyYes
Table of Contents
Interfaces
- JsonSerializable
Properties
- $clientId : string
- The client ID of the application.
- $clientSecret : string
- The client secret of the application.
- $code : string
- The authorization code received from the redirect.
- $codeVerifier : string|null
- The PKCE code verifier used to derive the code challenge passed to the authorization URL.
- $deviceId : string|null
- A unique identifier for the device.
- $grantType : string
- $invitationToken : string|null
- An invitation token to accept during authentication.
- $ipAddress : string|null
- The IP address of the user's request.
- $userAgent : string|null
- The user agent string from the user's browser.
Methods
- __construct() : mixed
- fromArray() : self
- jsonSerialize() : array<string|int, mixed>
- toArray() : array<string|int, mixed>
Properties
$clientId
The client ID of the application.
public
string
$clientId
$clientSecret
The client secret of the application.
public
string
$clientSecret
$code
The authorization code received from the redirect.
public
string
$code
$codeVerifier
The PKCE code verifier used to derive the code challenge passed to the authorization URL.
public
string|null
$codeVerifier
= null
$deviceId
A unique identifier for the device.
public
string|null
$deviceId
= null
$grantType
public
string
$grantType
$invitationToken
An invitation token to accept during authentication.
public
string|null
$invitationToken
= null
$ipAddress
The IP address of the user's request.
public
string|null
$ipAddress
= null
$userAgent
The user agent string from the user's browser.
public
string|null
$userAgent
= null
Methods
__construct()
public
__construct(string $clientId, string $clientSecret, string $grantType, string $code[, string|null $codeVerifier = null ][, string|null $invitationToken = null ][, string|null $ipAddress = null ][, string|null $deviceId = null ][, string|null $userAgent = null ]) : mixed
Parameters
- $clientId : string
- $clientSecret : string
- $grantType : string
- $code : string
- $codeVerifier : string|null = null
- $invitationToken : string|null = null
- $ipAddress : string|null = null
- $deviceId : string|null = null
- $userAgent : string|null = null
fromArray()
public
static fromArray(array<string|int, mixed> $data) : self
Parameters
- $data : array<string|int, mixed>
Return values
selfjsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>toArray()
public
toArray() : array<string|int, mixed>