BackchannelAuthenticationAction Uses EnumTrait
The value of "action" in responses from Authlete's /api/backchannel/authentication API.
Tags
Table of Contents
- $BAD_REQUEST : BackchannelAuthenticationAction
- The backchannel authentication 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 : BackchannelAuthenticationAction
- 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.
- $UNAUTHORIZED : BackchannelAuthenticationAction
- Client authentication of the backchannel authentication request failed.
- $USER_IDENTIFICATION : BackchannelAuthenticationAction
- The backchannel authentication request was valid. The authorization server implementation is required to (1) identify the subject of the end-user from the given hint, (2) issue `auth_req_id` to the client application, (3) communicate with an authentication device of the end-user to perform end-user authentication and authorization, etc.
- __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 backchannel authentication 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 BackchannelAuthenticationAction
$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 BackchannelAuthenticationAction
$INTERNAL_SERVER_ERROR
Tags
$UNAUTHORIZED
Client authentication of the backchannel authentication request failed.
public
static BackchannelAuthenticationAction
$UNAUTHORIZED
The authorization server implementation should return an error response
with 401 Unauthorized and application/json to the client application.
Tags
$USER_IDENTIFICATION
The backchannel authentication request was valid. The authorization server implementation is required to (1) identify the subject of the end-user from the given hint, (2) issue `auth_req_id` to the client application, (3) communicate with an authentication device of the end-user to perform end-user authentication and authorization, etc.
public
static BackchannelAuthenticationAction
$USER_IDENTIFICATION
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.