PushedAuthReqAction Uses EnumTrait
The value of "action" in responses from Authlete's /api/pushed_auth_req API.
Tags
Table of Contents
- $BAD_REQUEST : PushedAuthReqAction
- The request is invalid. The pushed authorization request endpoint should return `400 Bad Request` to the client application.
- $CREATED : PushedAuthReqAction
- The pushed authorization request has been registered successfully.
- $FORBIDDEN : PushedAuthReqAction
- The client application is not allowed to use the pushed authorization request endpoint. The endpoint should return `403 Forbidden` to the client application.
- $INTERNAL_SERVER_ERROR : PushedAuthReqAction
- The API call was wrong or an error occurred on Authlete side. The pushed authorization request endpoint should return `500 Internal Server Error` to the client application. However, it is up to the authorization server's policy whether to return `500` actually.
- $PAYLOAD_TOO_LARGE : PushedAuthReqAction
- The size of the pushed authorization request is too large. The endpoint should return `413 Payload Too Large` to the client application.
- $UNAUTHORIZED : PushedAuthReqAction
- The client authentication at the pushed authorization request endpoint failed. The endpoint should return `401 Unauthorized` to the client application.
- __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 is invalid. The pushed authorization request endpoint should return `400 Bad Request` to the client application.
public
static PushedAuthReqAction
$BAD_REQUEST
Tags
$CREATED
The pushed authorization request has been registered successfully.
public
static PushedAuthReqAction
$CREATED
The endpoint should return 201 Created to the client application.
Tags
$FORBIDDEN
The client application is not allowed to use the pushed authorization request endpoint. The endpoint should return `403 Forbidden` to the client application.
public
static PushedAuthReqAction
$FORBIDDEN
Tags
$INTERNAL_SERVER_ERROR
The API call was wrong or an error occurred on Authlete side. The pushed authorization request endpoint should return `500 Internal Server Error` to the client application. However, it is up to the authorization server's policy whether to return `500` actually.
public
static PushedAuthReqAction
$INTERNAL_SERVER_ERROR
Tags
$PAYLOAD_TOO_LARGE
The size of the pushed authorization request is too large. The endpoint should return `413 Payload Too Large` to the client application.
public
static PushedAuthReqAction
$PAYLOAD_TOO_LARGE
Tags
$UNAUTHORIZED
The client authentication at the pushed authorization request endpoint failed. The endpoint should return `401 Unauthorized` to the client application.
public
static PushedAuthReqAction
$UNAUTHORIZED
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.