| Methods |
public
|
__construct(
string $clientName,
null|string $redirectUri = null,
null|string $clientIdMetadataDocumentUrl = null,
null|ClientRegistration $preRegistered = null,
ApplicationType $applicationType = ApplicationType::Native,
int $maxScopeUpgrades = 2,
bool $requestOfflineAccess = false,
list<non-empty-string> $defaultScopes = [],
InsufficientScopePolicy $onInsufficientScope = InsufficientScopePolicy::Reauthorize,
float $timeout = 10.0,
bool $allowInsecureLoopback = false,
)
Parameters
| $clientName |
Name shown to the resource owner on a consent screen
|
| $redirectUri |
Redirect URI where the authorization response lands, either loopback or HTTPS. null for grants that never visit an authorization endpoint
|
| $clientIdMetadataDocumentUrl |
HTTPS URL of a hosted Client ID Metadata Document, used verbatim as client_id
|
| $preRegistered |
Credentials issued out of band, which take priority over every other mechanism
|
| $applicationType |
Declared during Dynamic Client Registration
|
| $maxScopeUpgrades |
How many times a request may be retried after an insufficient-scope challenge
|
| $requestOfflineAccess |
Whether to ask for offline_access, and with it a refresh token, where the authorization server offers it
|
| $defaultScopes |
Scopes to ask for when no challenge names any, in place of everything advertised by the resource
|
| $onInsufficientScope |
Whether an insufficient-scope answer steps the scopes up or is reported to the caller
|
| $timeout |
Seconds that a single authorization round trip may take
|
| $allowInsecureLoopback |
Admits an authorization server reached over cleartext HTTP on a loopback host, which the spec does not exempt. For local development and conformance runs, never production
|
|
#
|
| Properties |
public
|
string
|
$clientName
Name shown to the resource owner on a consent screen
Name shown to the resource owner on a consent screen
|
#
|
public
|
null|string
|
$redirectUri
Redirect URI where the authorization response lands, either loopback or HTTPS. null for grants that never visit an authorization endpoint
Redirect URI where the authorization response lands, either loopback or HTTPS. null for grants that never visit an authorization endpoint
|
#
|
public
|
null|string
|
$clientIdMetadataDocumentUrl
HTTPS URL of a hosted Client ID Metadata Document, used verbatim as client_id
HTTPS URL of a hosted Client ID Metadata Document, used verbatim as client_id
|
#
|
public
|
null|ClientRegistration
|
$preRegistered
Credentials issued out of band, which take priority over every other mechanism
Credentials issued out of band, which take priority over every other mechanism
|
#
|
public
|
ApplicationType
|
$applicationType
Declared during Dynamic Client Registration
Declared during Dynamic Client Registration
|
#
|
public
|
int
|
$maxScopeUpgrades
How many times a request may be retried after an insufficient-scope challenge
How many times a request may be retried after an insufficient-scope challenge
|
#
|
public
|
bool
|
$requestOfflineAccess
Whether to ask for offline_access, and with it a refresh token, where the authorization server offers it
Whether to ask for offline_access, and with it a refresh token, where the authorization server offers it
|
#
|
public
|
list<non-empty-string>
|
$defaultScopes
Scopes to ask for when no challenge names any, in place of everything advertised by the resource
Scopes to ask for when no challenge names any, in place of everything advertised by the resource
|
#
|
public
|
InsufficientScopePolicy
|
$onInsufficientScope
Whether an insufficient-scope answer steps the scopes up or is reported to the caller
Whether an insufficient-scope answer steps the scopes up or is reported to the caller
|
#
|
public
|
float
|
$timeout
Seconds that a single authorization round trip may take
Seconds that a single authorization round trip may take
|
#
|
public
|
bool
|
$allowInsecureLoopback
Admits an authorization server reached over cleartext HTTP on a loopback host, which the spec does not exempt. For local development and conformance runs, never production
Admits an authorization server reached over cleartext HTTP on a loopback host, which the spec does not exempt. For local development and conformance runs, never production
|
#
|