WorkOS PHP SDK

CreateDataIntegration

in package

• Application

implements JsonSerializable uses JsonSerializableTrait

Table of Contents

Interfaces

JsonSerializable

Properties

$apiKey  : ApiKeyInstallation|null

An optional API key to install for the first tenant on an `api_key` integration. Omit to declare a keyless integration; tenants can be added later via the per-installation API key path.

$authMethods  : array<string|int, DataIntegrationAuthMethods>|null

How accounts authenticate with the provider. Defaults to `["oauth"]`. Use `["api_key"]` to declare an API key integration; `credentials` is then not required and keys are supplied per-tenant (optionally via `api_key` on this request). Use `["client_credentials"]` to declare a client-credentials integration; `credentials` is likewise not required and client credentials are supplied per-tenant.

$config  : array<string, string>|null

Provider-specific config values (e.g. a Snowflake `account`), keyed by the config field. Only fields the built-in provider declares are accepted.

$credentials  : DataIntegrationCredentialsInput|null

The OAuth credentials to configure for the Data Integration. Required for OAuth integrations; omit when `auth_methods` is `["api_key"]`.

$customProvider  : CustomProviderDefinition|null

The OAuth definition for a custom provider. Supply this to define a custom provider; omit it to create an integration for a built-in provider.

$description  : string|null

An optional description of the Data Integration.

$enabled  : bool|null

Whether the Data Integration is enabled. Defaults to `false`.

$provider  : string

The provider to create a Data Integration for. For a built-in provider use its slug (e.g. `github`, `slack`). For a custom provider, this is the new provider slug and `custom_provider` must be supplied. A custom provider slug cannot shadow an existing global provider slug.

$scopes  : array<string|int, string>|null

The OAuth scopes to request for the Data Integration. Defaults to the provider's configured scopes when omitted.

Methods

__construct()  : mixed

fromArray()  : self

jsonSerialize()  : array<string|int, mixed>

toArray()  : array<string|int, mixed>