Documentation

TokenCreateAction Uses EnumTrait

The value of "action" in responses from Authlete's /api/auth/token/create API.

Table of Contents

$BAD_REQUEST  : TokenCreateAction
The request from your system was wrong.
$FORBIDDEN  : TokenCreateAction
The request from your system was not allowed.
$INTERNAL_SERVER_ERROR  : TokenCreateAction
An error occurred on Authlete side.
$OK  : TokenCreateAction
An access token and optionally a refresh token were issued successfully.
__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 from your system was wrong.

public static TokenCreateAction $BAD_REQUEST

For example, this happens when the grantType request parameter is missing.

Tags
static

$FORBIDDEN

The request from your system was not allowed.

public static TokenCreateAction $FORBIDDEN

For example, this happens when the client application identified by the clientId request parameter does not belong to the service identified by the API key used for the API call.

Tags
static

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.

Search results