Documentation

PushedAuthReqRequest implements ArrayCopyable, Arrayable, Jsonable Uses ArrayTrait, JsonTrait

Request to Authlete's /api/pushed_auth_req API.

The authorization server can implement a pushed authorization request endpoint which is defined in "OAuth 2.0 Pushed Authorization Requests" by using the Authlete API.

Tags
since
1.8

Interfaces, Classes and Traits

ArrayCopyable
Interface to declare instances can be converted into/from arrays.
Arrayable
Interface to declare that instances can be converted into an array.
Jsonable
Interface to declare that instances can be converted into JSON strings.

Table of Contents

copyFromArray()  : mixed
Copy the content of the given array into this object.
copyToArray()  : mixed
Copy the content of this object into the given array.
fromArray()  : static
Convert an array into an instance of this class.
fromJson()  : static
Convert a JSON string into an instance of this class.
getClientCertificate()  : string
Get the client certificate used in the TLS connection between the client application and the pushed authorization request endpoint.
getClientCertificatePath()  : array<string|int, string>
Get the client certificate path presented by the client during client authentication.
getClientId()  : string
Get the client ID extracted from the Authorization header of the request to the pushed authorization request endpoint.
getClientSecret()  : string
Get the client secret extracted from the Authorization header of the request to the pushed authorization request endpoint.
getParameters()  : string
Get request parameters that the pushed authorization request endpoint received from a client application.
setClientCertificate()  : PushedAuthReqRequest
Set the client certificate used in the TLS connection between the client application and the pushed authorization request endpoint.
setClientCertificatePath()  : PushedAuthReqRequest
Set the client certificate path presented by the client during client authentication.
setClientId()  : PushedAuthReqRequest
Set the client ID extracted from the Authorization header of the request to the pushed authorization request endpoint.
setClientSecret()  : PushedAuthReqRequest
Set the client secret extracted from the Authorization header of the request to the pushed authorization request endpoint.
setParameters()  : PushedAuthReqRequest
Set request parameters that the pushed authorization request endpoint received from a client application.
toArray()  : array<string|int, mixed>
Convert this object into an array.
toJson()  : string
Convert this object into a JSON string.

Methods

copyFromArray()

Copy the content of the given array into this object.

public copyFromArray(array<string|int, mixed> &$array) : mixed
Parameters
$array : array<string|int, mixed>
Return values
mixed —

copyToArray()

Copy the content of this object into the given array.

public copyToArray(array<string|int, mixed> &$array) : mixed
Parameters
$array : array<string|int, mixed>
Return values
mixed —

fromArray()

Convert an array into an instance of this class.

public static fromArray([array<string|int, mixed> $array = null ]) : static

This static function returns a new instance of this class. If $array is null, null is returned.

Parameters
$array : array<string|int, mixed> = null

An array

Return values
static —

An instance of this class.

fromJson()

Convert a JSON string into an instance of this class.

public static fromJson(string $json) : static

This static function returns a new instance of this class. If $json is null or the type of $json is not string, null is returned.

Parameters
$json : string

A JSON string.

Return values
static —

An instance of this class.

getClientCertificate()

Get the client certificate used in the TLS connection between the client application and the pushed authorization request endpoint.

public getClientCertificate() : string
Return values
string —

The client certificate.

getClientCertificatePath()

Get the client certificate path presented by the client during client authentication.

public getClientCertificatePath() : array<string|int, string>
Return values
array<string|int, string> —

Certificates in PEM format.

getClientId()

Get the client ID extracted from the Authorization header of the request to the pushed authorization request endpoint.

public getClientId() : string
Return values
string —

The client ID extracted from the Authorization header.

getClientSecret()

Get the client secret extracted from the Authorization header of the request to the pushed authorization request endpoint.

public getClientSecret() : string
Return values
string —

The client secret extracted from the Authorization header.

getParameters()

Get request parameters that the pushed authorization request endpoint received from a client application.

public getParameters() : string
Return values
string —

Request parameters in application/x-www-form-urlencoded format.

setClientCertificate()

Set the client certificate used in the TLS connection between the client application and the pushed authorization request endpoint.

public setClientCertificate(string $certificate) : PushedAuthReqRequest
Parameters
$certificate : string

The client certificate.

Return values
PushedAuthReqRequest —

$this object.

setClientCertificatePath()

Set the client certificate path presented by the client during client authentication.

public setClientCertificatePath([array<string|int, string> $path = null ]) : PushedAuthReqRequest
Parameters
$path : array<string|int, string> = null

Certificates in PEM format.

Return values
PushedAuthReqRequest —

$this object.

setClientId()

Set the client ID extracted from the Authorization header of the request to the pushed authorization request endpoint.

public setClientId(string $clientId) : PushedAuthReqRequest
Parameters
$clientId : string

The client ID extracted from the Authorization header.

Return values
PushedAuthReqRequest —

$this object.

setClientSecret()

Set the client secret extracted from the Authorization header of the request to the pushed authorization request endpoint.

public setClientSecret(string $clientSecret) : PushedAuthReqRequest
Parameters
$clientSecret : string

The client secret extracted from the Authorization header.

Return values
PushedAuthReqRequest —

$this object.

setParameters()

Set request parameters that the pushed authorization request endpoint received from a client application.

public setParameters(string $parameters) : PushedAuthReqRequest
Parameters
$parameters : string

Request parameters in application/x-www-form-urlencoded format.

Return values
PushedAuthReqRequest —

$this object.

toArray()

Convert this object into an array.

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —

An array.

toJson()

Convert this object into a JSON string.

public toJson(int $options) : string
Parameters
$options : int

Options passed to json_encode(). This parameter is optional and its default value is 0.

Return values
string —

A JSON string.

Search results