Documentation

DeviceAuthorizationRequest implements ArrayCopyable, Arrayable, Jsonable Uses ArrayTrait, JsonTrait

Request to Authlete's /api/device/authorization API.

When the implementation of the device authorization endpoint of the authorization server receives a device authorization request from a client application, the first step is to call Authlete's /api/device/authorization API. The API will parse the device authorization request on behalf of the implementation of the device authorization endpoint.

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 device authorization endpoint of the authorization server.
getClientCertificatePath()  : array<string|int, string>
Get the certificate path presented by the client during client authentication.
getClientId()  : string
Get the client ID extracted from the `Authorization` header of the device authorization request from a client application.
getClientSecret()  : string
Get the client secret extracted from the `Authorization` header of the device authorization request from a client application.
getParameters()  : string
Get the value of `parameters` which is the request parameters that the device authorization endpoint of the authorization server implementation received from a client application.
setClientCertificate()  : DeviceAuthorizationRequest
Set the client certificate used in the TLS connection between the client application and the device authorization endpoint of the authorization server.
setClientCertificatePath()  : DeviceAuthorizationRequest
Set the certificate path presented by the client during client authentication.
setClientId()  : DeviceAuthorizationRequest
Set the client ID extracted from the `Authorization` header of the device authorization request from a client application.
setClientSecret()  : DeviceAuthorizationRequest
Set the client secret extracted from the `Authorization` header of the device authorization request from a client application.
setParameters()  : DeviceAuthorizationRequest
Set the value of `parameters` which is the request parameters that the device authorization endpoint of the authorization server implementation 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 device authorization endpoint of the authorization server.

public getClientCertificate() : string
Return values
string —

The client certificate.

getClientCertificatePath()

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

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

The client certificate path. Each element is a string in PEM format.

getClientId()

Get the client ID extracted from the `Authorization` header of the device authorization request from a client application.

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 device authorization request from a client application.

public getClientSecret() : string
Return values
string —

The client secret extracted from the Authorization header.

getParameters()

Get the value of `parameters` which is the request parameters that the device authorization endpoint of the authorization server implementation received from a client application.

public getParameters() : string
Return values
string —

The request parameters of a device authorization request in application/x-www-form-urlencoded format.

setClientCertificatePath()

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

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

The client certificate path. Each element is a string in PEM format.

Return values
DeviceAuthorizationRequest —

$this object.

setClientSecret()

Set the client secret extracted from the `Authorization` header of the device authorization request from a client application.

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

The client secret extracted from the Authorization header.

Return values
DeviceAuthorizationRequest —

$this object.

setParameters()

Set the value of `parameters` which is the request parameters that the device authorization endpoint of the authorization server implementation received from a client application.

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

The request parameters of a device authorization request in application/x-www-form-urlencoded format.

Return values
DeviceAuthorizationRequest —

$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