BackchannelAuthenticationCompleteAction Uses EnumTrait
The value of "action" in responses from Authlete's /api/backchannel/authentication/complete API.
Tags
Table of Contents
- $NO_ACTION : BackchannelAuthenticationCompleteAction
- The OpenID provider implementation does not have to take any immediate action for this API response. The remaining task is just to handle polling requests from the client to the token endpoint.
- $NOTIFICATION : BackchannelAuthenticationCompleteAction
- The OpenID provider implementation must send a notification to the client's notification endpoint. This action code may be returned when the backchannel token delivery mode is `ping` or `push`.
- $SERVER_ERROR : BackchannelAuthenticationCompleteAction
- An error occurred either because the ticket included in the API call was invalid or because an error occurred on Authlete side.
- __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
$NO_ACTION
The OpenID provider implementation does not have to take any immediate action for this API response. The remaining task is just to handle polling requests from the client to the token endpoint.
public
static BackchannelAuthenticationCompleteAction
$NO_ACTION
This action code may be returned when the backchannel token delivery
mode is poll.
Tags
$NOTIFICATION
The OpenID provider implementation must send a notification to the client's notification endpoint. This action code may be returned when the backchannel token delivery mode is `ping` or `push`.
public
static BackchannelAuthenticationCompleteAction
$NOTIFICATION
Tags
$SERVER_ERROR
An error occurred either because the ticket included in the API call was invalid or because an error occurred on Authlete side.
public
static BackchannelAuthenticationCompleteAction
$SERVER_ERROR
If an error occurred after Authlete succeeded in retrieving data
associated with the ticket from the database and if the backchannel
token delivery mode is ping or push, NOTIFICATION is used as
the value of action instead of SERVER_ERROR. In the case,
responseContent contains "error":"server_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.