Provider

A provider represents a third-party service that users can connect to through Pipes. Providers are configured in the WorkOS Dashboard and define the OAuth scopes and credentials used during the authorization flow.

When listed for a specific user, each provider includes a connected_account field showing the user’s connection status.

Retrieves a list of available providers and the user’s connection status for each. Returns all providers configured for your environment, along with the user’s connected account information where applicable.

curl "https://api.workos.com/user_management/users/user_01EHZNVPK3SFK441A1RGBFSHRT/data_providers" \
  --header "Authorization: Bearer sk_example_123456789"

Returns a list of all providers configured for the specified organization, including their enabled state, OAuth scopes, and organization-managed credential metadata where applicable.

curl "https://api.workos.com/organizations/org_01EHZNVPK3SFK441A1RGBFSHRT/data_integration_configurations" \
  --header "Authorization: Bearer sk_example_123456789"

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.

curl --request PUT \
  --url "https://api.workos.com/organizations/org_01EHZNVPK3SFK441A1RGBFSHRT/data_integration_configurations/github" \
  --header "Authorization: Bearer sk_example_123456789" \
  --header "Content-Type: application/json" \
  -d @- <<'BODY'
    {
        "enabled": true,
        "scopes": [
            "repo",
            "user:email"
        ],
        "client_id": "client_01EHZNVPK3SFK441A1RGBFSHRT",
        "client_secret": "••••••••"
    }
BODY