Documentation

ClientAuthorizationUpdateRequest implements ArrayCopyable, Arrayable, Jsonable Uses ArrayTrait, JsonTrait

Request to Authlete's /api/client/authorization/update/{clientId} API.

The API updates attributes of all existing access tokens issued to a client application by an end-user.

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.
getScopes()  : array<string|int, string>
Get a new set of scopes assigned to existing access tokens.
getSubject()  : string
Get the subject (= unique identifier) of the end-user who has granted authorization to the client application.
setScopes()  : mixed
Set a new set of scopes assigned to existing access tokens.
setSubject()  : ClientAuthorizationUpdateRequest
Set the subject (= unique identifier) of the end-user who has granted authorization to the 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.

getScopes()

Get a new set of scopes assigned to existing access tokens.

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

A new set of scopes assiged to existing access tokens.

getSubject()

Get the subject (= unique identifier) of the end-user who has granted authorization to the client application.

public getSubject() : string
Return values
string —

The subject of the end-user.

setScopes()

Set a new set of scopes assigned to existing access tokens.

public setScopes([array<string|int, string> $scopes = null ]) : mixed
Parameters
$scopes : array<string|int, string> = null

A new set of scopes assiged to existing access tokens. If null is given, the scope set associated with existing access tokens will not be changed.

Return values
mixed —

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