AIairbytehq
public_sources
public
Sources

Initiate OAuth for a source

Changed on

Given a source ID, workspace ID, and redirect URL, initiates OAuth for the source.

This returns a fully formed URL for performing user authentication against the relevant source identity provider (IdP). Once authentication has been completed, the IdP will redirect to an Airbyte endpoint which will save the access and refresh tokens off as a secret and return the secret ID to the redirect URL specified in the secret_id query string parameter.

That secret ID can be used to create a source with credentials in place of actual tokens.

post/sources/initiateOAuth

Request

  • Base URL
    https://api.airbyte.com/v1
  • URL
    https://api.airbyte.com/v1/sources/initiateOAuth
  • Auth
    • HTTP bearer
    • or HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: /applications/token

Request body

redirectUrlstring required

The URL to redirect the user to with the OAuth secret stored in the secret_id query string parameter after authentication is complete.

workspaceIdstring uuid required

The workspace to create the secret and eventually the full source.

oAuthInputConfigurationunknown
sourceType'airtable' | 'amazon-ads' | 'amazon-seller-partner' | 'asana' | 'azure-blob-storage' | 'bing-ads' | 'drift' | 'facebook-marketing' | 'facebook-pages' | 'gcs' | 'github' | 'gitlab' | 'google-ads' | 'google-analytics-data-api' | 'google-drive' | 'google-search-console' | 'google-sheets' | 'hubspot' | 'instagram' | 'intercom' | 'lever-hiring' | 'linkedin-ads' | 'mailchimp' | 'microsoft-onedrive' | 'microsoft-sharepoint' | 'microsoft-teams' | 'monday' | 'notion' | 'pinterest' | 'rd-station-marketing' | 'salesforce' | 'sharepoint-enterprise' | 'slack' | 'smartsheets' | 'snapchat-marketing' | 'surveymonkey' | 'ticktick' | 'tiktok-marketing' | 'trello' | 'typeform' | 'youtube-analytics' | 'zendesk-support' | 'zendesk-talk' required
requestedScopesstring[]

Optional OAuth scopes to request, overriding the connector's default scopes. Only supported for connectors that define scopes as an array.

requestedOptionalScopesstring[]

Optional OAuth optional_scopes to request, overriding the connector's default optional_scopes. Only applied when requestedScopes is also provided.

Example request

{
  "redirectUrl": "https://cloud.airbyte.io/v1/api/oauth/callback",
  "workspaceId": "871d9b60-11d1-44cb-8c92-c246d53bf87e",
  "destinationId": "3d93b16c-ff5f-421c-8908-5a3c82088f14"
}

Response

Response from the initiate OAuth call should be an object with a single property which will be the redirect_url. If a user is redirected to this URL, they'll be prompted by the identity provider to authenticate.

Changes