BackchannelAuthenticationCompleteResult Uses EnumTrait
The value of "result" in requests to Authlete's /api/backchannel/authentication/complete API.
Tags
Table of Contents
- $ACCESS_DENIED : BackchannelAuthenticationCompleteResult
- The end-user denied the backchannel authentication request.
- $AUTHORIZED : BackchannelAuthenticationCompleteResult
- The end-user was authenticated and has granted authorization to the client application.
- $TRANSACTION_FAILED : BackchannelAuthenticationCompleteResult
- The authorization server could not get the result of end-user authentication and authorization from the authentication device for some reasons.
- __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
$ACCESS_DENIED
The end-user denied the backchannel authentication request.
public
static BackchannelAuthenticationCompleteResult
$ACCESS_DENIED
Tags
$AUTHORIZED
The end-user was authenticated and has granted authorization to the client application.
public
static BackchannelAuthenticationCompleteResult
$AUTHORIZED
Tags
$TRANSACTION_FAILED
The authorization server could not get the result of end-user authentication and authorization from the authentication device for some reasons.
public
static BackchannelAuthenticationCompleteResult
$TRANSACTION_FAILED
For example, the authorization server failed to communicate with the authentication device due to a network error, the device did not return a response within a reasonable time, etc.
This result can be used as a generic error.
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.