CustomProviderDefinition
in package
implements
JsonSerializable
uses
JsonSerializableTrait
Read onlyYes
Table of Contents
Interfaces
- JsonSerializable
Properties
- $additionalAuthorizationParameters : array<string, string>|null
- Additional static query parameters appended to the authorization request.
- $authenticateVia : CustomProviderDefinitionAuthenticateVia|null
- How client credentials are sent when exchanging authorization codes and refreshing tokens.
- $authorizationUrl : string|null
- The provider's OAuth authorization endpoint. Required for OAuth providers; omit for `api_key` providers.
- $clientSecretRequired : bool|null
- Whether a client secret is required for this provider. Defaults to `true`.
- $name : string
- A descriptive name for the custom provider.
- $pkceEnabled : bool|null
- Whether PKCE is used during the authorization code flow. Defaults to `true`.
- $refreshTokenUrl : string|null
- The endpoint used to refresh tokens, if different from the token endpoint.
- $requestScopeSeparator : string|null
- The separator used to join requested scopes. Defaults to a space.
- $scopesRequired : bool|null
- Whether at least one scope must be selected when connecting an account. Defaults to `false`.
- $tokenBodyContentType : string|null
- The Content-Type used when exchanging the token request.
- $tokenUrl : string|null
- The provider's OAuth token endpoint. Required for OAuth providers; omit for `api_key` providers.
Methods
- __construct() : mixed
- fromArray() : self
- jsonSerialize() : array<string|int, mixed>
- toArray() : array<string|int, mixed>
Properties
$additionalAuthorizationParameters
Additional static query parameters appended to the authorization request.
public
array<string, string>|null
$additionalAuthorizationParameters
= null
$authenticateVia
How client credentials are sent when exchanging authorization codes and refreshing tokens.
public
CustomProviderDefinitionAuthenticateVia|null
$authenticateVia
= null
$authorizationUrl
The provider's OAuth authorization endpoint. Required for OAuth providers; omit for `api_key` providers.
public
string|null
$authorizationUrl
= null
$clientSecretRequired
Whether a client secret is required for this provider. Defaults to `true`.
public
bool|null
$clientSecretRequired
= null
$name
A descriptive name for the custom provider.
public
string
$name
$pkceEnabled
Whether PKCE is used during the authorization code flow. Defaults to `true`.
public
bool|null
$pkceEnabled
= null
$refreshTokenUrl
The endpoint used to refresh tokens, if different from the token endpoint.
public
string|null
$refreshTokenUrl
= null
$requestScopeSeparator
The separator used to join requested scopes. Defaults to a space.
public
string|null
$requestScopeSeparator
= null
$scopesRequired
Whether at least one scope must be selected when connecting an account. Defaults to `false`.
public
bool|null
$scopesRequired
= null
$tokenBodyContentType
The Content-Type used when exchanging the token request.
public
string|null
$tokenBodyContentType
= null
$tokenUrl
The provider's OAuth token endpoint. Required for OAuth providers; omit for `api_key` providers.
public
string|null
$tokenUrl
= null
Methods
__construct()
public
__construct(string $name[, string|null $authorizationUrl = null ][, string|null $tokenUrl = null ][, string|null $refreshTokenUrl = null ][, bool|null $pkceEnabled = null ][, string|null $requestScopeSeparator = null ][, bool|null $scopesRequired = null ][, bool|null $clientSecretRequired = null ][, array<string|int, mixed>|null $additionalAuthorizationParameters = null ][, string|null $tokenBodyContentType = null ][, CustomProviderDefinitionAuthenticateVia|null $authenticateVia = null ]) : mixed
Parameters
- $name : string
- $authorizationUrl : string|null = null
- $tokenUrl : string|null = null
- $refreshTokenUrl : string|null = null
- $pkceEnabled : bool|null = null
- $requestScopeSeparator : string|null = null
- $scopesRequired : bool|null = null
- $clientSecretRequired : bool|null = null
- $additionalAuthorizationParameters : array<string|int, mixed>|null = null
- $tokenBodyContentType : string|null = null
- $authenticateVia : CustomProviderDefinitionAuthenticateVia|null = null
fromArray()
public
static fromArray(array<string|int, mixed> $data) : self
Parameters
- $data : array<string|int, mixed>
Return values
selfjsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>toArray()
public
toArray() : array<string|int, mixed>