IntrospectionAction Uses EnumTrait
Get the value of "action" in responses from Authlete's /api/auth/introspection API.
Table of Contents
- $BAD_REQUEST : IntrospectionAction
- The request does not contain an access token.
- $FORBIDDEN : IntrospectionAction
- The access token does not cover the required scopes.
- $INTERNAL_SERVER_ERROR : IntrospectionAction
- The request from the resource server was wrong or an error occurred in Authlete.
- $OK : IntrospectionAction
- The access token is valid.
- $UNAUTHORIZED : IntrospectionAction
- The access token does not exist or has expired.
- __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 request does not contain an access token.
public
static IntrospectionAction
$BAD_REQUEST
The resource server should return 400 Bad Request to the client
application.
Tags
$FORBIDDEN
The access token does not cover the required scopes.
public
static IntrospectionAction
$FORBIDDEN
The resource server should return 403 Forbidden to the client
application.
Tags
$INTERNAL_SERVER_ERROR
The request from the resource server was wrong or an error occurred in Authlete.
public
static IntrospectionAction
$INTERNAL_SERVER_ERROR
The resource server should return 500 Internal Server Error to the
client application.
Tags
$OK
The access token is valid.
public
static IntrospectionAction
$OK
The resource server should return the protected resource to the client application.
Tags
$UNAUTHORIZED
The access token does not exist or has expired.
public
static IntrospectionAction
$UNAUTHORIZED
The resource server should return 401 Unauthorized to the client
application.
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.