UserInfoIssueAction Uses EnumTrait
The value of "action" in responses from Authlete's /api/auth/userinfo/issue API.
Table of Contents
- $BAD_REQUEST : UserInfoIssueAction
- The request does not contain an access token.
- $FORBIDDEN : UserInfoIssueAction
- The access token does not cover the required scopes. To be concrete, the access token does not have the "openid" scope.
- $INTERNAL_SERVER_ERROR : UserInfoIssueAction
- The request from your system was wrong or an error occurred in Authlete.
- $JSON : UserInfoIssueAction
- The access token was valid and a userinfo response was generated successfully in JSON format.
- $JWT : UserInfoIssueAction
- The access token was valid and a userinfo response was generated successfully in JWT format.
- $UNAUTHORIZED : UserInfoIssueAction
- 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 UserInfoIssueAction
$BAD_REQUEST
The userinfo endpoint
implementation should return 400 Bad Request to the client
application.
Tags
$FORBIDDEN
The access token does not cover the required scopes. To be concrete, the access token does not have the "openid" scope.
public
static UserInfoIssueAction
$FORBIDDEN
The userinfo endpoint
implementation should return 403 Forbidden to the client application.
Tags
$INTERNAL_SERVER_ERROR
The request from your system was wrong or an error occurred in Authlete.
public
static UserInfoIssueAction
$INTERNAL_SERVER_ERROR
The userinfo endpoint
implementation should return 500 Internal Server Error to the client
application.
Tags
$JSON
The access token was valid and a userinfo response was generated successfully in JSON format.
public
static UserInfoIssueAction
$JSON
The userinfo endpoint
implementation should return 200 OK to the client application with
the content type application/json;charset=UTF-8.
Tags
$JWT
The access token was valid and a userinfo response was generated successfully in JWT format.
public
static UserInfoIssueAction
$JWT
The userinfo endpoint
implementation should return 200 OK to the client application with
the content type application/jwt.
Tags
$UNAUTHORIZED
The access token does not exist or has expired.
public
static UserInfoIssueAction
$UNAUTHORIZED
The userinfo endpoint
implementation 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.