DeviceAuthorizationAction Uses EnumTrait
The value of "action" in responses from Authlete's /api/device/authorization API.
Tags
Table of Contents
- $BAD_REQUEST : DeviceAuthorizationAction
- The device authorization request is invalid. The authorization server implementation should return an error response with `400 Bad Request` and `application/json` to the client application.
- $INTERNAL_SERVER_ERROR : DeviceAuthorizationAction
- The API call from the authorization server implementation was wrong or an error occurred on Authlete side. The authorization server implementation should return response with `500 Internal Server Error` and `application/json` to the client application.
- $OK : DeviceAuthorizationAction
- The device authorization request is valid. The authorization server implementation should return a successful response with `200 OK` and `application/json` to the client application.
- $UNAUTHORIZED : DeviceAuthorizationAction
- Client authentication of the device authorization request failed.
- __toString() : string
- Get the name of this instance.
- name() : string
- Get the name of this instance.
- valueOf() : static
- Get an instance of this class that the given argument represents.
- values() : array<string|int, mixed>
- Get the list of public class variables listed in this class.
Properties
$BAD_REQUEST
The device authorization request is invalid. The authorization server implementation should return an error response with `400 Bad Request` and `application/json` to the client application.
public
static DeviceAuthorizationAction
$BAD_REQUEST
Tags
$INTERNAL_SERVER_ERROR
The API call from the authorization server implementation was wrong or an error occurred on Authlete side. The authorization server implementation should return response with `500 Internal Server Error` and `application/json` to the client application.
public
static DeviceAuthorizationAction
$INTERNAL_SERVER_ERROR
Tags
$OK
The device authorization request is valid. The authorization server implementation should return a successful response with `200 OK` and `application/json` to the client application.
public
static DeviceAuthorizationAction
$OK
Tags
$UNAUTHORIZED
Client authentication of the device authorization request failed.
public
static DeviceAuthorizationAction
$UNAUTHORIZED
The authorization server implementation should return an error response
with 401 Unauthorized and application/json to the client application.
Tags
Methods
__toString()
Get the name of this instance.
public
__toString() : string
Return values
string —The name of this instance.
name()
Get the name of this instance.
public
name() : string
Return values
string —The name of this instance.
valueOf()
Get an instance of this class that the given argument represents.
public
static valueOf(mixed $value) : static
If the given argument is an instance of this class, the instance itself is returned.
Otherwise, if the given argument is null, null is returned.
Otherwise, if the type of the given argument is not string,
an InvalidArgumentException is returned.
Otherwise, a class variable whose name is equal to the given
argument is looked up. If found, the instance is returned.
If not found, an InvalidArgumentException is thrown.
Parameters
- $value : mixed
-
A string that represents an instance of this class, or an instance of this class, or
null.
Return values
static —An instance of this class.
values()
Get the list of public class variables listed in this class.
public
static values() : array<string|int, mixed>
Return values
array<string|int, mixed> —Instances of this class which are defined as public class variables.