PipesProvider
in package
Table of Contents
Properties
Methods
- __construct() : mixed
- listOrganizationDataIntegrationConfigurations() : DataIntegrationConfigurationListResponse
- List providers for an organization
- updateOrganizationDataIntegrationConfiguration() : DataIntegrationConfigurationResponse
- Configure a provider for an organization
Properties
$client read-only
private
HttpClient
$client
Methods
__construct()
public
__construct(HttpClient $client) : mixed
Parameters
- $client : HttpClient
listOrganizationDataIntegrationConfigurations()
List providers for an organization
public
listOrganizationDataIntegrationConfigurations(string $organizationId[, RequestOptions|null $options = null ]) : DataIntegrationConfigurationListResponse
Returns a list of all providers available to the specified organization, along with any configured custom OAuth scopes, enabled state, and organization-managed credentials where applicable.
Parameters
- $organizationId : string
-
An Organization identifier to list provider configurations for.
- $options : RequestOptions|null = null
Tags
Return values
DataIntegrationConfigurationListResponseupdateOrganizationDataIntegrationConfiguration()
Configure a provider for an organization
public
updateOrganizationDataIntegrationConfiguration(string $organizationId, string $slug[, bool|null $enabled = null ][, array<string|int, string>|null $scopes = null ][, string|null $clientId = null ][, string|null $clientSecret = null ][, RequestOptions|null $options = null ]) : DataIntegrationConfigurationResponse
Creates or updates an organization's provider configuration. Use this endpoint to enable or disable a provider, set custom OAuth scopes, or supply organization-managed OAuth credentials.
Parameters
- $organizationId : string
-
An Organization identifier to configure the provider for.
- $slug : string
-
The slug identifier of the provider to configure (e.g.,
github,slack,notion). - $enabled : bool|null = null
-
Whether the provider is enabled for the organization.
- $scopes : array<string|int, string>|null = null
-
The OAuth scopes to request for the organization. Pass
nullto inherit the provider scopes. - $clientId : string|null = 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 = null
-
The OAuth client secret of the organization's own application. Must be provided together with
client_id. - $options : RequestOptions|null = null