ConfigureDataIntegrationBody
in package
implements
JsonSerializable
uses
JsonSerializableTrait
Table of Contents
Interfaces
- JsonSerializable
Properties
- $clientId : string|null
- The OAuth client ID of the organization's own application. Must be provided together with `client_secret`, and only for providers whose credentials are supplied by the organization.
- $clientSecret : string|null
- The OAuth client secret of the organization's own application. Must be provided together with `client_id`.
- $config : array<string, string>|null
- Provider-specific config values to set for the organization, keyed by config field. Only fields the provider declares are accepted, and each value must match that field's pattern. Accepted only for providers whose credentials are organization-managed; for shared or custom credential providers, config belongs on the integration itself (via the data-integrations API) and supplying it here is rejected.
- $enabled : bool|null
- Whether the provider is enabled for the organization.
- $scopes : array<string|int, string>|null
- The OAuth scopes to request for the organization. Pass `null` to inherit the provider scopes.
Methods
- __construct() : mixed
- fromArray() : self
- jsonSerialize() : array<string|int, mixed>
- toArray() : array<string|int, mixed>
Properties
$clientId
The OAuth client ID of the organization's own application. Must be provided together with `client_secret`, and only for providers whose credentials are supplied by the organization.
public
string|null
$clientId
= null
$clientSecret
The OAuth client secret of the organization's own application. Must be provided together with `client_id`.
public
string|null
$clientSecret
= null
$config
Provider-specific config values to set for the organization, keyed by config field. Only fields the provider declares are accepted, and each value must match that field's pattern. Accepted only for providers whose credentials are organization-managed; for shared or custom credential providers, config belongs on the integration itself (via the data-integrations API) and supplying it here is rejected.
public
array<string, string>|null
$config
= null
$enabled
Whether the provider is enabled for the organization.
public
bool|null
$enabled
= null
$scopes
The OAuth scopes to request for the organization. Pass `null` to inherit the provider scopes.
public
array<string|int, string>|null
$scopes
= null
Methods
__construct()
public
__construct([bool|null $enabled = null ][, array<string|int, mixed>|null $scopes = null ][, string|null $clientId = null ][, string|null $clientSecret = null ][, array<string|int, mixed>|null $config = null ]) : mixed
Parameters
- $enabled : bool|null = null
- $scopes : array<string|int, mixed>|null = null
- $clientId : string|null = null
- $clientSecret : string|null = null
- $config : array<string|int, mixed>|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>