AIairbytehq
public_organizations
public
Organizations

Create OAuth override credentials for an organization 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/organizations/{organizationId}/oauthCredentials

Request

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

Path parameters

organizationIdstring UUID required

Request body

actorType'source' | 'destination' required

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

namestring required

The name of the source i.e. google-ads

Example request

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

Response

OAuth credential override was successful.

Changes

  • 5e3520798637Revision changes
    • info

      added to the request property oneOf list

  • 0701e88bdf31Revision changes
    • breaking

      added the new path request parameter organizationId

    • breaking

      removed from the request property oneOf list

    • info

      added to the request property oneOf list