Airbyte · Schema

Root Type for initiate-oauth-post-body

Data IntegrationETLELTOpen SourceData PipelineConnectorsData

Properties

Name Type Description
name string The name of the source to authenticate to. Deprecated - use sourceType instead.
sourceType string The name of the source to authenticate to
redirectUrl string The URL to redirect the user to with the OAuth secret stored in the secret_id query string parameter after authentication is complete.
workspaceId string The workspace to create the secret and eventually the full source.
oAuthInputConfiguration object Input configuration for OAuth required by some sources.
requestedScopes array Optional OAuth scopes to request, overriding the connector's default scopes. Only supported for connectors that define scopes as an array.
requestedOptionalScopes array Optional OAuth optional_scopes to request, overriding the connector's default optional_scopes. Only applied when requestedScopes is also provided.
View JSON Schema on GitHub

JSON Schema

airbyte-initiateoauthrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/InitiateOauthRequest",
  "title": "Root Type for initiate-oauth-post-body",
  "required": [
    "redirectUrl",
    "workspaceId"
  ],
  "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": {
      "format": "uuid",
      "description": "The workspace to create the secret and eventually the full source.",
      "type": "string"
    },
    "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"
      }
    }
  },
  "example": {
    "redirectUrl": "https://cloud.airbyte.io/v1/api/oauth/callback",
    "workspaceId": "871d9b60-11d1-44cb-8c92-c246d53bf87e",
    "destinationId": "3d93b16c-ff5f-421c-8908-5a3c82088f14"
  },
  "x-speakeasy-component": true
}