34282926a1
## What Generates version 2.0 of the Airbyte platform documentation using Docusaurus's built-in versioning system. This creates a frozen snapshot of the current documentation that users can reference. Requested by ian.alton@airbyte.io via [Slack thread](https://airbytehq-team.slack.com/archives/D08FX8EC9L0/p1760490197805979?thread_ts=1760490197.805979). Link to Devin run: https://app.devin.ai/sessions/689693593bac44f4903f476aa17b872e ## How - Ran `pnpm run docusaurus docs:version:platform 2.0` in the docusaurus directory - This automatically: - Created `platform_versioned_docs/version-2.0/` containing a snapshot of all current platform docs - Created `platform_versioned_sidebars/version-2.0-sidebars.json` with the sidebar navigation structure - Updated `platform_versions.json` to add "2.0" to the version list - Ran prettier to format the JSON files - Verified the documentation builds successfully locally (build completed in ~3 minutes with only pre-existing broken anchor warnings) ## Review guide 1. **Verify timing**: Confirm this is the correct time to release version 2.0 of the documentation 2. **Version order**: Check `docusaurus/platform_versions.json` - verify "2.0" is first in the array (newest version first) 3. **Build verification**: Ensure CI/Vercel builds pass without errors 4. **Spot check**: Optionally review 2-3 files in `docusaurus/platform_versioned_docs/version-2.0/` to ensure content looks reasonable Note: This is a standard Docusaurus versioning operation that creates a frozen snapshot of the current "next" documentation. The generated files are extensive (500+ files) but follow Docusaurus conventions. ## User Impact Users will see version 2.0 available in the version dropdown on docs.airbyte.com. This provides a stable reference point for platform documentation at this point in time. Existing versions (1.6, 1.7, 1.8) remain unchanged. ## Can this PR be safely reverted and rolled back? - [x] YES 💚 This is an additive change that doesn't modify existing versioned docs. Reverting would simply remove version 2.0 from the version list and delete the associated documentation files. Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: ian.alton@airbyte.io <ian.alton@airbyte.io>
3.8 KiB
products
| products |
|---|
| all |
Using OAuth to Connect
Many Airbyte connectors support OAuth 2.0, enabling secure and seamless integration between Airbyte and third-party APIs. This guide explains how OAuth works for connectors in Airbyte.
What is OAuth?
OAuth 2.0 is an open standard for access delegation. It allows websites or applications to request limited access to your information on other platforms without exposing passwords. By using token-based authentication, OAuth enhances security and improves your user experience.
OAuth Flow in Airbyte
The complexity of setting up OAuth flows is handled internally by Airbyte. When you set up a new connector, you only need to complete a few steps to use OAuth. Airbyte’s OAuth implementation involves three key components:
-
You: The individual authorizing access to your account on a third-party platform.
-
Airbyte: The application requesting authorization on your behalf.
-
The third-party API: The service to which the connector needs access.
This simplified diagram visualizes the connection process.
graph TD;
A[You] -->| Authorize Airbyte| B[Third-party authorization server]
B -->| Issues authorization code| C[Airbyte]
C -->| Exchanges authorization code for access token| B
C -->| Sends API Request with access token| D[Third-party resource server]
D -->| Returns protected data| C
OAuth in Airbyte Cloud
In Airbyte Cloud, the process depends on a connector's support level.
Airbyte connectors
For Airbyte connectors, client credentials are securely managed by Airbyte. You only need to click the authentication button and use the third-party platform's UI to authorize Airbyte.
Marketplace and custom connectors
For Marketplace or custom connectors, you must configure your own client credentials.
-
Register an application on the third-party platform to obtain a Client ID and Client Secret. The exact process differs slightly for each third-party, but most explain this process in their documentation. The documentation for an Airbyte connector often provides these steps, too.
-
Enter your Client ID and Client Secret into the connector settings in Airbyte.
-
Click the authentication button.
OAuth in Self-Managed Airbyte
In Self-Managed Airbyte, for security reasons, you must configure your own client credentials.
-
Register an application on the third-party platform to obtain a Client ID and Client Secret. The exact process differs slightly for each third-party, but most explain this process in their documentation. The documentation for an Airbyte connector often provides these steps, too.
-
Enter your Client ID and Client Secret into the connector settings in Airbyte.
-
Click the authentication button.
Security Considerations
-
You are responsible for managing client credentials except when Airbyte Cloud provides the OAuth app for you. Treat these keys like a username and password, and handle your sensitive data securely.
-
OAuth is supported in airgapped instances of Airbyte. Redirects happen in your web browser, not the Airbyte server.
Troubleshooting Common OAuth Issues
When OAuth connections fail, it's usually one of these problems.
Your credentials are invalid
-
Verify that the Client ID and Client Secret are correct (Self-Managed only).
-
Check for typos or missing configuration steps.
Your token is expired
- Airbyte handles access tokens and refresh tokens for you. If something goes wrong, reauthorize the connector.
Redirect URI Mismatch
- Confirm that the redirect URI registered with the third-party platform matches the URI used by Airbyte. Airbyte's user interface provides this URI when you set up a new connector. Make sure you enter this value exactly.