AIairbytehq
public_workspaces
public
Workspaces

Create OAuth override credentials for a workspace and source type.

Changed on

Create/update a set of OAuth credentials to override the Airbyte-provided OAuth credentials used for source/destination OAuth. In order to determine what the credential configuration needs to be, please see the connector specification of the relevant source/destination.

put/workspaces/{workspaceId}/oauthCredentials

Request

  • Base URL
    https://api.airbyte.com/v1
  • URL
    https://api.airbyte.com/v1/workspaces/{workspaceId}/oauthCredentials
  • Auth
    • HTTP bearer
    • or HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: /applications/token

Request body

actorType'source' | 'destination' required

Whether you're setting this override for a source or destination

name'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

Example request

{
  "configuration": {
    "credentials": {
      "client_id": "123456789000",
      "client_secret": "secret"
    }
  }
}

Response

OAuth credential override was successful.

Changes

  • 5e3520798637Revision changes
    • info

      added the new ticktick enum value to the request property

    • info

      added to the request property oneOf list

  • 0701e88bdf31Revision changes
    • breaking

      removed the enum value snowflake of the request property

    • breaking

      removed from the request property oneOf list

    • info

      added the new intercom enum value to the request property

    • info

      added to the request property oneOf list