WorkOS.PipesProvider (WorkOS SDK for Elixir v3.0.1)

Copy Markdown View Source

Operations for the PipesProvider API.

Summary

Functions

list_organization_data_integration_configurations(client, organization_id, opts \\ [])

List providers for an organization

update_organization_data_integration_configuration(client, organization_id, slug, params \\ %{}, opts \\ [])

Configure a provider for an organization

Functions

list_organization_data_integration_configurations(client, organization_id, opts \\ [])

@spec list_organization_data_integration_configurations(
  WorkOS.Client.t(),
  String.t(),
  keyword()
) ::
  {:ok, WorkOS.DataIntegrationConfigurationListResponse.t()}
  | {:error, WorkOS.Error.error()}

List providers for an organization

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

update_organization_data_integration_configuration(client, organization_id, slug, params \\ %{}, opts \\ [])

@spec update_organization_data_integration_configuration(
  WorkOS.Client.t(),
  String.t(),
  String.t(),
  map(),
  keyword()
) ::
  {:ok, WorkOS.DataIntegrationConfigurationResponse.t()}
  | {:error, WorkOS.Error.error()}

Configure a provider for an organization

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

  • organization_id — An Organization identifier to configure the provider for.
  • slug — The slug identifier of the provider to configure (e.g., github, slack, notion).
  • params — request body map
  • opts — per-request options (see WorkOS.Client.request/5)