Airbyte · JSON Structure

Airbyte Initiate Oauth Request Structure

InitiateOauthRequest schema from Airbyte API

Type: object Properties: 7 Required: 2
Data IntegrationETLELTOpen SourceData PipelineConnectorsData

InitiateOauthRequest is a JSON Structure definition published by Airbyte, describing 7 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name sourceType redirectUrl workspaceId oAuthInputConfiguration requestedScopes requestedOptionalScopes

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/airbyte/refs/heads/main/json-structure/airbyte-initiate-oauth-request-structure.json",
  "name": "InitiateOauthRequest",
  "description": "InitiateOauthRequest schema from Airbyte API",
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the source to authenticate to. Deprecated - use sourceType instead.",
      "type": "string"
    },
    "sourceType": {
      "description": "The name of the source to authenticate to",
      "type": "string"
    },
    "redirectUrl": {
      "description": "The URL to redirect the user to with the OAuth secret stored in the secret_id query string parameter after authentication is complete.",
      "type": "string"
    },
    "workspaceId": {
      "description": "The workspace to create the secret and eventually the full source.",
      "type": "uuid"
    },
    "oAuthInputConfiguration": {
      "$ref": "#/components/schemas/OAuthInputConfiguration",
      "description": "Input configuration for OAuth required by some sources."
    },
    "requestedScopes": {
      "type": "array",
      "description": "Optional OAuth scopes to request, overriding the connector's default scopes. Only supported for connectors that define scopes as an array.",
      "items": {
        "type": "string"
      }
    },
    "requestedOptionalScopes": {
      "type": "array",
      "description": "Optional OAuth optional_scopes to request, overriding the connector's default optional_scopes. Only applied when requestedScopes is also provided.",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "redirectUrl",
    "workspaceId"
  ]
}