Initiate OAuth for a source

post

https://api.airbyte.com/v1/sources/initiateOAuth

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

redirectUrl

string

required

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

workspaceId

uuid

required

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

oAuthInputConfiguration

string

Input configuration for OAuth required by some sources.

sourceType

enum

required

Responses

400

A field in the body has not been set appropriately.

403

API key is invalid.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here!

200Response 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.