BackchannelAuthenticationFailAction Uses EnumTrait
The value of "action" in responses from Authlete's /api/backchannel/authentication/fail API.
Tags
Table of Contents
- $BAD_REQUEST : BackchannelAuthenticationFailAction
- The implementation of the backchannel authentication endpoint should return a `400 Bad Request` response to the client application.
- $FORBIDDEN : BackchannelAuthenticationFailAction
- The implementation of the backchannel authentication endpoint should return a `403 Forbidden` response to the client application.
- $INTERNAL_SERVER_ERROR : BackchannelAuthenticationFailAction
- The implementation of the backchannel authentication endpoint should return a `500 Internal Server Error` response to the client application.
- __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 implementation of the backchannel authentication endpoint should return a `400 Bad Request` response to the client application.
public
static BackchannelAuthenticationFailAction
$BAD_REQUEST
Tags
$FORBIDDEN
The implementation of the backchannel authentication endpoint should return a `403 Forbidden` response to the client application.
public
static BackchannelAuthenticationFailAction
$FORBIDDEN
BackchannelAuthenticationFailResponse.getAction() returns this value
only when the reason request parameter of the API call was
ACCESS_DENIED.
Tags
$INTERNAL_SERVER_ERROR
The implementation of the backchannel authentication endpoint should return a `500 Internal Server Error` response to the client application.
public
static BackchannelAuthenticationFailAction
$INTERNAL_SERVER_ERROR
However, in most cases, commercial implementations prefer to use other HTTP status code than 5xx.
BackchannelAuthenticationFailResponse.getAction() returns this value
when (1) the reason request parameter of the API call was
SERVER_ERROR, (2) an error occurred on Authlete side, or (3) the
request parameters of the API call were wrong.
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.