Documentation

ClientAuthMethod Uses EnumTrait

Client authentication methods.

Table of Contents

$CLIENT_SECRET_BASIC  : ClientAuthMethod
Client authentication using Basic Authentication as defined in "3.2.1. Client Authentication" of RFC 6749.
$CLIENT_SECRET_JWT  : ClientAuthMethod
Client authentication using JWT signed by the shared client secret as defined in RFC 7523.
$CLIENT_SECRET_POST  : ClientAuthMethod
Client authentication using the "client_secret" request parameter in the request body as defined in "3.2.1. Client Authentication" of RFC 6749.
$NONE  : ClientAuthMethod
No client authentication.
$PRIVATE_KEY_JWT  : ClientAuthMethod
Client authentication using X.509 certificates as defined in RFC 7523.
$SELF_SIGNED_TLS_CLIENT_AUTH  : ClientAuthMethod
Client authentication using self-signed certificates as defined in "Mutual TLS Profiles for OAuth Clients".
$TLS_CLIENT_AUTH  : ClientAuthMethod
Client authentication using X.509 certificates as defined in "Mutual TLS Profiles for OAuth Clients".
__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

$NONE

No client authentication.

public static ClientAuthMethod $NONE

Client authentication is not performed at endpoints of the authorization server, either because the client uses only the implicit flow or because the client type of the client is "public".

Tags
static

$SELF_SIGNED_TLS_CLIENT_AUTH

Client authentication using self-signed certificates as defined in "Mutual TLS Profiles for OAuth Clients".

public static ClientAuthMethod $SELF_SIGNED_TLS_CLIENT_AUTH
Tags
static

$TLS_CLIENT_AUTH

Client authentication using X.509 certificates as defined in "Mutual TLS Profiles for OAuth Clients".

public static ClientAuthMethod $TLS_CLIENT_AUTH
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