AuthorizationAction Uses EnumTrait
The value of "action" in responses from Authlete's /api/auth/authorization API.
Table of Contents
- $BAD_REQUEST : AuthorizationAction
- The authorization request was wrong and the authorization server implementation should notify the client application of the error by "400 Bad Request".
- $FORM : AuthorizationAction
- The authorization request was wrong and the authorization server implementation should notify the client application of the error by "200 OK" with an HTML which triggers redirection by JavaScript.
- $INTERACTION : AuthorizationAction
- The authorization request was valid and the authorization server implementation should display UI to ask for authorization from the end-user.
- $INTERNAL_SERVER_ERROR : AuthorizationAction
- The request from the authorization server implementation was wrong or an error occurred in Authlete. The authorization server implementation should return "500 Internal Server Error" to the client application.
- $LOCATION : AuthorizationAction
- The authorization request was wrong and the authorization server implementation should notify the client application of the error by "302 Found".
- $NO_INTERACTION : AuthorizationAction
- The authorization request was valid and the authorization server implementation should issue an authorization code, an ID token and/or an access token without interaction with the end-user.
- __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 authorization request was wrong and the authorization server implementation should notify the client application of the error by "400 Bad Request".
public
static AuthorizationAction
$BAD_REQUEST
Tags
$FORM
The authorization request was wrong and the authorization server implementation should notify the client application of the error by "200 OK" with an HTML which triggers redirection by JavaScript.
public
static AuthorizationAction
$FORM
Tags
$INTERACTION
The authorization request was valid and the authorization server implementation should display UI to ask for authorization from the end-user.
public
static AuthorizationAction
$INTERACTION
Tags
$INTERNAL_SERVER_ERROR
The request from the authorization server implementation was wrong or an error occurred in Authlete. The authorization server implementation should return "500 Internal Server Error" to the client application.
public
static AuthorizationAction
$INTERNAL_SERVER_ERROR
Tags
$LOCATION
The authorization request was wrong and the authorization server implementation should notify the client application of the error by "302 Found".
public
static AuthorizationAction
$LOCATION
Tags
$NO_INTERACTION
The authorization request was valid and the authorization server implementation should issue an authorization code, an ID token and/or an access token without interaction with the end-user.
public
static AuthorizationAction
$NO_INTERACTION
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.