DataIntegrationCustomProvider
in package
implements
JsonSerializable
uses
JsonSerializableTrait
Read onlyYes
Table of Contents
Interfaces
- JsonSerializable
Properties
- $additionalAuthorizationParameters : array<string, string>
- Additional static query parameters appended to the authorization request.
- $authenticateVia : CustomProviderDefinitionAuthenticateVia
- How client credentials are sent when exchanging authorization codes and refreshing tokens.
- $authorizationUrl : string|null
- The provider's OAuth authorization endpoint.
- $clientSecretRequired : bool
- Whether a client secret is required for this provider.
- $name : string
- A descriptive name for the custom provider.
- $pkceEnabled : bool
- Whether PKCE is used during the authorization code flow.
- $refreshTokenUrl : string|null
- The endpoint used to refresh tokens, if different from the token endpoint.
- $requestScopeSeparator : string
- The separator used to join requested scopes.
- $scopesRequired : bool
- Whether at least one scope must be selected when connecting an account.
- $tokenBodyContentType : string
- The Content-Type used when exchanging the token request.
- $tokenUrl : string|null
- The provider's OAuth token endpoint.
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>
$additionalAuthorizationParameters
$authenticateVia
How client credentials are sent when exchanging authorization codes and refreshing tokens.
public
CustomProviderDefinitionAuthenticateVia
$authenticateVia
$authorizationUrl
The provider's OAuth authorization endpoint.
public
string|null
$authorizationUrl
$clientSecretRequired
Whether a client secret is required for this provider.
public
bool
$clientSecretRequired
$name
A descriptive name for the custom provider.
public
string
$name
$pkceEnabled
Whether PKCE is used during the authorization code flow.
public
bool
$pkceEnabled
$refreshTokenUrl
The endpoint used to refresh tokens, if different from the token endpoint.
public
string|null
$refreshTokenUrl
$requestScopeSeparator
The separator used to join requested scopes.
public
string
$requestScopeSeparator
$scopesRequired
Whether at least one scope must be selected when connecting an account.
public
bool
$scopesRequired
$tokenBodyContentType
The Content-Type used when exchanging the token request.
public
string
$tokenBodyContentType
$tokenUrl
The provider's OAuth token endpoint.
public
string|null
$tokenUrl
Methods
__construct()
public
__construct(string $name, string|null $authorizationUrl, string|null $tokenUrl, string|null $refreshTokenUrl, bool $pkceEnabled, string $requestScopeSeparator, bool $scopesRequired, bool $clientSecretRequired, array<string|int, mixed> $additionalAuthorizationParameters, string $tokenBodyContentType, CustomProviderDefinitionAuthenticateVia $authenticateVia) : mixed
Parameters
- $name : string
- $authorizationUrl : string|null
- $tokenUrl : string|null
- $refreshTokenUrl : string|null
- $pkceEnabled : bool
- $requestScopeSeparator : string
- $scopesRequired : bool
- $clientSecretRequired : bool
- $additionalAuthorizationParameters : array<string|int, mixed>
- $tokenBodyContentType : string
- $authenticateVia : CustomProviderDefinitionAuthenticateVia
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>