openapi: 3.2.0 info: title: Sigma Computing Connections API version: '1.0' description: 'Operations tagged connections across 2 of this provider''s published API definitions: sigma-computing-public-rest-api-openapi.json, sigma-computing-rest-api-openapi.yaml. Each path carries the servers of the definition it was published in.' servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations tags: - name: connections paths: /v2/connection/{connectionId}/lookup: post: summary: Look up connections by path description: "This endpoint returns details about the fully qualified path to an object in a specific connection by connection ID.\n\n ### Usage notes\n - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n\n Different connections support different paths:\n\n - For a Snowflake connection, you can specify `DATABASE.SCHEMA.TABLE`, `DATABASE.SCHEMA.STORED_PROCEDURE`, or a less-specific path.\n - For Amazon Redshift, you can specify `SCHEMA.TABLE`, `SCHEMA.STORED_PROCEDURE`, or a less-specific path.\n - For Databricks, you can specify `CATALOG.SCHEMA.TABLE` or a less-specific path.\n\n Connection path details include the connection path ID, called the `inodeId` in the response, and the type of object in the connection path, either a table or a scope (database, schema, catalog, or other higher-level object)." parameters: - name: connectionId schema: type: string in: path required: true operationId: lookupConnection requestBody: description: The request body. content: application/json: schema: type: object required: - path properties: path: oneOf: - type: array minItems: 3 maxItems: 3 items: type: string description: Database name title: Database description: Represents a path of the form `DATABASE.SCHEMA.TABLE` or `DATABASE.SCHEMA.STORED_PROCEDURE`. title: Table or Object Path - type: array minItems: 2 maxItems: 2 items: type: string description: Database Name title: Database description: Represents a path of the form `DATABASE.SCHEMA`. title: Schema Path - type: array minItems: 1 maxItems: 1 items: type: string description: Database Name title: Database description: Represents a path of the form `DATABASE`. title: Database Path - type: array items: {} maxItems: 0 description: Empty path to sync the entire connection. title: Empty Path responses: '200': description: The response body. content: application/json: schema: type: object required: - kind - inodeId - url properties: kind: type: string enum: - scope - table - semanticView - metricView - stored-procedure inodeId: type: string url: type: string default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - connections security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/connections: get: summary: List connections description: Get a list of available connections and the connection IDs. parameters: - name: page schema: type: string description: Use to specify further pages using the string returned in the nextPage portion of the response. title: Page in: query - name: limit schema: type: number description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results. title: Limit in: query - name: includeArchived schema: type: boolean in: query - name: search schema: type: string description: Search filter for the name of the connection. in: query operationId: listConnections responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - entries - nextPage properties: entries: type: array items: allOf: - type: object required: - organizationId - connectionId - isSample - isAuditLog - lastActiveAt - name - type - useOauth - createdBy - updatedBy - createdAt - updatedAt properties: organizationId: type: string description: Unique identifier of the organization connectionId: type: string description: Unique identifier of the connection isSample: type: boolean description: Whether the connection is the Sigma sample data connection isAuditLog: type: boolean description: Whether audit logging is enabled lastActiveAt: type: string format: date-time description: Last activity date and time name: type: string description: Name of the connection type: type: string description: Type of the connection (e.g., "bigQuery") useOauth: type: boolean description: Whether OAuth is used createdBy: type: string description: Identifier of the user who created this connection updatedBy: type: string description: Identifier of the user or process that last updated this connection createdAt: type: string format: date-time description: When the connection was created updatedAt: type: string format: date-time description: When the connection was last updated - type: object properties: isArchived: type: boolean description: Whether the connection is archived account: type: string description: Account associated with the connection warehouse: type: string description: Warehouse associated with the connection user: type: string description: User associated with the connection role: type: string description: Role used by the connection user timeout: allOf: - type: object required: - default properties: default: type: number - type: object properties: worksheet: type: number dashboard: type: number download: type: number description: Timeout settings for the connection, with a default value in seconds poolSizes: type: object properties: isPoolConfigured: type: boolean adhocPoolSize: type: number catalogPoolSize: type: number resultPoolSize: type: number schedulePoolSize: type: number description: Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize writeAccess: type: boolean friendlyName: type: boolean description: Whether friendly names are enabled for this connection writebacks: type: array items: allOf: - allOf: - type: object required: - database - schema properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform - type: object properties: writebackSchemaId: type: string description: Unique identifier of the writebackSchema - type: object properties: description: type: string description: Description for the write-back destination. description: Configure write-back for non-OAuth connections writebackSchemas: type: array items: allOf: - allOf: - type: object required: - database - schema properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform - type: object properties: writebackSchemaId: type: string description: Unique identifier of the writebackSchema - type: object properties: description: type: string description: Description for the write-back destination. description: Configure write-back for OAuth connections inputTableAuditLogSchema: allOf: - type: object required: - database - schema properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform - type: object properties: writebackSchemaId: type: string description: Unique identifier of the writebackSchema description: Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection. materializationWarehouse: type: string description: Warehouse used to run materialization jobs exportsWarehouse: type: string description: Warehouse used to run export jobs oauthMetadataUrl: type: string description: OAuth metadata URL configured directly on this connection. oauthClientId: type: string description: Client ID configured directly on this connection. oauthScopes: type: array items: type: string description: OAuth scopes configured directly on this connection. oauthIdpType: oneOf: - type: string enum: - aws_databricks - type: string enum: - azure_databricks - type: string enum: - gcp_databricks - type: string enum: - azuread - type: string enum: - auth0 - type: string enum: - adfs - type: string enum: - okta - type: string enum: - ping - type: string enum: - snowflake - type: string enum: - unknown description: OAuth provider type configured or inferred for this connection. oauthUsePkce: type: - boolean - 'null' description: Whether this connection-level OAuth configuration uses PKCE. oauthUseJwt: type: - boolean - 'null' description: Whether this connection-level OAuth configuration uses JWT bearer token authentication. oauthAudience: type: string description: Audience used for OAuth federation, such as the Google workforce identity federation audience for BigQuery. isIndependentOAuth: type: boolean description: Whether this connection uses connection-level OAuth instead of organization-level OAuth. userAttributes: type: object properties: role: type: string warehouse: type: string description: User attributes associated with the connection roleSwitching: type: string enum: - allRoles - disabled description: Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful for Snowflake OAuth connections. description: Array of results returned by the endpoint nextPage: type: - string - 'null' description: Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`. - type: object properties: total: type: number description: Total number of results. Useful to determine if there is a need to paginate. hasMore: type: boolean description: '**[Deprecated]** Indicates whether more results are available.' default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - connections security: - oauth2: [] post: summary: Create a connection description: Create a connection to a cloud data warehouse from Sigma. For additional details, see [Connect to data sources](https://help.sigmacomputing.com/docs/connect-to-data-sources). parameters: [] operationId: createConnection requestBody: description: The request body. content: application/json: schema: allOf: - type: object required: - details - name properties: details: oneOf: - allOf: - type: object required: - type - host - database properties: type: type: string enum: - postgres - redshift - alloydb host: type: string database: type: string - type: object properties: user: type: string password: oneOf: - type: string - type: object required: - type - value properties: type: type: string enum: - plain value: type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string port: type: number useTls: type: boolean writeAccess: type: object required: - writeSchema properties: writeSchema: type: string description: Details of the PostgreSQL connection. title: PostgreSQL - allOf: - allOf: - type: object required: - type - projectId properties: type: type: string enum: - bigQuery projectId: type: string - type: object properties: additionalProjectIds: type: array items: type: string serviceAccount: oneOf: - type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string - type: object properties: metadataUrl: type: string description: OAuth metadata URL for connection-level OAuth. clientId: type: string description: Client ID for the OAuth application used by this connection. clientSecret: oneOf: - type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string description: Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API. scopes: type: array items: type: string description: OAuth scopes to request when users authenticate to this connection. idpType: oneOf: - type: string enum: - aws_databricks - type: string enum: - azure_databricks - type: string enum: - gcp_databricks - type: string enum: - azuread - type: string enum: - auth0 - type: string enum: - adfs - type: string enum: - okta - type: string enum: - ping - type: string enum: - snowflake - type: string enum: - unknown type: 'null' description: OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown. usePkce: type: - boolean - 'null' description: Whether the OAuth flow should require Proof Key for Code Exchange (PKCE). Databricks-hosted OAuth providers require PKCE. useJwt: type: - boolean - 'null' description: Whether the OAuth flow should use JWT bearer token authentication instead of a client secret. - type: object properties: useOauth: type: boolean description: Whether this BigQuery connection uses OAuth federation. audience: type: string description: Google workforce identity federation audience used to exchange the OAuth token for a Google access token. writeAccess: type: object required: - writeProject - writeDataset properties: writeProject: type: string writeDataset: type: string description: Details of the BigQuery connection. title: Google BigQuery - allOf: - allOf: - type: object required: - type properties: type: type: string enum: - snowflake - type: object properties: server: type: string account: type: string host: type: string warehouse: type: string role: type: string authType: type: string enum: - basic-auth - key-pair - oauth - oneOf: - type: object required: - user - password properties: user: type: string password: oneOf: - type: string - type: object required: - type - value properties: type: type: string enum: - plain value: type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string description: Set up basic authentication for the connection title: Basic Authentication - allOf: - type: object required: - user - privateKey properties: user: type: string privateKey: oneOf: - type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string - type: object properties: privateKeyPassphrase: oneOf: - type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string description: Set up key-pair authentication for the connection title: Key-Pair Authentication - type: object required: - useOauth properties: useOauth: type: boolean enum: - true description: Set up OAuth for the connection title: OAuth - type: object properties: usePython: type: boolean pythonSecrets: type: object properties: setupUser: allOf: - type: object required: - username - password properties: username: type: string password: type: string - type: object properties: role: type: string pythonUser: allOf: - type: object required: - username - password properties: username: type: string password: type: string - type: object properties: role: type: string pythonProperties: type: object properties: serviceNames: type: array items: type: string externalAccessIntegration: type: string - type: object properties: useSourceSwapPolicy: type: boolean sourceSwapPolicyId: type: string - type: object properties: metadataUrl: type: string description: OAuth metadata URL for connection-level OAuth. clientId: type: string description: Client ID for the OAuth application used by this connection. clientSecret: oneOf: - type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string description: Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API. scopes: type: array items: type: string description: OAuth scopes to request when users authenticate to this connection. idpType: oneOf: - type: string enum: - aws_databricks - type: string enum: - azure_databricks - type: string enum: - gcp_databricks - type: string enum: - azuread - type: string enum: - auth0 - type: string enum: - adfs - type: string enum: - okta - type: string enum: - ping - type: string enum: - snowflake - type: string enum: - unknown type: 'null' description: OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown. usePkce: type: - boolean - 'null' description: Whether the OAuth flow should require Proof Key for Code Exchange (PKCE). Databricks-hosted OAuth providers require PKCE. useJwt: type: - boolean - 'null' description: Whether the OAuth flow should use JWT bearer token authentication instead of a client secret. - type: object properties: exportsWarehouse: type: string description: Warehouse to use for export workloads. writeAccess: oneOf: - allOf: - type: object required: - writeDatabase - writeSchema properties: writeDatabase: type: string description: Database or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform - type: object properties: materializationWarehouse: type: string description: Warehouse to use for materialization workloads useDynamicTables: type: boolean description: Whether to use Snowflake dynamic tables for materialization workloads. description: '' title: Set write location and materialization warehouse - type: object properties: materializationWarehouse: type: string description: Warehouse to use for materialization workloads useDynamicTables: type: boolean description: Whether to use Snowflake dynamic tables for materialization workloads. description: '' title: Set materialization warehouse description: Specify write access for non-OAuth connections userAttributes: type: object properties: role: type: string warehouse: type: string writebackSchemas: type: array items: allOf: - type: object required: - writeDatabase - writeSchema properties: writeDatabase: type: string description: Database or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform - type: object properties: writebackSchemaId: type: string description: Unique identifier of the write-back destination description: type: string description: Description for the write-back destination. description: Configure write-back for OAuth connections inputTableAuditLogSchema: allOf: - type: object required: - writeDatabase - writeSchema properties: writeDatabase: type: string description: Database or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform - type: object properties: writebackSchemaId: type: string description: Unique identifier of the writebackSchema description: Specify a schema for input table write access logs pythonProperties: type: object properties: externalAccessIntegration: type: string description: Name of the Snowflake external access integration to enable for Python. warehouse: type: string description: Warehouse to use to run Python code. packages: type: string description: Comma-separated list of Python packages to install. description: Python configuration for this Snowflake connection. roleSwitching: type: string enum: - allRoles - disabled description: Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful when `useOauth` is true. description: Details of the Snowflake connection. title: Snowflake - allOf: - allOf: - type: object required: - type - host properties: type: type: string enum: - databricks host: type: string - oneOf: - type: object required: - endpoint properties: endpoint: type: string - type: object required: - userAttributes properties: userAttributes: type: object required: - endpoint properties: endpoint: type: string - oneOf: - type: object required: - token properties: token: oneOf: - type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string description: Set up basic authentication for the connection title: Basic Authentication - type: object required: - useOauth properties: useOauth: type: boolean enum: - true description: Set up OAuth for the connection title: OAuth - type: object properties: workspaceUrl: type: string useSourceSwapPolicy: type: boolean sourceSwapPolicyId: type: string - type: object properties: metadataUrl: type: string description: OAuth metadata URL for connection-level OAuth. clientId: type: string description: Client ID for the OAuth application used by this connection. clientSecret: oneOf: - type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string description: Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API. scopes: type: array items: type: string description: OAuth scopes to request when users authenticate to this connection. idpType: oneOf: - type: string enum: - aws_databricks - type: string enum: - azure_databricks - type: string enum: - gcp_databricks - type: string enum: - azuread - type: string enum: - auth0 - type: string enum: - adfs - type: string enum: - okta - type: string enum: - ping - type: string enum: - snowflake - type: string enum: - unknown type: 'null' description: OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown. usePkce: type: - boolean - 'null' description: Whether the OAuth flow should require Proof Key for Code Exchange (PKCE). Databricks-hosted OAuth providers require PKCE. useJwt: type: - boolean - 'null' description: Whether the OAuth flow should use JWT bearer token authentication instead of a client secret. - type: object properties: writeAccess: type: object required: - writeCatalog - writeSchema properties: writeCatalog: type: string description: Catalog or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform description: Configure write-back for non-OAuth connections writebackSchemas: type: array items: allOf: - type: object required: - writeCatalog - writeSchema properties: writeCatalog: type: string description: Catalog or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform - type: object properties: writebackSchemaId: type: string description: Unique identifier of the write-back destination description: type: string description: Description for the write-back destination. description: Configure write-back for OAuth connections inputTableAuditLogSchema: allOf: - type: object required: - writeCatalog - writeSchema properties: writeCatalog: type: string description: Catalog or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform - type: object properties: writebackSchemaId: type: string description: Unique identifier of the writebackSchema description: Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection. description: Details of the Databricks connection. title: Databricks - allOf: - type: object required: - type - user - password - host - port properties: type: type: string enum: - mysql user: type: string password: oneOf: - type: string - type: object required: - type - value properties: type: type: string enum: - plain value: type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string host: type: string port: type: number - type: object properties: writeAccess: type: object required: - writeSchema properties: writeSchema: type: string description: Details of the MySQL connection. title: MySQL - allOf: - type: object required: - type - server - database properties: type: type: string enum: - azuresql description: Azure SQL DB connection type. server: type: string description: Fully qualified Azure SQL DB server name. database: type: string description: Database to connect to on the Azure SQL DB server. - type: object required: - server - port - user - password properties: server: type: string description: Fully qualified server name or host. port: type: number description: Port for the database server. user: type: string description: Username used to authenticate to the database. password: oneOf: - type: string - type: object required: - type - value properties: type: type: string enum: - plain value: type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string description: Password used to authenticate to the database. This value is write-only and is not returned by the API. - type: object properties: useReadUncommittedIsolation: type: boolean description: Whether queries run with READ UNCOMMITTED transaction isolation. writeAccess: type: object required: - writeDatabase - writeSchema properties: writeDatabase: type: string description: Database to contain tables written back to the data platform. writeSchema: type: string description: Schema to contain tables written back to the data platform. description: Configure write-back for the connection. description: Details of the Azure SQL DB connection. title: Azure SQL DB - allOf: - type: object required: - type properties: type: type: string enum: - sqlserver description: SQL Server connection type. - type: object required: - server - port - user - password properties: server: type: string description: Fully qualified server name or host. port: type: number description: Port for the database server. user: type: string description: Username used to authenticate to the database. password: oneOf: - type: string - type: object required: - type - value properties: type: type: string enum: - plain value: type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string description: Password used to authenticate to the database. This value is write-only and is not returned by the API. - type: object properties: useReadUncommittedIsolation: type: boolean description: Whether queries run with READ UNCOMMITTED transaction isolation. writeAccess: type: object required: - writeDatabase - writeSchema properties: writeDatabase: type: string description: Database to contain tables written back to the data platform. writeSchema: type: string description: Schema to contain tables written back to the data platform. description: Configure write-back for the connection. description: Details of the SQL Server connection. title: SQL Server - allOf: - type: object required: - type - host - port - user - password properties: type: type: string enum: - starburst description: Starburst connection type. host: type: string description: The address of your Starburst Galaxy cluster as a URL or an IP address. port: type: number description: The port through which Sigma connects to your Starburst Galaxy cluster. user: type: string description: The username of the service account set up by your Starburst administrator. password: oneOf: - type: string - type: object required: - type - value properties: type: type: string enum: - plain value: type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string description: The password for the service account set up by your Starburst administrator. This value is write-only and is not returned by the API. - type: object properties: writeAccess: type: object required: - writeCatalog - writeSchema properties: writeCatalog: type: string description: Catalog to contain tables written back to the data platform. writeSchema: type: string description: Schema to contain tables written back to the data platform. description: Configure write-back for the connection. description: Details of the Starburst connection. title: Starburst name: type: string - type: object properties: description: type: object additionalProperties: {} poolSizes: type: object properties: isPoolConfigured: type: boolean description: Whether custom connection pool sizes are configured. If any pool size is supplied without this field, the API stores it as true. adhocPoolSize: type: number description: Pool size for ad hoc query workloads. schedulePoolSize: type: number description: Pool size for scheduled workloads. catalogPoolSize: type: number description: Pool size for catalog workloads. resultPoolSize: type: number description: Pool size for result cache workloads. description: Connection pool sizes. Each pool bounds how many queries of a given type (ad hoc, scheduled, catalog, result cache) run concurrently against the warehouse. timeoutSecs: type: number useFriendlyNames: type: boolean responses: '201': description: The response body. content: application/json: schema: allOf: - type: object required: - organizationId - connectionId - isSample - isAuditLog - lastActiveAt - name - type - useOauth - createdBy - updatedBy - createdAt - updatedAt properties: organizationId: type: string description: Unique identifier of the organization connectionId: type: string description: Unique identifier of the connection isSample: type: boolean description: Whether the connection is the Sigma sample data connection isAuditLog: type: boolean description: Whether audit logging is enabled lastActiveAt: type: string format: date-time description: Last activity date and time name: type: string description: Name of the connection type: type: string description: Type of the connection (e.g., "bigQuery") useOauth: type: boolean description: Whether OAuth is used createdBy: type: string description: Identifier of the user who created this connection updatedBy: type: string description: Identifier of the user or process that last updated this connection createdAt: type: string format: date-time description: When the connection was created updatedAt: type: string format: date-time description: When the connection was last updated - type: object properties: isArchived: type: boolean description: Whether the connection is archived account: type: string description: Account associated with the connection warehouse: type: string description: Warehouse associated with the connection user: type: string description: User associated with the connection role: type: string description: Role used by the connection user timeout: allOf: - type: object required: - default properties: default: type: number - type: object properties: worksheet: type: number dashboard: type: number download: type: number description: Timeout settings for the connection, with a default value in seconds poolSizes: type: object properties: isPoolConfigured: type: boolean adhocPoolSize: type: number catalogPoolSize: type: number resultPoolSize: type: number schedulePoolSize: type: number description: Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize writeAccess: type: boolean friendlyName: type: boolean description: Whether friendly names are enabled for this connection writebacks: type: array items: allOf: - allOf: - type: object required: - database - schema properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform - type: object properties: writebackSchemaId: type: string description: Unique identifier of the writebackSchema - type: object properties: description: type: string description: Description for the write-back destination. description: Configure write-back for non-OAuth connections writebackSchemas: type: array items: allOf: - allOf: - type: object required: - database - schema properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform - type: object properties: writebackSchemaId: type: string description: Unique identifier of the writebackSchema - type: object properties: description: type: string description: Description for the write-back destination. description: Configure write-back for OAuth connections inputTableAuditLogSchema: allOf: - type: object required: - database - schema properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform - type: object properties: writebackSchemaId: type: string description: Unique identifier of the writebackSchema description: Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection. materializationWarehouse: type: string description: Warehouse used to run materialization jobs exportsWarehouse: type: string description: Warehouse used to run export jobs oauthMetadataUrl: type: string description: OAuth metadata URL configured directly on this connection. oauthClientId: type: string description: Client ID configured directly on this connection. oauthScopes: type: array items: type: string description: OAuth scopes configured directly on this connection. oauthIdpType: oneOf: - type: string enum: - aws_databricks - type: string enum: - azure_databricks - type: string enum: - gcp_databricks - type: string enum: - azuread - type: string enum: - auth0 - type: string enum: - adfs - type: string enum: - okta - type: string enum: - ping - type: string enum: - snowflake - type: string enum: - unknown description: OAuth provider type configured or inferred for this connection. oauthUsePkce: type: - boolean - 'null' description: Whether this connection-level OAuth configuration uses PKCE. oauthUseJwt: type: - boolean - 'null' description: Whether this connection-level OAuth configuration uses JWT bearer token authentication. oauthAudience: type: string description: Audience used for OAuth federation, such as the Google workforce identity federation audience for BigQuery. isIndependentOAuth: type: boolean description: Whether this connection uses connection-level OAuth instead of organization-level OAuth. userAttributes: type: object properties: role: type: string warehouse: type: string description: User attributes associated with the connection roleSwitching: type: string enum: - allRoles - disabled description: Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful for Snowflake OAuth connections. default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - connections security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/connections/{connectionId}: patch: summary: Update a connection description: Update the metadata of a specific connection. This endpoint is deprecated. Instead, use the [PUT endpoint](https://help.sigmacomputing.com/reference/updateconnection). parameters: - name: connectionId schema: type: string in: path required: true operationId: updateConnectionDeprecated requestBody: description: The request body. content: application/json: schema: type: object properties: name: type: string useOauth: type: boolean responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - organizationId - connectionId - isSample - isAuditLog - lastActiveAt - name - type - useOauth - createdBy - updatedBy - createdAt - updatedAt properties: organizationId: type: string description: Unique identifier of the organization connectionId: type: string description: Unique identifier of the connection isSample: type: boolean description: Whether the connection is the Sigma sample data connection isAuditLog: type: boolean description: Whether audit logging is enabled lastActiveAt: type: string format: date-time description: Last activity date and time name: type: string description: Name of the connection type: type: string description: Type of the connection (e.g., "bigQuery") useOauth: type: boolean description: Whether OAuth is used createdBy: type: string description: Identifier of the user who created this connection updatedBy: type: string description: Identifier of the user or process that last updated this connection createdAt: type: string format: date-time description: When the connection was created updatedAt: type: string format: date-time description: When the connection was last updated - type: object properties: isArchived: type: boolean description: Whether the connection is archived account: type: string description: Account associated with the connection warehouse: type: string description: Warehouse associated with the connection user: type: string description: User associated with the connection role: type: string description: Role used by the connection user timeout: allOf: - type: object required: - default properties: default: type: number - type: object properties: worksheet: type: number dashboard: type: number download: type: number description: Timeout settings for the connection, with a default value in seconds poolSizes: type: object properties: isPoolConfigured: type: boolean adhocPoolSize: type: number catalogPoolSize: type: number resultPoolSize: type: number schedulePoolSize: type: number description: Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize writeAccess: type: boolean friendlyName: type: boolean description: Whether friendly names are enabled for this connection writebacks: type: array items: allOf: - allOf: - type: object required: - database - schema properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform - type: object properties: writebackSchemaId: type: string description: Unique identifier of the writebackSchema - type: object properties: description: type: string description: Description for the write-back destination. description: Configure write-back for non-OAuth connections writebackSchemas: type: array items: allOf: - allOf: - type: object required: - database - schema properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform - type: object properties: writebackSchemaId: type: string description: Unique identifier of the writebackSchema - type: object properties: description: type: string description: Description for the write-back destination. description: Configure write-back for OAuth connections inputTableAuditLogSchema: allOf: - type: object required: - database - schema properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform - type: object properties: writebackSchemaId: type: string description: Unique identifier of the writebackSchema description: Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection. materializationWarehouse: type: string description: Warehouse used to run materialization jobs exportsWarehouse: type: string description: Warehouse used to run export jobs oauthMetadataUrl: type: string description: OAuth metadata URL configured directly on this connection. oauthClientId: type: string description: Client ID configured directly on this connection. oauthScopes: type: array items: type: string description: OAuth scopes configured directly on this connection. oauthIdpType: oneOf: - type: string enum: - aws_databricks - type: string enum: - azure_databricks - type: string enum: - gcp_databricks - type: string enum: - azuread - type: string enum: - auth0 - type: string enum: - adfs - type: string enum: - okta - type: string enum: - ping - type: string enum: - snowflake - type: string enum: - unknown description: OAuth provider type configured or inferred for this connection. oauthUsePkce: type: - boolean - 'null' description: Whether this connection-level OAuth configuration uses PKCE. oauthUseJwt: type: - boolean - 'null' description: Whether this connection-level OAuth configuration uses JWT bearer token authentication. oauthAudience: type: string description: Audience used for OAuth federation, such as the Google workforce identity federation audience for BigQuery. isIndependentOAuth: type: boolean description: Whether this connection uses connection-level OAuth instead of organization-level OAuth. userAttributes: type: object properties: role: type: string warehouse: type: string description: User attributes associated with the connection roleSwitching: type: string enum: - allRoles - disabled description: Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful for Snowflake OAuth connections. default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - connections deprecated: true security: - oauth2: [] get: summary: Get connection details description: "Get the metadata of a specific connection by connection ID.\n\n### Usage notes\n- Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n " parameters: - name: connectionId schema: type: string in: path required: true operationId: getConnection responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - organizationId - connectionId - isSample - isAuditLog - lastActiveAt - name - type - useOauth - createdBy - updatedBy - createdAt - updatedAt properties: organizationId: type: string description: Unique identifier of the organization connectionId: type: string description: Unique identifier of the connection isSample: type: boolean description: Whether the connection is the Sigma sample data connection isAuditLog: type: boolean description: Whether audit logging is enabled lastActiveAt: type: string format: date-time description: Last activity date and time name: type: string description: Name of the connection type: type: string description: Type of the connection (e.g., "bigQuery") useOauth: type: boolean description: Whether OAuth is used createdBy: type: string description: Identifier of the user who created this connection updatedBy: type: string description: Identifier of the user or process that last updated this connection createdAt: type: string format: date-time description: When the connection was created updatedAt: type: string format: date-time description: When the connection was last updated - type: object properties: isArchived: type: boolean description: Whether the connection is archived account: type: string description: Account associated with the connection warehouse: type: string description: Warehouse associated with the connection user: type: string description: User associated with the connection role: type: string description: Role used by the connection user timeout: allOf: - type: object required: - default properties: default: type: number - type: object properties: worksheet: type: number dashboard: type: number download: type: number description: Timeout settings for the connection, with a default value in seconds poolSizes: type: object properties: isPoolConfigured: type: boolean adhocPoolSize: type: number catalogPoolSize: type: number resultPoolSize: type: number schedulePoolSize: type: number description: Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize writeAccess: type: boolean friendlyName: type: boolean description: Whether friendly names are enabled for this connection writebacks: type: array items: allOf: - allOf: - type: object required: - database - schema properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform - type: object properties: writebackSchemaId: type: string description: Unique identifier of the writebackSchema - type: object properties: description: type: string description: Description for the write-back destination. description: Configure write-back for non-OAuth connections writebackSchemas: type: array items: allOf: - allOf: - type: object required: - database - schema properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform - type: object properties: writebackSchemaId: type: string description: Unique identifier of the writebackSchema - type: object properties: description: type: string description: Description for the write-back destination. description: Configure write-back for OAuth connections inputTableAuditLogSchema: allOf: - type: object required: - database - schema properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform - type: object properties: writebackSchemaId: type: string description: Unique identifier of the writebackSchema description: Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection. materializationWarehouse: type: string description: Warehouse used to run materialization jobs exportsWarehouse: type: string description: Warehouse used to run export jobs oauthMetadataUrl: type: string description: OAuth metadata URL configured directly on this connection. oauthClientId: type: string description: Client ID configured directly on this connection. oauthScopes: type: array items: type: string description: OAuth scopes configured directly on this connection. oauthIdpType: oneOf: - type: string enum: - aws_databricks - type: string enum: - azure_databricks - type: string enum: - gcp_databricks - type: string enum: - azuread - type: string enum: - auth0 - type: string enum: - adfs - type: string enum: - okta - type: string enum: - ping - type: string enum: - snowflake - type: string enum: - unknown description: OAuth provider type configured or inferred for this connection. oauthUsePkce: type: - boolean - 'null' description: Whether this connection-level OAuth configuration uses PKCE. oauthUseJwt: type: - boolean - 'null' description: Whether this connection-level OAuth configuration uses JWT bearer token authentication. oauthAudience: type: string description: Audience used for OAuth federation, such as the Google workforce identity federation audience for BigQuery. isIndependentOAuth: type: boolean description: Whether this connection uses connection-level OAuth instead of organization-level OAuth. userAttributes: type: object properties: role: type: string warehouse: type: string description: User attributes associated with the connection roleSwitching: type: string enum: - allRoles - disabled description: Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful for Snowflake OAuth connections. default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - connections security: - oauth2: [] delete: summary: Delete a connection description: "Delete a specific connection by connection ID.\n\n ### Usage notes\n - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n " parameters: - name: connectionId schema: type: string in: path required: true operationId: deleteConnection responses: '200': description: The response body. content: application/json: schema: type: object properties: {} default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - connections security: - oauth2: [] put: summary: Update a connection description: "Update a specific connection by connection ID. When updating the connection, send any connection details that you want to keep. Retrieve the current state of a connection by calling the [/v2/connections/{connectionId}](https://help.sigmacomputing.com/reference/get-connection) endpoint.\n\n ### Usage notes\n - To restore a deleted connection, pass the `restore` parameter.\n - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n\n " parameters: - name: connectionId schema: type: string in: path required: true operationId: updateConnection requestBody: description: The request body. content: application/json: schema: allOf: - allOf: - type: object required: - details - name properties: details: oneOf: - allOf: - type: object required: - type - host - database properties: type: type: string enum: - postgres - redshift - alloydb host: type: string database: type: string - type: object properties: user: type: string password: oneOf: - type: string - type: object required: - type - value properties: type: type: string enum: - plain value: type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string port: type: number useTls: type: boolean writeAccess: type: object required: - writeSchema properties: writeSchema: type: string description: Details of the PostgreSQL connection. title: PostgreSQL - allOf: - allOf: - type: object required: - type - projectId properties: type: type: string enum: - bigQuery projectId: type: string - type: object properties: additionalProjectIds: type: array items: type: string serviceAccount: oneOf: - type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string - type: object properties: metadataUrl: type: string description: OAuth metadata URL for connection-level OAuth. clientId: type: string description: Client ID for the OAuth application used by this connection. clientSecret: oneOf: - type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string description: Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API. scopes: type: array items: type: string description: OAuth scopes to request when users authenticate to this connection. idpType: oneOf: - type: string enum: - aws_databricks - type: string enum: - azure_databricks - type: string enum: - gcp_databricks - type: string enum: - azuread - type: string enum: - auth0 - type: string enum: - adfs - type: string enum: - okta - type: string enum: - ping - type: string enum: - snowflake - type: string enum: - unknown type: 'null' description: OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown. usePkce: type: - boolean - 'null' description: Whether the OAuth flow should require Proof Key for Code Exchange (PKCE). Databricks-hosted OAuth providers require PKCE. useJwt: type: - boolean - 'null' description: Whether the OAuth flow should use JWT bearer token authentication instead of a client secret. - type: object properties: useOauth: type: boolean description: Whether this BigQuery connection uses OAuth federation. audience: type: string description: Google workforce identity federation audience used to exchange the OAuth token for a Google access token. writeAccess: type: object required: - writeProject - writeDataset properties: writeProject: type: string writeDataset: type: string description: Details of the BigQuery connection. title: Google BigQuery - allOf: - allOf: - type: object required: - type properties: type: type: string enum: - snowflake - type: object properties: server: type: string account: type: string host: type: string warehouse: type: string role: type: string authType: type: string enum: - basic-auth - key-pair - oauth - oneOf: - type: object required: - user - password properties: user: type: string password: oneOf: - type: string - type: object required: - type - value properties: type: type: string enum: - plain value: type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string description: Set up basic authentication for the connection title: Basic Authentication - allOf: - type: object required: - user - privateKey properties: user: type: string privateKey: oneOf: - type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string - type: object properties: privateKeyPassphrase: oneOf: - type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string description: Set up key-pair authentication for the connection title: Key-Pair Authentication - type: object required: - useOauth properties: useOauth: type: boolean enum: - true description: Set up OAuth for the connection title: OAuth - type: object properties: usePython: type: boolean pythonSecrets: type: object properties: setupUser: allOf: - type: object required: - username - password properties: username: type: string password: type: string - type: object properties: role: type: string pythonUser: allOf: - type: object required: - username - password properties: username: type: string password: type: string - type: object properties: role: type: string pythonProperties: type: object properties: serviceNames: type: array items: type: string externalAccessIntegration: type: string - type: object properties: useSourceSwapPolicy: type: boolean sourceSwapPolicyId: type: string - type: object properties: metadataUrl: type: string description: OAuth metadata URL for connection-level OAuth. clientId: type: string description: Client ID for the OAuth application used by this connection. clientSecret: oneOf: - type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string description: Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API. scopes: type: array items: type: string description: OAuth scopes to request when users authenticate to this connection. idpType: oneOf: - type: string enum: - aws_databricks - type: string enum: - azure_databricks - type: string enum: - gcp_databricks - type: string enum: - azuread - type: string enum: - auth0 - type: string enum: - adfs - type: string enum: - okta - type: string enum: - ping - type: string enum: - snowflake - type: string enum: - unknown type: 'null' description: OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown. usePkce: type: - boolean - 'null' description: Whether the OAuth flow should require Proof Key for Code Exchange (PKCE). Databricks-hosted OAuth providers require PKCE. useJwt: type: - boolean - 'null' description: Whether the OAuth flow should use JWT bearer token authentication instead of a client secret. - type: object properties: exportsWarehouse: type: string description: Warehouse to use for export workloads. writeAccess: oneOf: - allOf: - type: object required: - writeDatabase - writeSchema properties: writeDatabase: type: string description: Database or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform - type: object properties: materializationWarehouse: type: string description: Warehouse to use for materialization workloads useDynamicTables: type: boolean description: Whether to use Snowflake dynamic tables for materialization workloads. description: '' title: Set write location and materialization warehouse - type: object properties: materializationWarehouse: type: string description: Warehouse to use for materialization workloads useDynamicTables: type: boolean description: Whether to use Snowflake dynamic tables for materialization workloads. description: '' title: Set materialization warehouse description: Specify write access for non-OAuth connections userAttributes: type: object properties: role: type: string warehouse: type: string writebackSchemas: type: array items: allOf: - type: object required: - writeDatabase - writeSchema properties: writeDatabase: type: string description: Database or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform - type: object properties: writebackSchemaId: type: string description: Unique identifier of the write-back destination description: type: string description: Description for the write-back destination. description: Configure write-back for OAuth connections inputTableAuditLogSchema: allOf: - type: object required: - writeDatabase - writeSchema properties: writeDatabase: type: string description: Database or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform - type: object properties: writebackSchemaId: type: string description: Unique identifier of the writebackSchema description: Specify a schema for input table write access logs pythonProperties: type: object properties: externalAccessIntegration: type: string description: Name of the Snowflake external access integration to enable for Python. warehouse: type: string description: Warehouse to use to run Python code. packages: type: string description: Comma-separated list of Python packages to install. description: Python configuration for this Snowflake connection. roleSwitching: type: string enum: - allRoles - disabled description: Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful when `useOauth` is true. description: Details of the Snowflake connection. title: Snowflake - allOf: - allOf: - type: object required: - type - host properties: type: type: string enum: - databricks host: type: string - oneOf: - type: object required: - endpoint properties: endpoint: type: string - type: object required: - userAttributes properties: userAttributes: type: object required: - endpoint properties: endpoint: type: string - oneOf: - type: object required: - token properties: token: oneOf: - type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string description: Set up basic authentication for the connection title: Basic Authentication - type: object required: - useOauth properties: useOauth: type: boolean enum: - true description: Set up OAuth for the connection title: OAuth - type: object properties: workspaceUrl: type: string useSourceSwapPolicy: type: boolean sourceSwapPolicyId: type: string - type: object properties: metadataUrl: type: string description: OAuth metadata URL for connection-level OAuth. clientId: type: string description: Client ID for the OAuth application used by this connection. clientSecret: oneOf: - type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string description: Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API. scopes: type: array items: type: string description: OAuth scopes to request when users authenticate to this connection. idpType: oneOf: - type: string enum: - aws_databricks - type: string enum: - azure_databricks - type: string enum: - gcp_databricks - type: string enum: - azuread - type: string enum: - auth0 - type: string enum: - adfs - type: string enum: - okta - type: string enum: - ping - type: string enum: - snowflake - type: string enum: - unknown type: 'null' description: OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown. usePkce: type: - boolean - 'null' description: Whether the OAuth flow should require Proof Key for Code Exchange (PKCE). Databricks-hosted OAuth providers require PKCE. useJwt: type: - boolean - 'null' description: Whether the OAuth flow should use JWT bearer token authentication instead of a client secret. - type: object properties: writeAccess: type: object required: - writeCatalog - writeSchema properties: writeCatalog: type: string description: Catalog or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform description: Configure write-back for non-OAuth connections writebackSchemas: type: array items: allOf: - type: object required: - writeCatalog - writeSchema properties: writeCatalog: type: string description: Catalog or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform - type: object properties: writebackSchemaId: type: string description: Unique identifier of the write-back destination description: type: string description: Description for the write-back destination. description: Configure write-back for OAuth connections inputTableAuditLogSchema: allOf: - type: object required: - writeCatalog - writeSchema properties: writeCatalog: type: string description: Catalog or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform - type: object properties: writebackSchemaId: type: string description: Unique identifier of the writebackSchema description: Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection. description: Details of the Databricks connection. title: Databricks - allOf: - type: object required: - type - user - password - host - port properties: type: type: string enum: - mysql user: type: string password: oneOf: - type: string - type: object required: - type - value properties: type: type: string enum: - plain value: type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string host: type: string port: type: number - type: object properties: writeAccess: type: object required: - writeSchema properties: writeSchema: type: string description: Details of the MySQL connection. title: MySQL - allOf: - type: object required: - type - server - database properties: type: type: string enum: - azuresql description: Azure SQL DB connection type. server: type: string description: Fully qualified Azure SQL DB server name. database: type: string description: Database to connect to on the Azure SQL DB server. - type: object required: - server - port - user - password properties: server: type: string description: Fully qualified server name or host. port: type: number description: Port for the database server. user: type: string description: Username used to authenticate to the database. password: oneOf: - type: string - type: object required: - type - value properties: type: type: string enum: - plain value: type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string description: Password used to authenticate to the database. This value is write-only and is not returned by the API. - type: object properties: useReadUncommittedIsolation: type: boolean description: Whether queries run with READ UNCOMMITTED transaction isolation. writeAccess: type: object required: - writeDatabase - writeSchema properties: writeDatabase: type: string description: Database to contain tables written back to the data platform. writeSchema: type: string description: Schema to contain tables written back to the data platform. description: Configure write-back for the connection. description: Details of the Azure SQL DB connection. title: Azure SQL DB - allOf: - type: object required: - type properties: type: type: string enum: - sqlserver description: SQL Server connection type. - type: object required: - server - port - user - password properties: server: type: string description: Fully qualified server name or host. port: type: number description: Port for the database server. user: type: string description: Username used to authenticate to the database. password: oneOf: - type: string - type: object required: - type - value properties: type: type: string enum: - plain value: type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string description: Password used to authenticate to the database. This value is write-only and is not returned by the API. - type: object properties: useReadUncommittedIsolation: type: boolean description: Whether queries run with READ UNCOMMITTED transaction isolation. writeAccess: type: object required: - writeDatabase - writeSchema properties: writeDatabase: type: string description: Database to contain tables written back to the data platform. writeSchema: type: string description: Schema to contain tables written back to the data platform. description: Configure write-back for the connection. description: Details of the SQL Server connection. title: SQL Server - allOf: - type: object required: - type - host - port - user - password properties: type: type: string enum: - starburst description: Starburst connection type. host: type: string description: The address of your Starburst Galaxy cluster as a URL or an IP address. port: type: number description: The port through which Sigma connects to your Starburst Galaxy cluster. user: type: string description: The username of the service account set up by your Starburst administrator. password: oneOf: - type: string - type: object required: - type - value properties: type: type: string enum: - plain value: type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string description: The password for the service account set up by your Starburst administrator. This value is write-only and is not returned by the API. - type: object properties: writeAccess: type: object required: - writeCatalog - writeSchema properties: writeCatalog: type: string description: Catalog to contain tables written back to the data platform. writeSchema: type: string description: Schema to contain tables written back to the data platform. description: Configure write-back for the connection. description: Details of the Starburst connection. title: Starburst name: type: string - type: object properties: description: type: object additionalProperties: {} poolSizes: type: object properties: isPoolConfigured: type: boolean description: Whether custom connection pool sizes are configured. If any pool size is supplied without this field, the API stores it as true. adhocPoolSize: type: number description: Pool size for ad hoc query workloads. schedulePoolSize: type: number description: Pool size for scheduled workloads. catalogPoolSize: type: number description: Pool size for catalog workloads. resultPoolSize: type: number description: Pool size for result cache workloads. description: Connection pool sizes. Each pool bounds how many queries of a given type (ad hoc, scheduled, catalog, result cache) run concurrently against the warehouse. timeoutSecs: type: number useFriendlyNames: type: boolean - type: object properties: restore: type: boolean responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - organizationId - connectionId - isSample - isAuditLog - lastActiveAt - name - type - useOauth - createdBy - updatedBy - createdAt - updatedAt properties: organizationId: type: string description: Unique identifier of the organization connectionId: type: string description: Unique identifier of the connection isSample: type: boolean description: Whether the connection is the Sigma sample data connection isAuditLog: type: boolean description: Whether audit logging is enabled lastActiveAt: type: string format: date-time description: Last activity date and time name: type: string description: Name of the connection type: type: string description: Type of the connection (e.g., "bigQuery") useOauth: type: boolean description: Whether OAuth is used createdBy: type: string description: Identifier of the user who created this connection updatedBy: type: string description: Identifier of the user or process that last updated this connection createdAt: type: string format: date-time description: When the connection was created updatedAt: type: string format: date-time description: When the connection was last updated - type: object properties: isArchived: type: boolean description: Whether the connection is archived account: type: string description: Account associated with the connection warehouse: type: string description: Warehouse associated with the connection user: type: string description: User associated with the connection role: type: string description: Role used by the connection user timeout: allOf: - type: object required: - default properties: default: type: number - type: object properties: worksheet: type: number dashboard: type: number download: type: number description: Timeout settings for the connection, with a default value in seconds poolSizes: type: object properties: isPoolConfigured: type: boolean adhocPoolSize: type: number catalogPoolSize: type: number resultPoolSize: type: number schedulePoolSize: type: number description: Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize writeAccess: type: boolean friendlyName: type: boolean description: Whether friendly names are enabled for this connection writebacks: type: array items: allOf: - allOf: - type: object required: - database - schema properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform - type: object properties: writebackSchemaId: type: string description: Unique identifier of the writebackSchema - type: object properties: description: type: string description: Description for the write-back destination. description: Configure write-back for non-OAuth connections writebackSchemas: type: array items: allOf: - allOf: - type: object required: - database - schema properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform - type: object properties: writebackSchemaId: type: string description: Unique identifier of the writebackSchema - type: object properties: description: type: string description: Description for the write-back destination. description: Configure write-back for OAuth connections inputTableAuditLogSchema: allOf: - type: object required: - database - schema properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform - type: object properties: writebackSchemaId: type: string description: Unique identifier of the writebackSchema description: Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection. materializationWarehouse: type: string description: Warehouse used to run materialization jobs exportsWarehouse: type: string description: Warehouse used to run export jobs oauthMetadataUrl: type: string description: OAuth metadata URL configured directly on this connection. oauthClientId: type: string description: Client ID configured directly on this connection. oauthScopes: type: array items: type: string description: OAuth scopes configured directly on this connection. oauthIdpType: oneOf: - type: string enum: - aws_databricks - type: string enum: - azure_databricks - type: string enum: - gcp_databricks - type: string enum: - azuread - type: string enum: - auth0 - type: string enum: - adfs - type: string enum: - okta - type: string enum: - ping - type: string enum: - snowflake - type: string enum: - unknown description: OAuth provider type configured or inferred for this connection. oauthUsePkce: type: - boolean - 'null' description: Whether this connection-level OAuth configuration uses PKCE. oauthUseJwt: type: - boolean - 'null' description: Whether this connection-level OAuth configuration uses JWT bearer token authentication. oauthAudience: type: string description: Audience used for OAuth federation, such as the Google workforce identity federation audience for BigQuery. isIndependentOAuth: type: boolean description: Whether this connection uses connection-level OAuth instead of organization-level OAuth. userAttributes: type: object properties: role: type: string warehouse: type: string description: User attributes associated with the connection roleSwitching: type: string enum: - allRoles - disabled description: Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful for Snowflake OAuth connections. default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - connections security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/connections/{connectionId}/dbtArtifacts: post: summary: Add dbt metadata for a connection description: "Add dbt run artifacts for a given connection. For more details, see [Configure dbt Core integration](/docs/manage-dbt-integration#configure-dbt-core-integration-beta).\n\n ### Usage notes\n - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n - Create a tar.gz file containing the target directory of your dbt project that contains run artifacts.\n - Provide the file in the request with the field name 'artifacts'.\n " parameters: - name: connectionId schema: type: string description: Unique identifier of the connection title: Connection ID in: path required: true operationId: postConnectionDbtArtifacts requestBody: description: The request body. content: multipart/form-data: schema: type: object required: - artifacts properties: artifacts: type: string format: binary description: Compressed (tar.gz) file containing the artifacts of a dbt run. title: dbt run artifacts responses: '201': description: The response body. content: application/json: schema: type: object properties: {} default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - connections security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/connections/{connectionId}/grants: post: summary: Add grants to a connection description: "Add grants to grant permissions on a connection to specific users or teams.\n\n ### Usage notes\n - See [Data permissions overview](https://help.sigmacomputing.com/docs/data-permissions-overview) for details about permissions that can be granted on a connection.\n - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n - Specify the team or user IDs to grant permissions:\n\n - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n - Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n\n ### Usage scenarios\n - Grant a specific team `Can use` access to a connection. " parameters: - name: connectionId schema: type: string in: path required: true operationId: createConnectionGrant requestBody: description: The request body. content: application/json: schema: type: object required: - grants properties: grants: type: array items: type: object required: - grantee - permission properties: grantee: oneOf: - type: object required: - memberId properties: memberId: type: string description: The UUID of the member receiving the grant title: Member - type: object required: - teamId properties: teamId: type: string description: The UUID of the team receiving the grant title: Team permission: type: string enum: - annotate - usage description: Connection permissions of Can Use & Annotate and Can Use. title: Connection permissions title: Connection grant creation request responses: '200': description: The response body. content: application/json: schema: type: object properties: {} default: $ref: '#/components/responses/ApiError' externalDocs: url: https://help.sigmacomputing.com/docs/manage-data-permissions description: 'Sigma API documentation:' tags: - connections security: - oauth2: [] get: summary: List grants for a connection description: "Get a list of permissions granted to users or teams on a specific connection.\n\n### Usage notes\n- Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n " parameters: - name: connectionId schema: type: string in: path required: true - name: page schema: type: string description: Use to specify further pages using the string returned in the nextPage portion of the response. title: Page in: query - name: limit schema: type: number description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results. title: Limit in: query operationId: listConnectionGrants responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - entries - nextPage properties: entries: type: array items: type: object required: - grantId - inodeId - organizationId - memberId - teamId - permission - createdBy - updatedBy - createdAt - updatedAt properties: grantId: type: string description: The unique identifier of the grant inodeId: type: string description: The unique identifier of the inode organizationId: type: string description: The unique identifier of the organization memberId: type: - string - 'null' description: The unique identifier of the member teamId: type: - string - 'null' description: The unique identifier of the team permission: oneOf: - type: string enum: - admin - annotate - update - usage - writeback description: 'Valid inode types: table, connection database, and connection schema.' title: Connection Permission - type: string enum: - create - annotate - organize - explore - view - edit - apply description: 'Valid inode types: folder, workspace, workbook, dataset, and data model. Can Contribute permissions are listed as **organize** and Can Manage permissions are listed as **edit**.' title: Inode Permission - type: string enum: - view - edit - apply description: 'Valid inode types: version tag.' title: Version Tag Permission description: The permission granted to the member createdBy: type: string description: The identifier of the user who created this grant updatedBy: type: string description: The identifier of the user or process that last updated this grant createdAt: type: string format: date-time description: When the grant was created updatedAt: type: string format: date-time description: When the grant was last updated title: Connection grant response description: Array of results returned by the endpoint nextPage: type: - string - 'null' description: Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`. - type: object properties: total: type: number description: Total number of results. Useful to determine if there is a need to paginate. hasMore: type: boolean description: '**[Deprecated]** Indicates whether more results are available.' default: $ref: '#/components/responses/ApiError' externalDocs: url: https://help.sigmacomputing.com/docs/manage-data-permissions description: 'Sigma API documentation:' tags: - connections security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/connections/{connectionId}/grants/{grantId}: delete: summary: Delete a grant for a connection description: "Deletes a specific permission granted on a specific connection.\n\n ### Usage notes\n - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n\n ### Usage scenarios\n - **Principle of least privilege**: Reduce the permissions granted to specific users and teams on a connection to only what is needed.\n - **User offboarding**: Remove connection permissions granted to a user that will be deactivated.\n " parameters: - name: connectionId schema: type: string in: path required: true - name: grantId schema: type: string in: path required: true operationId: deleteConnectionGrant responses: '200': description: The response body. content: application/json: schema: type: object properties: {} default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - connections security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/connections/{connectionId}/sync: post: summary: Sync a connection by path description: "\n Sync the connection for a data source to retrieve any changes from the data warehouse.\n\n ### Usage notes\n - Specify the path to a table, stored procedure, schema, or database in your data warehouse that you want to sync. To trigger a full connection sync, provide an empty path (`[]`).\n - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n - Different connections support different paths:\n\n - For a Snowflake connection, you can specify `DATABASE.SCHEMA.TABLE`, `DATABASE.SCHEMA.STORED_PROCEDURE`, or a less-specific path.\n - For Amazon Redshift, you can specify `SCHEMA.TABLE`, `SCHEMA.STORED_PROCEDURE`, or a less-specific path.\n - For Databricks, you can specify `CATALOG.SCHEMA.TABLE` or a less-specific path.\n " parameters: - name: connectionId schema: type: string in: path required: true - name: useServiceAccount schema: type: boolean description: Whether to use the OAuth connection's service account to perform the sync. in: query operationId: syncConnectionPath requestBody: description: The request body. content: application/json: schema: type: object required: - path properties: path: oneOf: - type: array minItems: 3 maxItems: 3 items: type: string description: Database name title: Database description: Represents a path of the form `DATABASE.SCHEMA.TABLE` or `DATABASE.SCHEMA.STORED_PROCEDURE`. title: Table or Object Path - type: array minItems: 2 maxItems: 2 items: type: string description: Database Name title: Database description: Represents a path of the form `DATABASE.SCHEMA`. title: Schema Path - type: array minItems: 1 maxItems: 1 items: type: string description: Database Name title: Database description: Represents a path of the form `DATABASE`. title: Database Path - type: array items: {} maxItems: 0 description: Empty path to sync the entire connection. title: Empty Path responses: '200': description: The response body. content: application/json: schema: type: object properties: {} default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - connections security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/connections/{connectionId}/test: get: summary: Test a connection description: "Test whether an existing connection allows read and write operations for the user associated with the API credentials.\n\n ### Usage notes\n - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n " parameters: - name: connectionId schema: type: string in: path required: true operationId: testConnection responses: '200': description: The response body. content: application/json: schema: type: object required: - read - write properties: read: oneOf: - type: string enum: - SUCCESS - type: string enum: - FAILED write: oneOf: - type: string enum: - DISABLED - type: string enum: - SUCCESS - type: string enum: - FAILED default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - connections security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/connections/paths: get: summary: List connection paths description: "List all paths for all connections available to the user.\n\n ### Usage notes\n - Call this endpoint to retrieve the specific databases, catalogs, schemas, and tables available to the user associated with the API credentials.\n - Pass `connectionId` to restrict results to a single connection.\n " parameters: - name: page schema: type: string description: Use to specify further pages using the string returned in the nextPage portion of the response. title: Page in: query - name: limit schema: type: number description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results. title: Limit in: query - name: connectionId schema: type: string description: Restrict results to paths within this connection. title: Connection ID in: query operationId: listConnectionPaths responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - entries - nextPage properties: entries: type: array items: type: object required: - connectionId - urlId - path properties: connectionId: type: string urlId: type: string path: oneOf: - type: array minItems: 3 maxItems: 3 items: type: string description: Database name title: Database description: Represents a path of the form `DATABASE.SCHEMA.TABLE` or `DATABASE.SCHEMA.STORED_PROCEDURE`. title: Table or Object Path - type: array minItems: 2 maxItems: 2 items: type: string description: Database Name title: Database description: Represents a path of the form `DATABASE.SCHEMA`. title: Schema Path - type: array minItems: 1 maxItems: 1 items: type: string description: Database Name title: Database description: Represents a path of the form `DATABASE`. title: Database Path - type: array items: {} maxItems: 0 description: Empty path to sync the entire connection. title: Empty Path description: Array of results returned by the endpoint nextPage: type: - string - 'null' description: Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`. - type: object properties: total: type: number description: Total number of results. Useful to determine if there is a need to paginate. hasMore: type: boolean description: '**[Deprecated]** Indicates whether more results are available.' default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - connections security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/connections/paths/{connectionPathId}/grants: post: summary: Add grants to a connection path description: "Add a grant to a specific connection path to grant permissions for users or teams.\n\n ### Usage notes\n - Retrieve the **connectionPathId** by calling the [/v2/connection/{connectionId}/lookup](https://help.sigmacomputing.com/reference/lookup-connection) endpoint and using the `inodeId` included in the response, or by calling the [/v2/connections/paths](https://help.sigmacomputing.com/reference/list-connection-paths) endpoint and using the `urlId` included in the response.\n - Specify the team or user IDs to grant permissions:\n\n - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n - Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n " parameters: - name: connectionPathId schema: type: string in: path required: true operationId: createConnectionPathGrant requestBody: description: The request body. content: application/json: schema: type: object required: - grants properties: grants: type: array items: type: object required: - grantee - permission properties: grantee: oneOf: - type: object required: - memberId properties: memberId: type: string description: The UUID of the member receiving the grant title: Member - type: object required: - teamId properties: teamId: type: string description: The UUID of the team receiving the grant title: Team permission: type: string enum: - annotate - usage title: Connection path grant creation request responses: '200': description: The response body. content: application/json: schema: type: object properties: {} default: $ref: '#/components/responses/ApiError' externalDocs: url: https://help.sigmacomputing.com/docs/manage-data-permissions description: 'Sigma API documentation:' tags: - connections security: - oauth2: [] get: summary: List grants for a connection path description: "Get a list of permissions granted to a specific connection path.\n\n ### Usage notes\n - Retrieve the **connectionPathId** by calling the [/v2/connection/{connectionId}/lookup](https://help.sigmacomputing.com/reference/lookup-connection) endpoint and using the `inodeId` included in the response, or by calling the [/v2/connections/paths](https://help.sigmacomputing.com/reference/list-connection-paths) endpoint and using the `urlId` included in the response.\n " parameters: - name: connectionPathId schema: type: string in: path required: true - name: page schema: type: string description: Use to specify further pages using the string returned in the nextPage portion of the response. title: Page in: query - name: limit schema: type: number description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results. title: Limit in: query operationId: listConnectionPathGrants responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - entries - nextPage properties: entries: type: array items: type: object required: - grantId - inodeId - organizationId - memberId - teamId - permission - createdBy - updatedBy - createdAt - updatedAt properties: grantId: type: string description: The unique identifier of the grant inodeId: type: string description: The unique identifier of the inode organizationId: type: string description: The unique identifier of the organization memberId: type: - string - 'null' description: The unique identifier of the member teamId: type: - string - 'null' description: The unique identifier of the team permission: oneOf: - type: string enum: - admin - annotate - update - usage - writeback description: 'Valid inode types: table, connection database, and connection schema.' title: Connection Permission - type: string enum: - create - annotate - organize - explore - view - edit - apply description: 'Valid inode types: folder, workspace, workbook, dataset, and data model. Can Contribute permissions are listed as **organize** and Can Manage permissions are listed as **edit**.' title: Inode Permission - type: string enum: - view - edit - apply description: 'Valid inode types: version tag.' title: Version Tag Permission description: The permission granted to the member createdBy: type: string description: The identifier of the user who created this grant updatedBy: type: string description: The identifier of the user or process that last updated this grant createdAt: type: string format: date-time description: When the grant was created updatedAt: type: string format: date-time description: When the grant was last updated title: Connection grant response nextPage: type: - string - 'null' - type: object properties: hasMore: type: boolean description: '**[Deprecated]** Indicates whether more results are available.' default: $ref: '#/components/responses/ApiError' externalDocs: url: https://help.sigmacomputing.com/docs/manage-data-permissions description: 'Sigma API documentation:' tags: - connections security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/connections/paths/{connectionPathId}/grants/{grantId}: delete: summary: Delete a grant for a connection path description: "Delete a specific permission granted to a specific connection path for a user or team.\n\n ### Usage notes\n - Retrieve the **connectionPathId** by calling the [/v2/connection/{connectionId}/lookup](https://help.sigmacomputing.com/reference/lookup-connection) endpoint and using the `inodeId` included in the response, or by calling the [/v2/connections/paths](https://help.sigmacomputing.com/reference/list-connection-paths) endpoint and using the `urlId` included in the response.\n - Retrieve the **grantId** by calling the [/v2/connections/paths/{connectionPathId}/grants](https://help.sigmacomputing.com/reference/list-connection-path-grants) endpoint.\n " parameters: - name: connectionPathId schema: type: string in: path required: true - name: grantId schema: type: string in: path required: true operationId: deleteConnectionPathGrant responses: '200': description: The response body. content: application/json: schema: type: object properties: {} default: $ref: '#/components/responses/ApiError' externalDocs: url: https://help.sigmacomputing.com/docs/manage-data-permissions description: 'Sigma API documentation:' tags: - connections security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/connections/paths/{inodeId}: get: summary: Get connection path for a table description: "Get the connection path for a specific table. If the inodeId is not for a table, this endpoint returns an error.\n\n ### Usage notes\n - Retrieve the **inodeId** by calling the [/v2/workbooks/{workbookId}/sources](https://help.sigmacomputing.com/reference/get-workbook-sources) or [/v2/datasets/{datasetId}/source](https://help.sigmacomputing.com/reference/get-dataset-sources) endpoint.\n " parameters: - name: inodeId schema: type: string in: path required: true operationId: getInodeConnectionPath responses: '200': description: The response body. content: application/json: schema: type: object required: - connectionId - path properties: connectionId: type: string path: oneOf: - type: array minItems: 3 maxItems: 3 items: type: string description: Database name title: Database description: Represents a path of the form `DATABASE.SCHEMA.TABLE` or `DATABASE.SCHEMA.STORED_PROCEDURE`. title: Table or Object Path - type: array minItems: 2 maxItems: 2 items: type: string description: Database Name title: Database description: Represents a path of the form `DATABASE.SCHEMA`. title: Schema Path - type: array minItems: 1 maxItems: 1 items: type: string description: Database Name title: Database description: Represents a path of the form `DATABASE`. title: Database Path - type: array items: {} maxItems: 0 description: Empty path to sync the entire connection. title: Empty Path default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - connections security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/connections/tables/{tableId}/columns: get: summary: List columns for a warehouse table description: 'Returns column names, types, and other details for a table in a data warehouse connection. ### Usage notes - Retrieve the **tableId** by first calling the [/v2/connections/paths](https://help.sigmacomputing.com/reference/list-connection-paths) endpoint to discover available paths, then calling the [/v2/connection/{connectionId}/lookup](https://help.sigmacomputing.com/reference/lookup-connection) endpoint with the path to the desired table and using the `inodeId` included in the response.' parameters: - name: tableId schema: type: string in: path required: true - name: pageToken schema: type: string description: Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response. title: Page token in: query - name: pageSize schema: type: integer description: Number of results to return per page, with a maximum of 1000. Defaults to 50. title: Page size in: query operationId: listConnectionTableColumns responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - entries properties: entries: type: array items: allOf: - type: object required: - name - type - visibility properties: name: type: string description: The name of the column in the warehouse table. type: type: object description: The column's data type, represented as a recursive type object. visibility: type: string enum: - included - hidden - removed description: Visibility of the column. If "included", the column is visible. If "hidden", the column is hidden but available to be used. If "removed", the column has been deleted from the table. - type: object properties: description: type: string description: The description of the column, if one has been set. description: Array of results returned by the endpoint title: Result entries - type: object properties: nextPageToken: type: string description: 'A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results. **Must be treated as an opaque string.**' title: Next page token default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - connections security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v3alpha/connections: post: summary: Create a connection (Beta) description: 'Create a connection to a cloud data warehouse from Sigma. For additional details, see [Connect to data sources](https://help.sigmacomputing.com/docs/connect-to-data-sources). **Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer. ### Usage Notes - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](https://help.sigmacomputing.com/reference/list-user-attributes) endpoint.' parameters: [] operationId: v3alpha_createConnection requestBody: description: The request body. content: application/json: schema: type: object required: - name - details properties: name: type: string title: Connection name details: oneOf: - allOf: - type: object required: - type - serverHostname - httpPath - authentication properties: type: type: string enum: - databricks description: Type of connection serverHostname: type: string description: Hostname of the Databricks compute resource httpPath: type: string description: HTTP path to connect to the Databricks SQL warehouse or cluster authentication: oneOf: - type: object required: - type - serviceAccount properties: type: type: string enum: - service-account description: Type of authentication serviceAccount: allOf: - type: object required: - type properties: type: type: string enum: - basic-auth description: Type of authentication title: Basic auth - type: object required: - accessToken properties: accessToken: oneOf: - type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string title: Access token description: Connect to Databricks using a service account. title: Service account title: Service account - allOf: - type: object required: - type - userCredential properties: type: type: string enum: - oauth description: Type of authentication userCredential: type: object required: - oauthConfig properties: oauthConfig: oneOf: - type: object required: - type properties: type: type: string enum: - organization description: Type of OAuth title: Organization-level OAuth - allOf: - type: object required: - type - scopes - metadataUri - clientId properties: type: type: string enum: - connection description: Type of OAuth scopes: type: array items: type: string description: OAuth scopes for Sigma to request from your IdP. Sigma requires the `profile`, `email`, and `openid` scopes. Sigma recommends the `offline_access` scope. title: OAuth scopes metadataUri: type: string description: Metadata URI for your OAuth authorization server title: Metadata URI clientId: type: string title: Client ID title: Connection-level OAuth configuration - type: object required: - usePkce - assertionMethod properties: usePkce: type: boolean description: PKCE-enhanced authorization is required for Databricks OAuth. title: Use PKCE assertionMethod: oneOf: - type: object required: - useJwt properties: useJwt: type: boolean enum: - true title: Use JWT Bearer Tokens - type: object required: - useJwt - clientSecret properties: useJwt: type: boolean enum: - false clientSecret: oneOf: - type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string description: Client secret for your OAuth application. title: Use Client Secret title: Connection-level OAuth description: "Choose whether to use the same OAuth configuration as the rest of your\n Sigma organization or configure OAuth specifically for this connection." title: OAuth configuration description: Connect to Databricks using OAuth. title: OAuth - type: object properties: serviceAccount: allOf: - type: object required: - type properties: type: type: string enum: - basic-auth description: Type of authentication title: Basic auth - type: object required: - accessToken properties: accessToken: oneOf: - type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string title: Access token description: Connect to Databricks using a service account. title: Service account title: OAuth description: Choose whether to use a service account or OAuth to authenticate to Databricks. - type: object properties: writeAccess: allOf: - type: object required: - writeDestinations properties: writeDestinations: type: array items: allOf: - type: object required: - destination properties: destination: type: object required: - catalog - schema properties: catalog: type: string description: Catalog name schema: type: string description: Schema name title: Destination - type: object properties: description: type: string description: Description of the write destination title: Write destination description: List of destinations where data can be written title: Write destinations - type: object properties: inputTableAuditLogDestination: type: object required: - catalog - schema properties: catalog: type: string description: Catalog name schema: type: string description: Schema name description: Audit log destination description: "Features like CSV upload, materialization, input tables, warehouse views, and\n running Python code require write access to a destination in your warehouse." title: Write access settings: allOf: - type: object properties: connectionTimeoutSecs: type: number description: Number of seconds Sigma waits for a query to return results before timing out. title: Connection timeout connectionQueueSize: type: number description: Number of queries that Sigma can concurrently run on this connection. title: Connection queue size useFriendlyNames: type: boolean description: Whether to change the column names to be more readable. For example, a column "SALES_JSON" becomes "Sales Json". Defaults to true. title: Use friendly names description: Configure specific settings for your connection. title: Settings - type: object properties: enableHiveMetastore: type: boolean description: To see and use your Hive metastore in Sigma, set to true. title: Enable Hive Metastore description: Configure specific settings for your connection title: Settings python: type: object required: - computeClusterId properties: computeClusterId: type: string description: Compute cluster ID to run Python queries title: Compute cluster ID description: Allow users to access data on this connection using Python. title: Python configuration sourceSwap: type: object required: - sourceSwapPolicyId properties: sourceSwapPolicyId: type: string description: Unique identifier of the source swap policy title: Source swap policy ID description: Specify a policy to use for dynamically swapping data sources. title: Source swap policy title: Databricks - allOf: - type: object required: - type - accountName - host - authentication properties: type: type: string enum: - snowflake description: Type of connection accountName: type: string description: Snowflake account name host: type: string description: Snowflake host authentication: oneOf: - type: object required: - type - serviceAccount - userCredential properties: type: type: string enum: - service-account description: Type of authentication serviceAccount: oneOf: - allOf: - type: object required: - type - username properties: type: type: string enum: - key-pair description: Type of authentication username: type: string description: Snowflake user name title: Key pair - type: object required: - privateKey properties: privateKey: type: string description: Private key in PEM format - type: object properties: privateKeyPassphrase: type: string description: Provide a passphrase if your private key is encrypted. title: Key pair - allOf: - type: object required: - type - username properties: type: type: string enum: - basic-auth description: Type of authentication username: type: string description: Snowflake user name title: Basic auth - type: object required: - password properties: password: type: string description: Password title: Basic auth title: Service account userCredential: allOf: - type: object required: - warehouse properties: warehouse: oneOf: - type: object required: - type - warehouse properties: type: type: string enum: - static description: Type of warehouse warehouse: type: string description: Warehouse title: Static warehouse - type: object required: - type - userAttributeId properties: type: type: string enum: - user-attribute description: Type of warehouse userAttributeId: type: string description: User attribute ID title: User attribute warehouse title: Warehouse - type: object properties: role: oneOf: - type: object required: - type - role properties: type: type: string enum: - static description: Type of role role: type: string description: If no role is provided, the service account assumes the default role as configured in Snowflake. title: Static role - type: object required: - type - userAttributeId properties: type: type: string enum: - user-attribute description: Type of role userAttributeId: type: string title: User attribute role title: Role title: User credential title: Service account - allOf: - type: object required: - type - userCredential properties: type: type: string enum: - oauth description: Type of authentication userCredential: type: object required: - oauthConfig properties: oauthConfig: oneOf: - type: object required: - type properties: type: type: string enum: - organization description: Type of OAuth title: Organization-level OAuth - allOf: - type: object required: - type - scopes - metadataUri - clientId properties: type: type: string enum: - connection description: Type of OAuth scopes: type: array items: type: string description: OAuth scopes for Sigma to request from your IdP. Sigma requires the `profile`, `email`, and `openid` scopes. Sigma recommends the `offline_access` scope. title: OAuth scopes metadataUri: type: string description: Metadata URI for your OAuth authorization server title: Metadata URI clientId: type: string title: Client ID title: Connection-level OAuth configuration - type: object required: - usePkce - assertionMethod properties: usePkce: type: boolean description: Whether to use PKCE-enhanced authorization. assertionMethod: oneOf: - type: object required: - type - clientSecret properties: type: type: string enum: - client-secret description: Type of assertion method clientSecret: type: string description: Client secret for your OAuth application. title: Use client secret - type: object required: - type properties: type: type: string enum: - jwt-bearer description: Type of assertion method title: Use JWT bearer tokens title: Connection-level OAuth description: "Choose whether to use the same OAuth configuration as the rest of your\n Sigma organization or configure OAuth specifically for this connection." title: OAuth configuration description: Connect to Snowflake using OAuth. title: OAuth - type: object properties: serviceAccount: allOf: - oneOf: - allOf: - type: object required: - type - username properties: type: type: string enum: - key-pair description: Type of authentication username: type: string description: Snowflake user name title: Key pair - type: object required: - privateKey properties: privateKey: type: string description: Private key in PEM format - type: object properties: privateKeyPassphrase: type: string description: Provide a passphrase if your private key is encrypted. title: Key pair - allOf: - type: object required: - type - username properties: type: type: string enum: - basic-auth description: Type of authentication username: type: string description: Snowflake user name title: Basic auth - type: object required: - password properties: password: type: string description: Password title: Basic auth title: Service account - type: object required: - role - warehouse properties: role: type: object required: - type - role properties: type: type: string enum: - static description: Type of role role: type: string description: If no role is provided, the service account assumes the default role as configured in Snowflake. title: Static role warehouse: type: object required: - type - warehouse properties: type: type: string enum: - static description: Type of warehouse warehouse: type: string description: Warehouse title: Static warehouse description: Configure a service account to use alongside OAuth. title: OAuth description: Choose whether to use key-pair, OAuth, or basic authentication to authenticate to Snowflake. - type: object properties: writeAccess: allOf: - type: object required: - writeDestinations properties: writeDestinations: type: array items: allOf: - type: object required: - destination properties: destination: type: object required: - database - schema properties: database: type: string description: Database name schema: type: string description: Schema name title: Destination - type: object properties: description: type: string description: Description of the write destination title: Write destination description: List of destinations where data can be written title: Write destinations - type: object properties: inputTableAuditLogDestination: type: object required: - database - schema properties: database: type: string description: Database name schema: type: string description: Schema name description: The schema where input table edits are logged. After being set, this cannot be changed without breaking write behavior on this connection. title: Input table audit log destination materializationWarehouse: type: string description: Specify a separate warehouse for materialization queries. If unset, Sigma uses the primary warehouse for this connection. useDynamicTables: type: boolean description: Enable incremental materialization for improved performance and cost efficiency. If dynamic tables cannot be used (e.g. lack of permission), Sigma will do a full table refresh. description: Features like CSV upload, materialization, input tables, warehouse views, and running Python code require write access to a destination in your warehouse. title: Write access settings: allOf: - type: object properties: connectionTimeoutSecs: type: number description: Number of seconds Sigma waits for a query to return results before timing out. title: Connection timeout connectionQueueSize: type: number description: Number of queries that Sigma can concurrently run on this connection. title: Connection queue size useFriendlyNames: type: boolean description: Whether to change the column names to be more readable. For example, a column "SALES_JSON" becomes "Sales Json". Defaults to true. title: Use friendly names description: Configure specific settings for your connection. title: Settings - type: object properties: exportWarehouse: type: string description: Specify a separate warehouse for all export queries. If unset, Sigma uses the primary warehouse for this connection. sourceSwap: type: object required: - sourceSwapPolicyId properties: sourceSwapPolicyId: type: string description: Unique identifier of the source swap policy title: Source swap policy ID description: Specify a policy to use for dynamically swapping data sources. title: Source swap policy title: Snowflake (NYI) title: Connection details title: Connection responses: '201': description: The response body. content: application/json: schema: type: object required: - connectionId - name - details properties: connectionId: type: string description: Unique identifier of the connection title: Connection ID name: type: string title: Connection name details: allOf: - type: object required: - type - serverHostname - httpPath - authentication properties: type: type: string enum: - databricks description: Type of connection serverHostname: type: string description: Hostname of the Databricks compute resource httpPath: type: string description: HTTP path to connect to the Databricks SQL warehouse or cluster authentication: oneOf: - type: object required: - type - serviceAccount properties: type: type: string enum: - service-account description: Type of authentication serviceAccount: type: object required: - type properties: type: type: string enum: - basic-auth description: Type of authentication title: Service account title: Service account - allOf: - type: object required: - type - userCredential properties: type: type: string enum: - oauth description: Type of authentication userCredential: type: object required: - oauthConfig properties: oauthConfig: oneOf: - type: object required: - type properties: type: type: string enum: - organization description: Type of OAuth title: Organization-level OAuth - allOf: - type: object required: - type - scopes - metadataUri - clientId properties: type: type: string enum: - connection description: Type of OAuth scopes: type: array items: type: string description: OAuth scopes for Sigma to request from your IdP. Sigma requires the `profile`, `email`, and `openid` scopes. Sigma recommends the `offline_access` scope. title: OAuth scopes metadataUri: type: string description: Metadata URI for your OAuth authorization server title: Metadata URI clientId: type: string title: Client ID title: Connection-level OAuth configuration - type: object required: - usePkce - useJwt properties: usePkce: type: boolean description: PKCE-enhanced authorization is required for Databricks OAuth. title: Use PKCE useJwt: type: boolean title: Use JWT title: Connection-level OAuth description: "Choose whether to use the same OAuth configuration as the rest of your\n Sigma organization or configure OAuth specifically for this connection." title: OAuth configuration title: OAuth - type: object properties: serviceAccount: type: object required: - type properties: type: type: string enum: - basic-auth description: Type of authentication title: Service account title: OAuth title: Authentication - type: object properties: writeAccess: allOf: - type: object required: - writeDestinations properties: writeDestinations: type: array items: allOf: - type: object required: - destination properties: destination: type: object required: - catalog - schema properties: catalog: type: string description: Catalog name schema: type: string description: Schema name title: Destination - type: object properties: description: type: string description: Description of the write destination title: Write destination description: List of destinations where data can be written title: Write destinations - type: object properties: inputTableAuditLogDestination: type: object required: - catalog - schema properties: catalog: type: string description: Catalog name schema: type: string description: Schema name description: Audit log destination description: "Features like CSV upload, materialization, input tables, warehouse views, and\n running Python code require write access to a destination in your warehouse." title: Write access settings: allOf: - type: object properties: connectionTimeoutSecs: type: number description: Number of seconds Sigma waits for a query to return results before timing out. title: Connection timeout connectionQueueSize: type: number description: Number of queries that Sigma can concurrently run on this connection. title: Connection queue size useFriendlyNames: type: boolean description: Whether to change the column names to be more readable. For example, a column "SALES_JSON" becomes "Sales Json". Defaults to true. title: Use friendly names description: Configure specific settings for your connection. title: Settings - type: object properties: enableHiveMetastore: type: boolean description: To see and use your Hive metastore in Sigma, set to true. title: Enable Hive Metastore description: Configure specific settings for your connection title: Settings python: type: object required: - computeClusterId properties: computeClusterId: type: string description: Compute cluster ID to run Python queries title: Compute cluster ID description: Allow users to access data on this connection using Python. title: Python configuration sourceSwap: type: object required: - sourceSwapPolicyId properties: sourceSwapPolicyId: type: string description: Unique identifier of the source swap policy title: Source swap policy ID description: Specify a policy to use for dynamically swapping data sources. title: Source swap policy title: Connection details title: Connection default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - connections security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v3alpha/connections/{connectionId}: patch: summary: Update a connection (Beta) description: 'Update a connection to a cloud data warehouse from Sigma. Only the options specified in your request are updated. Other options remain the same. **Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint. ### Usage scenarios - Remove an optional parameter by setting it to `null`. If the field has a default value, the field resets to the default. - Update a field value by providing a new value. - Leave a field unchanged by omitting it from the request. ' parameters: - name: connectionId schema: type: string description: Unique identifier of the connection title: Connection ID in: path required: true operationId: v3alpha_patchConnection requestBody: description: The request body. content: application/json: schema: type: object properties: name: type: string title: Connection name details: allOf: - type: object required: - type properties: type: type: string enum: - databricks description: Type of connection - type: object properties: serverHostname: type: string description: Hostname of the Databricks compute resource httpPath: type: string description: HTTP path to connect to the Databricks SQL warehouse or cluster authentication: oneOf: - type: object required: - type - serviceAccount properties: type: type: string enum: - service-account description: Type of authentication serviceAccount: allOf: - type: object required: - type properties: type: type: string enum: - basic-auth description: Type of authentication title: Basic auth - type: object required: - accessToken properties: accessToken: oneOf: - type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string title: Access token description: Connect to Databricks using a service account. title: Service account title: Service account - allOf: - type: object required: - type - userCredential properties: type: type: string enum: - oauth description: Type of authentication userCredential: type: object required: - oauthConfig properties: oauthConfig: oneOf: - type: object required: - type properties: type: type: string enum: - organization description: Type of OAuth title: Organization-level OAuth - allOf: - type: object required: - type - scopes - metadataUri - clientId properties: type: type: string enum: - connection description: Type of OAuth scopes: type: array items: type: string description: OAuth scopes for Sigma to request from your IdP. Sigma requires the `profile`, `email`, and `openid` scopes. Sigma recommends the `offline_access` scope. title: OAuth scopes metadataUri: type: string description: Metadata URI for your OAuth authorization server title: Metadata URI clientId: type: string title: Client ID title: Connection-level OAuth configuration - type: object required: - usePkce - assertionMethod properties: usePkce: type: boolean description: PKCE-enhanced authorization is required for Databricks OAuth. title: Use PKCE assertionMethod: oneOf: - type: object required: - useJwt properties: useJwt: type: boolean enum: - true title: Use JWT Bearer Tokens - type: object required: - useJwt - clientSecret properties: useJwt: type: boolean enum: - false clientSecret: oneOf: - type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string description: Client secret for your OAuth application. title: Use Client Secret title: Connection-level OAuth description: "Choose whether to use the same OAuth configuration as the rest of your\n Sigma organization or configure OAuth specifically for this connection." title: OAuth configuration description: Connect to Databricks using OAuth. title: OAuth - type: object properties: serviceAccount: allOf: - type: object required: - type properties: type: type: string enum: - basic-auth description: Type of authentication title: Basic auth - type: object required: - accessToken properties: accessToken: oneOf: - type: string - type: object required: - secretManagerId - secretId properties: secretManagerId: type: string secretId: type: string title: Access token description: Connect to Databricks using a service account. title: Service account type: 'null' title: OAuth description: Choose whether to use a service account or OAuth to authenticate to Databricks. writeAccess: allOf: - type: object required: - writeDestinations properties: writeDestinations: type: array items: allOf: - type: object required: - destination properties: destination: type: object required: - catalog - schema properties: catalog: type: string description: Catalog name schema: type: string description: Schema name title: Destination - type: object properties: description: type: string description: Description of the write destination title: Write destination description: List of destinations where data can be written title: Write destinations - type: object properties: inputTableAuditLogDestination: type: object required: - catalog - schema properties: catalog: type: string description: Catalog name schema: type: string description: Schema name description: Audit log destination description: "Features like CSV upload, materialization, input tables, warehouse views, and\n running Python code require write access to a destination in your warehouse." title: Write access type: 'null' settings: allOf: - type: object properties: connectionTimeoutSecs: type: number description: Number of seconds Sigma waits for a query to return results before timing out. title: Connection timeout connectionQueueSize: type: number description: Number of queries that Sigma can concurrently run on this connection. title: Connection queue size useFriendlyNames: type: boolean description: Whether to change the column names to be more readable. For example, a column "SALES_JSON" becomes "Sales Json". Defaults to true. title: Use friendly names description: Configure specific settings for your connection. title: Settings - type: object properties: enableHiveMetastore: type: boolean description: To see and use your Hive metastore in Sigma, set to true. title: Enable Hive Metastore description: Configure specific settings for your connection title: Settings type: 'null' python: type: - object - 'null' required: - computeClusterId properties: computeClusterId: type: string description: Compute cluster ID to run Python queries title: Compute cluster ID description: Allow users to access data on this connection using Python. title: Python configuration sourceSwap: type: - object - 'null' required: - sourceSwapPolicyId properties: sourceSwapPolicyId: type: string description: Unique identifier of the source swap policy title: Source swap policy ID description: Specify a policy to use for dynamically swapping data sources. title: Source swap policy title: Connection details title: Connection responses: '200': description: The response body. content: application/json: schema: type: object required: - connectionId - name - details properties: connectionId: type: string description: Unique identifier of the connection title: Connection ID name: type: string title: Connection name details: allOf: - type: object required: - type - serverHostname - httpPath - authentication properties: type: type: string enum: - databricks description: Type of connection serverHostname: type: string description: Hostname of the Databricks compute resource httpPath: type: string description: HTTP path to connect to the Databricks SQL warehouse or cluster authentication: oneOf: - type: object required: - type - serviceAccount properties: type: type: string enum: - service-account description: Type of authentication serviceAccount: type: object required: - type properties: type: type: string enum: - basic-auth description: Type of authentication title: Service account title: Service account - allOf: - type: object required: - type - userCredential properties: type: type: string enum: - oauth description: Type of authentication userCredential: type: object required: - oauthConfig properties: oauthConfig: oneOf: - type: object required: - type properties: type: type: string enum: - organization description: Type of OAuth title: Organization-level OAuth - allOf: - type: object required: - type - scopes - metadataUri - clientId properties: type: type: string enum: - connection description: Type of OAuth scopes: type: array items: type: string description: OAuth scopes for Sigma to request from your IdP. Sigma requires the `profile`, `email`, and `openid` scopes. Sigma recommends the `offline_access` scope. title: OAuth scopes metadataUri: type: string description: Metadata URI for your OAuth authorization server title: Metadata URI clientId: type: string title: Client ID title: Connection-level OAuth configuration - type: object required: - usePkce - useJwt properties: usePkce: type: boolean description: PKCE-enhanced authorization is required for Databricks OAuth. title: Use PKCE useJwt: type: boolean title: Use JWT title: Connection-level OAuth description: "Choose whether to use the same OAuth configuration as the rest of your\n Sigma organization or configure OAuth specifically for this connection." title: OAuth configuration title: OAuth - type: object properties: serviceAccount: type: object required: - type properties: type: type: string enum: - basic-auth description: Type of authentication title: Service account title: OAuth title: Authentication - type: object properties: writeAccess: allOf: - type: object required: - writeDestinations properties: writeDestinations: type: array items: allOf: - type: object required: - destination properties: destination: type: object required: - catalog - schema properties: catalog: type: string description: Catalog name schema: type: string description: Schema name title: Destination - type: object properties: description: type: string description: Description of the write destination title: Write destination description: List of destinations where data can be written title: Write destinations - type: object properties: inputTableAuditLogDestination: type: object required: - catalog - schema properties: catalog: type: string description: Catalog name schema: type: string description: Schema name description: Audit log destination description: "Features like CSV upload, materialization, input tables, warehouse views, and\n running Python code require write access to a destination in your warehouse." title: Write access settings: allOf: - type: object properties: connectionTimeoutSecs: type: number description: Number of seconds Sigma waits for a query to return results before timing out. title: Connection timeout connectionQueueSize: type: number description: Number of queries that Sigma can concurrently run on this connection. title: Connection queue size useFriendlyNames: type: boolean description: Whether to change the column names to be more readable. For example, a column "SALES_JSON" becomes "Sales Json". Defaults to true. title: Use friendly names description: Configure specific settings for your connection. title: Settings - type: object properties: enableHiveMetastore: type: boolean description: To see and use your Hive metastore in Sigma, set to true. title: Enable Hive Metastore description: Configure specific settings for your connection title: Settings python: type: object required: - computeClusterId properties: computeClusterId: type: string description: Compute cluster ID to run Python queries title: Compute cluster ID description: Allow users to access data on this connection using Python. title: Python configuration sourceSwap: type: object required: - sourceSwapPolicyId properties: sourceSwapPolicyId: type: string description: Unique identifier of the source swap policy title: Source swap policy ID description: Specify a policy to use for dynamically swapping data sources. title: Source swap policy title: Connection details title: Connection default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - connections security: - oauth2: [] get: summary: Get connection details (Beta) description: 'Get the metadata of a specific connection by connection ID. **Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.' parameters: - name: connectionId schema: type: string description: Unique identifier of the connection title: Connection ID in: path required: true operationId: v3alpha_getConnection responses: '200': description: The response body. content: application/json: schema: type: object required: - connectionId - name - details properties: connectionId: type: string description: Unique identifier of the connection title: Connection ID name: type: string title: Connection name details: allOf: - type: object required: - type - serverHostname - httpPath - authentication properties: type: type: string enum: - databricks description: Type of connection serverHostname: type: string description: Hostname of the Databricks compute resource httpPath: type: string description: HTTP path to connect to the Databricks SQL warehouse or cluster authentication: oneOf: - type: object required: - type - serviceAccount properties: type: type: string enum: - service-account description: Type of authentication serviceAccount: type: object required: - type properties: type: type: string enum: - basic-auth description: Type of authentication title: Service account title: Service account - allOf: - type: object required: - type - userCredential properties: type: type: string enum: - oauth description: Type of authentication userCredential: type: object required: - oauthConfig properties: oauthConfig: oneOf: - type: object required: - type properties: type: type: string enum: - organization description: Type of OAuth title: Organization-level OAuth - allOf: - type: object required: - type - scopes - metadataUri - clientId properties: type: type: string enum: - connection description: Type of OAuth scopes: type: array items: type: string description: OAuth scopes for Sigma to request from your IdP. Sigma requires the `profile`, `email`, and `openid` scopes. Sigma recommends the `offline_access` scope. title: OAuth scopes metadataUri: type: string description: Metadata URI for your OAuth authorization server title: Metadata URI clientId: type: string title: Client ID title: Connection-level OAuth configuration - type: object required: - usePkce - useJwt properties: usePkce: type: boolean description: PKCE-enhanced authorization is required for Databricks OAuth. title: Use PKCE useJwt: type: boolean title: Use JWT title: Connection-level OAuth description: "Choose whether to use the same OAuth configuration as the rest of your\n Sigma organization or configure OAuth specifically for this connection." title: OAuth configuration title: OAuth - type: object properties: serviceAccount: type: object required: - type properties: type: type: string enum: - basic-auth description: Type of authentication title: Service account title: OAuth title: Authentication - type: object properties: writeAccess: allOf: - type: object required: - writeDestinations properties: writeDestinations: type: array items: allOf: - type: object required: - destination properties: destination: type: object required: - catalog - schema properties: catalog: type: string description: Catalog name schema: type: string description: Schema name title: Destination - type: object properties: description: type: string description: Description of the write destination title: Write destination description: List of destinations where data can be written title: Write destinations - type: object properties: inputTableAuditLogDestination: type: object required: - catalog - schema properties: catalog: type: string description: Catalog name schema: type: string description: Schema name description: Audit log destination description: "Features like CSV upload, materialization, input tables, warehouse views, and\n running Python code require write access to a destination in your warehouse." title: Write access settings: allOf: - type: object properties: connectionTimeoutSecs: type: number description: Number of seconds Sigma waits for a query to return results before timing out. title: Connection timeout connectionQueueSize: type: number description: Number of queries that Sigma can concurrently run on this connection. title: Connection queue size useFriendlyNames: type: boolean description: Whether to change the column names to be more readable. For example, a column "SALES_JSON" becomes "Sales Json". Defaults to true. title: Use friendly names description: Configure specific settings for your connection. title: Settings - type: object properties: enableHiveMetastore: type: boolean description: To see and use your Hive metastore in Sigma, set to true. title: Enable Hive Metastore description: Configure specific settings for your connection title: Settings python: type: object required: - computeClusterId properties: computeClusterId: type: string description: Compute cluster ID to run Python queries title: Compute cluster ID description: Allow users to access data on this connection using Python. title: Python configuration sourceSwap: type: object required: - sourceSwapPolicyId properties: sourceSwapPolicyId: type: string description: Unique identifier of the source swap policy title: Source swap policy ID description: Specify a policy to use for dynamically swapping data sources. title: Source swap policy title: Connection details title: Connection default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - connections security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations components: responses: ApiError: description: Sigma API Error content: application/json: schema: type: object properties: message: type: string code: type: string requestId: type: string schemas: connections_getConnection_Response_200: type: object properties: organizationId: type: string description: Unique identifier of the organization connectionId: type: string description: Unique identifier of the connection isSample: type: boolean description: Whether the connection is the Sigma sample data connection isAuditLog: type: boolean description: Whether audit logging is enabled lastActiveAt: type: string format: date-time description: Last activity date and time name: type: string description: Name of the connection type: type: string description: Type of the connection (e.g., "bigQuery") useOauth: type: boolean description: Whether OAuth is used createdBy: type: string description: Identifier of the user who created this connection updatedBy: type: string description: Identifier of the user or process that last updated this connection createdAt: type: string format: date-time description: When the connection was created updatedAt: type: string format: date-time description: When the connection was last updated isArchived: type: boolean description: Whether the connection is archived account: type: string description: Account associated with the connection warehouse: type: string description: Warehouse associated with the connection user: type: string description: User associated with the connection httpPath: type: string description: For Databricks connections, HTTP path of the SQL warehouse. Not included when a user attribute sets the HTTP path. role: type: string description: Role used by the connection user timeout: $ref: '#/components/schemas/V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaTimeout' description: Timeout settings for the connection, with a default value in seconds poolSizes: $ref: '#/components/schemas/V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaPoolSizes' description: Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize writeAccess: type: boolean friendlyName: type: boolean description: Whether friendly names are enabled for this connection writebacks: type: array items: $ref: '#/components/schemas/V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaWritebacksItems' description: Configure write-back for non-OAuth connections writebackSchemas: type: array items: $ref: '#/components/schemas/V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaWritebackSchemasItems' description: Configure write-back for OAuth connections inputTableAuditLogSchema: $ref: '#/components/schemas/V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaInputTableAuditLogSchema' description: Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection. materializationWarehouse: type: string description: Warehouse used to run materialization jobs exportsWarehouse: type: string description: Warehouse used to run export jobs oauthMetadataUrl: type: string description: OAuth metadata URL configured directly on this connection. oauthClientId: type: string description: Client ID configured directly on this connection. oauthScopes: type: array items: type: string description: OAuth scopes configured directly on this connection. oauthIdpType: $ref: '#/components/schemas/V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType' description: OAuth provider type configured or inferred for this connection. oauthUsePkce: type: - boolean - 'null' description: Whether this connection-level OAuth configuration uses PKCE. oauthUseJwt: type: - boolean - 'null' description: Whether this connection-level OAuth configuration uses JWT bearer token authentication. oauthAudience: type: string description: Audience used for OAuth federation, such as the Google workforce identity federation audience for BigQuery. isIndependentOAuth: type: boolean description: Whether this connection uses connection-level OAuth instead of organization-level OAuth. userAttributes: $ref: '#/components/schemas/V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaUserAttributes' description: User attributes associated with the connection roleSwitching: $ref: '#/components/schemas/V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaRoleSwitching' description: Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful for Snowflake OAuth connections. required: - organizationId - connectionId - isSample - isAuditLog - lastActiveAt - name - type - useOauth - createdBy - updatedBy - createdAt - updatedAt title: connections_getConnection_Response_200 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password2: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password2 V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaPoolSizes: type: object properties: isPoolConfigured: type: boolean adhocPoolSize: type: number format: double catalogPoolSize: type: number format: double resultPoolSize: type: number format: double schedulePoolSize: type: number format: double description: Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize title: V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaPoolSizes V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password1: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0PasswordOneOf1Type' value: type: string required: - type - value title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password1 V2ConnectionsPathsConnectionPathIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission2: type: string enum: - view - edit - apply description: 'Valid inode types: version tag.' title: V2ConnectionsPathsConnectionPathIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission2 V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType7: type: string enum: - ping title: V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType7 V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaRoleSwitching: type: string enum: - allRoles - disabled description: Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful for Snowflake OAuth connections. title: V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaRoleSwitching V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType5: type: string enum: - adfs title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType5 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType9: type: string enum: - unknown title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType9 V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsUserAttributes: type: object properties: role: type: string warehouse: type: string description: User attributes associated with the connection title: V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsUserAttributes V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3ClientSecret: oneOf: - type: string - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3ClientSecret1' description: Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3ClientSecret V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails: oneOf: - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails0' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails1' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails2' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails3' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails4' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails5' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails6' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails7' title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaRead0: type: string enum: - SUCCESS title: V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaRead0 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3WriteAccess: type: object properties: writeCatalog: type: string description: Catalog or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform required: - writeCatalog - writeSchema description: Configure write-back for non-OAuth connections title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3WriteAccess V2ConnectionsTablesTableIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItemsVisibility: type: string enum: - included - hidden - removed description: Visibility of the column. If "included", the column is visible. If "hidden", the column is hidden but available to be used. If "removed", the column has been deleted from the table. title: V2ConnectionsTablesTableIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItemsVisibility V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3Type: type: string enum: - databricks title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3Type V2ConnectionsConnectionIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee0: type: object properties: memberId: type: string required: - memberId description: The UUID of the member receiving the grant title: V2ConnectionsConnectionIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee0 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType2: type: string enum: - gcp_databricks title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType2 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess1: type: object properties: materializationWarehouse: type: string description: Warehouse to use for materialization workloads useDynamicTables: type: boolean description: Whether to use Snowflake dynamic tables for materialization workloads. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess1 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password2: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password2 connections_updateConnection_Response_200: type: object properties: organizationId: type: string description: Unique identifier of the organization connectionId: type: string description: Unique identifier of the connection isSample: type: boolean description: Whether the connection is the Sigma sample data connection isAuditLog: type: boolean description: Whether audit logging is enabled lastActiveAt: type: string format: date-time description: Last activity date and time name: type: string description: Name of the connection type: type: string description: Type of the connection (e.g., "bigQuery") useOauth: type: boolean description: Whether OAuth is used createdBy: type: string description: Identifier of the user who created this connection updatedBy: type: string description: Identifier of the user or process that last updated this connection createdAt: type: string format: date-time description: When the connection was created updatedAt: type: string format: date-time description: When the connection was last updated isArchived: type: boolean description: Whether the connection is archived account: type: string description: Account associated with the connection warehouse: type: string description: Warehouse associated with the connection user: type: string description: User associated with the connection httpPath: type: string description: For Databricks connections, HTTP path of the SQL warehouse. Not included when a user attribute sets the HTTP path. role: type: string description: Role used by the connection user timeout: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaTimeout' description: Timeout settings for the connection, with a default value in seconds poolSizes: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaPoolSizes' description: Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize writeAccess: type: boolean friendlyName: type: boolean description: Whether friendly names are enabled for this connection writebacks: type: array items: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaWritebacksItems' description: Configure write-back for non-OAuth connections writebackSchemas: type: array items: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaWritebackSchemasItems' description: Configure write-back for OAuth connections inputTableAuditLogSchema: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaInputTableAuditLogSchema' description: Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection. materializationWarehouse: type: string description: Warehouse used to run materialization jobs exportsWarehouse: type: string description: Warehouse used to run export jobs oauthMetadataUrl: type: string description: OAuth metadata URL configured directly on this connection. oauthClientId: type: string description: Client ID configured directly on this connection. oauthScopes: type: array items: type: string description: OAuth scopes configured directly on this connection. oauthIdpType: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType' description: OAuth provider type configured or inferred for this connection. oauthUsePkce: type: - boolean - 'null' description: Whether this connection-level OAuth configuration uses PKCE. oauthUseJwt: type: - boolean - 'null' description: Whether this connection-level OAuth configuration uses JWT bearer token authentication. oauthAudience: type: string description: Audience used for OAuth federation, such as the Google workforce identity federation audience for BigQuery. isIndependentOAuth: type: boolean description: Whether this connection uses connection-level OAuth instead of organization-level OAuth. userAttributes: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaUserAttributes' description: User attributes associated with the connection roleSwitching: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaRoleSwitching' description: Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful for Snowflake OAuth connections. required: - organizationId - connectionId - isSample - isAuditLog - lastActiveAt - name - type - useOauth - createdBy - updatedBy - createdAt - updatedAt title: connections_updateConnection_Response_200 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3ClientSecret1: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3ClientSecret1 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaPoolSizes: type: object properties: isPoolConfigured: type: boolean description: Whether custom connection pool sizes are configured. If any pool size is supplied without this field, the API stores it as true. adhocPoolSize: type: number format: double description: Pool size for ad hoc query workloads. schedulePoolSize: type: number format: double description: Pool size for scheduled workloads. catalogPoolSize: type: number format: double description: Pool size for catalog workloads. resultPoolSize: type: number format: double description: Pool size for result cache workloads. description: Connection pool sizes. Each pool bounds how many queries of a given type (ad hoc, scheduled, catalog, result cache) run concurrently against the warehouse. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaPoolSizes V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType6: type: string enum: - okta title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType6 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4WriteAccess: type: object properties: writeSchema: type: string required: - writeSchema title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4WriteAccess V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType0: type: string enum: - aws_databricks title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType0 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1Type: type: string enum: - bigQuery title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1Type V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails1: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1Type' projectId: type: string additionalProjectIds: type: array items: type: string serviceAccount: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1ServiceAccount' metadataUrl: type: string description: OAuth metadata URL for connection-level OAuth. clientId: type: string description: Client ID for the OAuth application used by this connection. clientSecret: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1ClientSecret' description: Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API. scopes: type: array items: type: string description: OAuth scopes to request when users authenticate to this connection. idpType: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType' description: OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown. usePkce: type: - boolean - 'null' description: Whether the OAuth flow should require Proof Key for Code Exchange (PKCE). Databricks-hosted OAuth providers require PKCE. useJwt: type: - boolean - 'null' description: Whether the OAuth flow should use JWT bearer token authentication instead of a client secret. useOauth: type: boolean description: Whether this BigQuery connection uses OAuth federation. audience: type: string description: Google workforce identity federation audience used to exchange the OAuth token for a Google access token. writeAccess: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1WriteAccess' required: - type - projectId description: Details of the BigQuery connection. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails1 V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType6: type: string enum: - okta title: V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType6 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4Type: type: string enum: - mysql title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4Type V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaWrite2: type: string enum: - FAILED title: V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaWrite2 V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaWritebacksItems: type: object properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform writebackSchemaId: type: string description: Unique identifier of the writebackSchema description: type: string description: Description for the write-back destination. required: - database - schema title: V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaWritebacksItems V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails1: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1Type' projectId: type: string additionalProjectIds: type: array items: type: string serviceAccount: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1ServiceAccount' metadataUrl: type: string description: OAuth metadata URL for connection-level OAuth. clientId: type: string description: Client ID for the OAuth application used by this connection. clientSecret: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1ClientSecret' description: Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API. scopes: type: array items: type: string description: OAuth scopes to request when users authenticate to this connection. idpType: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType' description: OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown. usePkce: type: - boolean - 'null' description: Whether the OAuth flow should require Proof Key for Code Exchange (PKCE). Databricks-hosted OAuth providers require PKCE. useJwt: type: - boolean - 'null' description: Whether the OAuth flow should use JWT bearer token authentication instead of a client secret. useOauth: type: boolean description: Whether this BigQuery connection uses OAuth federation. audience: type: string description: Google workforce identity federation audience used to exchange the OAuth token for a Google access token. writeAccess: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1WriteAccess' required: - type - projectId description: Details of the BigQuery connection. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails1 V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaUserAttributes: type: object properties: role: type: string warehouse: type: string description: User attributes associated with the connection title: V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaUserAttributes V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0PasswordOneOf1Type: type: string enum: - plain title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0PasswordOneOf1Type V2ConnectionsPathsGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: connectionId: type: string urlId: type: string path: $ref: '#/components/schemas/V2ConnectionsPathsGetResponsesContentApplicationJsonSchemaEntriesItemsPath' required: - connectionId - urlId - path title: V2ConnectionsPathsGetResponsesContentApplicationJsonSchemaEntriesItems V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType4: type: string enum: - auth0 title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType4 V2ConnectionsPathsGetResponsesContentApplicationJsonSchemaEntriesItemsPath: oneOf: - type: array items: type: string - type: array items: type: string - type: array items: type: string - type: array items: description: Any type title: V2ConnectionsPathsGetResponsesContentApplicationJsonSchemaEntriesItemsPath V2ConnectionConnectionIdLookupPostRequestBodyContentApplicationJsonSchemaPath: oneOf: - type: array items: type: string - type: array items: type: string - type: array items: type: string - type: array items: description: Any type title: V2ConnectionConnectionIdLookupPostRequestBodyContentApplicationJsonSchemaPath V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1WriteAccess: type: object properties: writeProject: type: string writeDataset: type: string required: - writeProject - writeDataset title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1WriteAccess V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails2: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2Type' server: type: string account: type: string host: type: string warehouse: type: string role: type: string authType: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2AuthType' usePython: type: boolean pythonSecrets: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecrets' pythonProperties: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonProperties' description: Python configuration for this Snowflake connection. useSourceSwapPolicy: type: boolean sourceSwapPolicyId: type: string metadataUrl: type: string description: OAuth metadata URL for connection-level OAuth. clientId: type: string description: Client ID for the OAuth application used by this connection. clientSecret: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2ClientSecret' description: Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API. scopes: type: array items: type: string description: OAuth scopes to request when users authenticate to this connection. idpType: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType' description: OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown. usePkce: type: - boolean - 'null' description: Whether the OAuth flow should require Proof Key for Code Exchange (PKCE). Databricks-hosted OAuth providers require PKCE. useJwt: type: - boolean - 'null' description: Whether the OAuth flow should use JWT bearer token authentication instead of a client secret. exportsWarehouse: type: string description: Warehouse to use for export workloads. writeAccess: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess' description: Specify write access for non-OAuth connections userAttributes: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2UserAttributes' writebackSchemas: type: array items: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2WritebackSchemasItems' description: Configure write-back for OAuth connections inputTableAuditLogSchema: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2InputTableAuditLogSchema' description: Specify a schema for input table write access logs roleSwitching: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2RoleSwitching' description: Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful when `useOauth` is true. required: - type description: Details of the Snowflake connection. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails2 V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType: oneOf: - $ref: '#/components/schemas/V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType0' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType1' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType2' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType3' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType4' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType5' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType6' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType7' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType8' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType9' description: OAuth provider type configured or inferred for this connection. title: V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType4: type: string enum: - auth0 title: V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType4 connections_listConnectionPathGrants_Response_200: type: object properties: entries: type: array items: $ref: '#/components/schemas/V2ConnectionsPathsConnectionPathIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItems' nextPage: type: - string - 'null' hasMore: type: boolean description: '**[Deprecated]** Indicates whether more results are available.' required: - entries - nextPage title: connections_listConnectionPathGrants_Response_200 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7Type: type: string enum: - starburst description: Starburst connection type. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7Type V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaWrite: oneOf: - $ref: '#/components/schemas/V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaWrite0' - $ref: '#/components/schemas/V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaWrite1' - $ref: '#/components/schemas/V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaWrite2' title: V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaWrite V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType2: type: string enum: - gcp_databricks title: V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType2 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType4: type: string enum: - auth0 title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType4 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType8: type: string enum: - snowflake title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType8 V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType3: type: string enum: - azuread title: V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType3 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password: oneOf: - type: string - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password1' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password2' description: Password used to authenticate to the database. This value is write-only and is not returned by the API. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType6: type: string enum: - okta title: V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType6 V2ConnectionsConnectionIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsPermission: type: string enum: - annotate - usage description: Connection permissions of Can Use & Annotate and Can Use. title: V2ConnectionsConnectionIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsPermission V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaRoleSwitching: type: string enum: - allRoles - disabled description: Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful for Snowflake OAuth connections. title: V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaRoleSwitching V2ConnectionsConnectionIdSyncPostRequestBodyContentApplicationJsonSchemaPath: oneOf: - type: array items: type: string - type: array items: type: string - type: array items: type: string - type: array items: description: Any type title: V2ConnectionsConnectionIdSyncPostRequestBodyContentApplicationJsonSchemaPath V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType6: type: string enum: - okta title: V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType6 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6WriteAccess: type: object properties: writeDatabase: type: string description: Database to contain tables written back to the data platform. writeSchema: type: string description: Schema to contain tables written back to the data platform. required: - writeDatabase - writeSchema description: Configure write-back for the connection. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6WriteAccess V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType: oneOf: - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType0' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType1' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType2' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType3' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType4' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType5' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType6' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType7' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType8' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType9' description: OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2ClientSecret1: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2ClientSecret1 V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaWritebackSchemasItems: type: object properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform writebackSchemaId: type: string description: Unique identifier of the writebackSchema description: type: string description: Description for the write-back destination. required: - database - schema title: V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaWritebackSchemasItems V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType3: type: string enum: - azuread title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType3 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3ClientSecret: oneOf: - type: string - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3ClientSecret1' description: Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3ClientSecret V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1WriteAccess: type: object properties: writeProject: type: string writeDataset: type: string required: - writeProject - writeDataset title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1WriteAccess V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails3: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3Type' host: type: string workspaceUrl: type: string useSourceSwapPolicy: type: boolean sourceSwapPolicyId: type: string metadataUrl: type: string description: OAuth metadata URL for connection-level OAuth. clientId: type: string description: Client ID for the OAuth application used by this connection. clientSecret: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3ClientSecret' description: Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API. scopes: type: array items: type: string description: OAuth scopes to request when users authenticate to this connection. idpType: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType' description: OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown. usePkce: type: - boolean - 'null' description: Whether the OAuth flow should require Proof Key for Code Exchange (PKCE). Databricks-hosted OAuth providers require PKCE. useJwt: type: - boolean - 'null' description: Whether the OAuth flow should use JWT bearer token authentication instead of a client secret. writeAccess: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3WriteAccess' description: Configure write-back for non-OAuth connections writebackSchemas: type: array items: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3WritebackSchemasItems' description: Configure write-back for OAuth connections inputTableAuditLogSchema: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3InputTableAuditLogSchema' description: Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection. required: - type - host description: Details of the Databricks connection. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails3 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType6: type: string enum: - okta title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType6 V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType8: type: string enum: - snowflake title: V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType8 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2AuthType: type: string enum: - basic-auth - key-pair - oauth title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2AuthType V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password: oneOf: - type: string - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password1' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password2' description: The password for the service account set up by your Starburst administrator. This value is write-only and is not returned by the API. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password V2ConnectionsPostResponsesContentApplicationJsonSchemaTimeout: type: object properties: default: type: number format: double worksheet: type: number format: double dashboard: type: number format: double download: type: number format: double required: - default description: Timeout settings for the connection, with a default value in seconds title: V2ConnectionsPostResponsesContentApplicationJsonSchemaTimeout V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2ClientSecret: oneOf: - type: string - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2ClientSecret1' description: Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2ClientSecret V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType3: type: string enum: - azuread title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType3 V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType5: type: string enum: - adfs title: V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType5 V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType8: type: string enum: - snowflake title: V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType8 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2RoleSwitching: type: string enum: - allRoles - disabled description: Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful when `useOauth` is true. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2RoleSwitching V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType1: type: string enum: - azure_databricks title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType1 V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaTimeout: type: object properties: default: type: number format: double worksheet: type: number format: double dashboard: type: number format: double download: type: number format: double required: - default description: Timeout settings for the connection, with a default value in seconds title: V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaTimeout V2ConnectionsPathsConnectionPathIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItems: type: object properties: grantee: $ref: '#/components/schemas/V2ConnectionsPathsConnectionPathIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee' permission: $ref: '#/components/schemas/V2ConnectionsPathsConnectionPathIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsPermission' required: - grantee - permission title: V2ConnectionsPathsConnectionPathIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItems V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails7: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7Type' description: Starburst connection type. host: type: string description: The address of your Starburst Galaxy cluster as a URL or an IP address. port: type: number format: double description: The port through which Sigma connects to your Starburst Galaxy cluster. user: type: string description: The username of the service account set up by your Starburst administrator. password: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password' description: The password for the service account set up by your Starburst administrator. This value is write-only and is not returned by the API. writeAccess: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7WriteAccess' description: Configure write-back for the connection. required: - type - host - port - user - password description: Details of the Starburst connection. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails7 connections_listConnectionTableColumns_Response_200: type: object properties: entries: type: array items: $ref: '#/components/schemas/V2ConnectionsTablesTableIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItems' description: Array of results returned by the endpoint nextPageToken: type: string description: 'A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results. **Must be treated as an opaque string.**' required: - entries title: connections_listConnectionTableColumns_Response_200 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType0: type: string enum: - aws_databricks title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType0 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0WriteAccess: type: object properties: writeSchema: type: string required: - writeSchema title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0WriteAccess V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5WriteAccess: type: object properties: writeDatabase: type: string description: Database to contain tables written back to the data platform. writeSchema: type: string description: Schema to contain tables written back to the data platform. required: - writeDatabase - writeSchema description: Configure write-back for the connection. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5WriteAccess V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password1: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6PasswordOneOf1Type' value: type: string required: - type - value title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password1 V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaPoolSizes: type: object properties: isPoolConfigured: type: boolean adhocPoolSize: type: number format: double catalogPoolSize: type: number format: double resultPoolSize: type: number format: double schedulePoolSize: type: number format: double description: Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize title: V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaPoolSizes V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType2: type: string enum: - gcp_databricks title: V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType2 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType7: type: string enum: - ping title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType7 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3InputTableAuditLogSchema: type: object properties: writeCatalog: type: string description: Catalog or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform writebackSchemaId: type: string description: Unique identifier of the writebackSchema required: - writeCatalog - writeSchema description: Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3InputTableAuditLogSchema V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails0: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0Type' host: type: string database: type: string user: type: string password: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password' port: type: number format: double useTls: type: boolean writeAccess: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0WriteAccess' required: - type - host - database description: Details of the PostgreSQL connection. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails0 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType: oneOf: - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType0' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType1' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType2' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType3' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType4' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType5' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType6' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType7' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType8' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType9' description: OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaWritebacksItems: type: object properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform writebackSchemaId: type: string description: Unique identifier of the writebackSchema description: type: string description: Description for the write-back destination. required: - database - schema title: V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaWritebacksItems V2ConnectionsConnectionIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission1: type: string enum: - create - annotate - organize - explore - view - edit - apply description: 'Valid inode types: folder, workspace, workbook, dataset, and data model. Can Contribute permissions are listed as **organize** and Can Manage permissions are listed as **edit**.' title: V2ConnectionsConnectionIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission1 V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType: oneOf: - $ref: '#/components/schemas/V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType0' - $ref: '#/components/schemas/V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType1' - $ref: '#/components/schemas/V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType2' - $ref: '#/components/schemas/V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType3' - $ref: '#/components/schemas/V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType4' - $ref: '#/components/schemas/V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType5' - $ref: '#/components/schemas/V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType6' - $ref: '#/components/schemas/V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType7' - $ref: '#/components/schemas/V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType8' - $ref: '#/components/schemas/V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType9' description: OAuth provider type configured or inferred for this connection. title: V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2UserAttributes: type: object properties: role: type: string warehouse: type: string title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2UserAttributes V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password: oneOf: - type: string - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password1' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password2' title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5PasswordOneOf1Type: type: string enum: - plain title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5PasswordOneOf1Type V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType4: type: string enum: - auth0 title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType4 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password: oneOf: - type: string - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password1' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password2' title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password connections_updateConnectionDeprecated_Response_200: type: object properties: organizationId: type: string description: Unique identifier of the organization connectionId: type: string description: Unique identifier of the connection isSample: type: boolean description: Whether the connection is the Sigma sample data connection isAuditLog: type: boolean description: Whether audit logging is enabled lastActiveAt: type: string format: date-time description: Last activity date and time name: type: string description: Name of the connection type: type: string description: Type of the connection (e.g., "bigQuery") useOauth: type: boolean description: Whether OAuth is used createdBy: type: string description: Identifier of the user who created this connection updatedBy: type: string description: Identifier of the user or process that last updated this connection createdAt: type: string format: date-time description: When the connection was created updatedAt: type: string format: date-time description: When the connection was last updated isArchived: type: boolean description: Whether the connection is archived account: type: string description: Account associated with the connection warehouse: type: string description: Warehouse associated with the connection user: type: string description: User associated with the connection httpPath: type: string description: For Databricks connections, HTTP path of the SQL warehouse. Not included when a user attribute sets the HTTP path. role: type: string description: Role used by the connection user timeout: $ref: '#/components/schemas/V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaTimeout' description: Timeout settings for the connection, with a default value in seconds poolSizes: $ref: '#/components/schemas/V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaPoolSizes' description: Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize writeAccess: type: boolean friendlyName: type: boolean description: Whether friendly names are enabled for this connection writebacks: type: array items: $ref: '#/components/schemas/V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaWritebacksItems' description: Configure write-back for non-OAuth connections writebackSchemas: type: array items: $ref: '#/components/schemas/V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaWritebackSchemasItems' description: Configure write-back for OAuth connections inputTableAuditLogSchema: $ref: '#/components/schemas/V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaInputTableAuditLogSchema' description: Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection. materializationWarehouse: type: string description: Warehouse used to run materialization jobs exportsWarehouse: type: string description: Warehouse used to run export jobs oauthMetadataUrl: type: string description: OAuth metadata URL configured directly on this connection. oauthClientId: type: string description: Client ID configured directly on this connection. oauthScopes: type: array items: type: string description: OAuth scopes configured directly on this connection. oauthIdpType: $ref: '#/components/schemas/V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType' description: OAuth provider type configured or inferred for this connection. oauthUsePkce: type: - boolean - 'null' description: Whether this connection-level OAuth configuration uses PKCE. oauthUseJwt: type: - boolean - 'null' description: Whether this connection-level OAuth configuration uses JWT bearer token authentication. oauthAudience: type: string description: Audience used for OAuth federation, such as the Google workforce identity federation audience for BigQuery. isIndependentOAuth: type: boolean description: Whether this connection uses connection-level OAuth instead of organization-level OAuth. userAttributes: $ref: '#/components/schemas/V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaUserAttributes' description: User attributes associated with the connection roleSwitching: $ref: '#/components/schemas/V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaRoleSwitching' description: Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful for Snowflake OAuth connections. required: - organizationId - connectionId - isSample - isAuditLog - lastActiveAt - name - type - useOauth - createdBy - updatedBy - createdAt - updatedAt title: connections_updateConnectionDeprecated_Response_200 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6PasswordOneOf1Type: type: string enum: - plain title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6PasswordOneOf1Type V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7WriteAccess: type: object properties: writeCatalog: type: string description: Catalog to contain tables written back to the data platform. writeSchema: type: string description: Schema to contain tables written back to the data platform. required: - writeCatalog - writeSchema description: Configure write-back for the connection. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7WriteAccess V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsTimeout: type: object properties: default: type: number format: double worksheet: type: number format: double dashboard: type: number format: double download: type: number format: double required: - default description: Timeout settings for the connection, with a default value in seconds title: V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsTimeout V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType7: type: string enum: - ping title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType7 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1ClientSecret1: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1ClientSecret1 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2WritebackSchemasItems: type: object properties: writeDatabase: type: string description: Database or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform writebackSchemaId: type: string description: Unique identifier of the write-back destination description: type: string description: Description for the write-back destination. required: - writeDatabase - writeSchema title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2WritebackSchemasItems V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType1: type: string enum: - azure_databricks title: V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType1 V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType: oneOf: - $ref: '#/components/schemas/V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType0' - $ref: '#/components/schemas/V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType1' - $ref: '#/components/schemas/V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType2' - $ref: '#/components/schemas/V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType3' - $ref: '#/components/schemas/V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType4' - $ref: '#/components/schemas/V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType5' - $ref: '#/components/schemas/V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType6' - $ref: '#/components/schemas/V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType7' - $ref: '#/components/schemas/V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType8' - $ref: '#/components/schemas/V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType9' description: OAuth provider type configured or inferred for this connection. title: V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType1: type: string enum: - azure_databricks title: V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType1 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6Type: type: string enum: - sqlserver description: SQL Server connection type. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6Type V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess: oneOf: - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess0' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess1' description: Specify write access for non-OAuth connections title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7PasswordOneOf1Type: type: string enum: - plain title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7PasswordOneOf1Type V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType5: type: string enum: - adfs title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType5 V2ConnectionConnectionIdLookupPostResponsesContentApplicationJsonSchemaKind: type: string enum: - scope - table - semanticView - metricView - stored-procedure title: V2ConnectionConnectionIdLookupPostResponsesContentApplicationJsonSchemaKind V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType4: type: string enum: - auth0 title: V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType4 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType2: type: string enum: - gcp_databricks title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType2 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType8: type: string enum: - snowflake title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType8 V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType4: type: string enum: - auth0 title: V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType4 V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType2: type: string enum: - gcp_databricks title: V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType2 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails6: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6Type' description: SQL Server connection type. server: type: string description: Fully qualified server name or host. port: type: number format: double description: Port for the database server. user: type: string description: Username used to authenticate to the database. password: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password' description: Password used to authenticate to the database. This value is write-only and is not returned by the API. useReadUncommittedIsolation: type: boolean description: Whether queries run with READ UNCOMMITTED transaction isolation. writeAccess: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6WriteAccess' description: Configure write-back for the connection. required: - type - server - port - user - password description: Details of the SQL Server connection. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails6 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password: oneOf: - type: string - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password1' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password2' description: The password for the service account set up by your Starburst administrator. This value is write-only and is not returned by the API. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaTimeout: type: object properties: default: type: number format: double worksheet: type: number format: double dashboard: type: number format: double download: type: number format: double required: - default description: Timeout settings for the connection, with a default value in seconds title: V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaTimeout V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsWritebacksItems: type: object properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform writebackSchemaId: type: string description: Unique identifier of the writebackSchema description: type: string description: Description for the write-back destination. required: - database - schema title: V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsWritebacksItems V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1ServiceAccount1: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1ServiceAccount1 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5Type: type: string enum: - azuresql description: Azure SQL DB connection type. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5Type V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3Type: type: string enum: - databricks title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3Type V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType3: type: string enum: - azuread title: V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType3 V2ConnectionsPostResponsesContentApplicationJsonSchemaPoolSizes: type: object properties: isPoolConfigured: type: boolean adhocPoolSize: type: number format: double catalogPoolSize: type: number format: double resultPoolSize: type: number format: double schedulePoolSize: type: number format: double description: Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize title: V2ConnectionsPostResponsesContentApplicationJsonSchemaPoolSizes V2ConnectionsPathsConnectionPathIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsPermission: type: string enum: - annotate - usage title: V2ConnectionsPathsConnectionPathIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsPermission connections_postConnectionDbtArtifacts_Response_201: type: object properties: {} title: connections_postConnectionDbtArtifacts_Response_201 V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaUserAttributes: type: object properties: role: type: string warehouse: type: string description: User attributes associated with the connection title: V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaUserAttributes V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails4: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4Type' user: type: string password: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password' host: type: string port: type: number format: double writeAccess: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4WriteAccess' required: - type - user - password - host - port description: Details of the MySQL connection. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails4 V2ConnectionsPostResponsesContentApplicationJsonSchemaRoleSwitching: type: string enum: - allRoles - disabled description: Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful for Snowflake OAuth connections. title: V2ConnectionsPostResponsesContentApplicationJsonSchemaRoleSwitching V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType0: type: string enum: - aws_databricks title: V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType0 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password2: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password2 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType7: type: string enum: - ping title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType7 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType3: type: string enum: - azuread title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType3 V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType5: type: string enum: - adfs title: V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType5 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType5: type: string enum: - adfs title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType5 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6PasswordOneOf1Type: type: string enum: - plain title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6PasswordOneOf1Type V2ConnectionsConnectionIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItems: type: object properties: grantee: $ref: '#/components/schemas/V2ConnectionsConnectionIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee' permission: $ref: '#/components/schemas/V2ConnectionsConnectionIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsPermission' description: Connection permissions of Can Use & Annotate and Can Use. required: - grantee - permission title: V2ConnectionsConnectionIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItems V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2InputTableAuditLogSchema: type: object properties: writeDatabase: type: string description: Database or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform writebackSchemaId: type: string description: Unique identifier of the writebackSchema required: - writeDatabase - writeSchema description: Specify a schema for input table write access logs title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2InputTableAuditLogSchema V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType3: type: string enum: - azuread title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType3 V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType5: type: string enum: - adfs title: V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType5 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password: oneOf: - type: string - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password1' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password2' title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails4: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Type' user: type: string password: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password' host: type: string port: type: number format: double writeAccess: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4WriteAccess' required: - type - user - password - host - port description: Details of the MySQL connection. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails4 V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType: oneOf: - $ref: '#/components/schemas/V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType0' - $ref: '#/components/schemas/V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType1' - $ref: '#/components/schemas/V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType2' - $ref: '#/components/schemas/V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType3' - $ref: '#/components/schemas/V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType4' - $ref: '#/components/schemas/V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType5' - $ref: '#/components/schemas/V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType6' - $ref: '#/components/schemas/V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType7' - $ref: '#/components/schemas/V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType8' - $ref: '#/components/schemas/V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType9' description: OAuth provider type configured or inferred for this connection. title: V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3InputTableAuditLogSchema: type: object properties: writeCatalog: type: string description: Catalog or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform writebackSchemaId: type: string description: Unique identifier of the writebackSchema required: - writeCatalog - writeSchema description: Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3InputTableAuditLogSchema V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3WritebackSchemasItems: type: object properties: writeCatalog: type: string description: Catalog or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform writebackSchemaId: type: string description: Unique identifier of the write-back destination description: type: string description: Description for the write-back destination. required: - writeCatalog - writeSchema title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3WritebackSchemasItems V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5WriteAccess: type: object properties: writeDatabase: type: string description: Database to contain tables written back to the data platform. writeSchema: type: string description: Schema to contain tables written back to the data platform. required: - writeDatabase - writeSchema description: Configure write-back for the connection. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5WriteAccess V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess0: type: object properties: writeDatabase: type: string description: Database or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform materializationWarehouse: type: string description: Warehouse to use for materialization workloads useDynamicTables: type: boolean description: Whether to use Snowflake dynamic tables for materialization workloads. required: - writeDatabase - writeSchema title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess0 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType7: type: string enum: - ping title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType7 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails6: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6Type' description: SQL Server connection type. server: type: string description: Fully qualified server name or host. port: type: number format: double description: Port for the database server. user: type: string description: Username used to authenticate to the database. password: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password' description: Password used to authenticate to the database. This value is write-only and is not returned by the API. useReadUncommittedIsolation: type: boolean description: Whether queries run with READ UNCOMMITTED transaction isolation. writeAccess: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6WriteAccess' description: Configure write-back for the connection. required: - type - server - port - user - password description: Details of the SQL Server connection. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails6 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2Type: type: string enum: - snowflake title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2Type V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password2: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password2 V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType7: type: string enum: - ping title: V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType7 connections_syncConnectionPath_Response_200: type: object properties: {} title: connections_syncConnectionPath_Response_200 V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaPoolSizes: type: object properties: isPoolConfigured: type: boolean adhocPoolSize: type: number format: double catalogPoolSize: type: number format: double resultPoolSize: type: number format: double schedulePoolSize: type: number format: double description: Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize title: V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaPoolSizes V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2RoleSwitching: type: string enum: - allRoles - disabled description: Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful when `useOauth` is true. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2RoleSwitching V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType0: type: string enum: - aws_databricks title: V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType0 V2ConnectionsPostResponsesContentApplicationJsonSchemaUserAttributes: type: object properties: role: type: string warehouse: type: string description: User attributes associated with the connection title: V2ConnectionsPostResponsesContentApplicationJsonSchemaUserAttributes V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecrets: type: object properties: setupUser: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecretsSetupUser' pythonUser: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecretsPythonUser' title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecrets V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password2: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password2 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess1: type: object properties: materializationWarehouse: type: string description: Warehouse to use for materialization workloads useDynamicTables: type: boolean description: Whether to use Snowflake dynamic tables for materialization workloads. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess1 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecretsPythonUser: type: object properties: username: type: string password: type: string role: type: string required: - username - password title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecretsPythonUser V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaRoleSwitching: type: string enum: - allRoles - disabled description: Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful for Snowflake OAuth connections. title: V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaRoleSwitching V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType2: type: string enum: - gcp_databricks title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType2 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonProperties: type: object properties: serviceNames: type: array items: type: string externalAccessIntegration: type: string description: Name of the Snowflake external access integration to enable for Python. warehouse: type: string description: Warehouse to use to run Python code. packages: type: string description: Comma-separated list of Python packages to install. description: Python configuration for this Snowflake connection. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonProperties V2ConnectionsConnectionIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission0: type: string enum: - admin - annotate - update - usage - writeback description: 'Valid inode types: table, connection database, and connection schema.' title: V2ConnectionsConnectionIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission0 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Type: type: string enum: - mysql title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Type V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType6: type: string enum: - okta title: V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType6 V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType9: type: string enum: - unknown title: V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType9 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecretsSetupUser: type: object properties: username: type: string password: type: string role: type: string required: - username - password title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecretsSetupUser V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4PasswordOneOf1Type: type: string enum: - plain title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4PasswordOneOf1Type V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType5: type: string enum: - adfs title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType5 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType1: type: string enum: - azure_databricks title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType1 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1ClientSecret: oneOf: - type: string - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1ClientSecret1' description: Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1ClientSecret V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2Type: type: string enum: - snowflake title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2Type V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType6: type: string enum: - okta title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType6 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType5: type: string enum: - adfs title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType5 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2UserAttributes: type: object properties: role: type: string warehouse: type: string title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2UserAttributes connections_deleteConnectionPathGrant_Response_200: type: object properties: {} title: connections_deleteConnectionPathGrant_Response_200 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7PasswordOneOf1Type: type: string enum: - plain title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7PasswordOneOf1Type V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password2: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password2 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails7: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7Type' description: Starburst connection type. host: type: string description: The address of your Starburst Galaxy cluster as a URL or an IP address. port: type: number format: double description: The port through which Sigma connects to your Starburst Galaxy cluster. user: type: string description: The username of the service account set up by your Starburst administrator. password: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password' description: The password for the service account set up by your Starburst administrator. This value is write-only and is not returned by the API. writeAccess: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7WriteAccess' description: Configure write-back for the connection. required: - type - host - port - user - password description: Details of the Starburst connection. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails7 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0PasswordOneOf1Type: type: string enum: - plain title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0PasswordOneOf1Type V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails: oneOf: - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails0' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails1' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails2' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails3' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails4' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails5' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails6' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails7' title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1ServiceAccount: oneOf: - type: string - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1ServiceAccount1' title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1ServiceAccount V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password1: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7PasswordOneOf1Type' value: type: string required: - type - value title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password1 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType4: type: string enum: - auth0 title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType4 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType1: type: string enum: - azure_databricks title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType1 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType9: type: string enum: - unknown title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType9 V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: organizationId: type: string description: Unique identifier of the organization connectionId: type: string description: Unique identifier of the connection isSample: type: boolean description: Whether the connection is the Sigma sample data connection isAuditLog: type: boolean description: Whether audit logging is enabled lastActiveAt: type: string format: date-time description: Last activity date and time name: type: string description: Name of the connection type: type: string description: Type of the connection (e.g., "bigQuery") useOauth: type: boolean description: Whether OAuth is used createdBy: type: string description: Identifier of the user who created this connection updatedBy: type: string description: Identifier of the user or process that last updated this connection createdAt: type: string format: date-time description: When the connection was created updatedAt: type: string format: date-time description: When the connection was last updated isArchived: type: boolean description: Whether the connection is archived account: type: string description: Account associated with the connection warehouse: type: string description: Warehouse associated with the connection user: type: string description: User associated with the connection httpPath: type: string description: For Databricks connections, HTTP path of the SQL warehouse. Not included when a user attribute sets the HTTP path. role: type: string description: Role used by the connection user timeout: $ref: '#/components/schemas/V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsTimeout' description: Timeout settings for the connection, with a default value in seconds poolSizes: $ref: '#/components/schemas/V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsPoolSizes' description: Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize writeAccess: type: boolean friendlyName: type: boolean description: Whether friendly names are enabled for this connection writebacks: type: array items: $ref: '#/components/schemas/V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsWritebacksItems' description: Configure write-back for non-OAuth connections writebackSchemas: type: array items: $ref: '#/components/schemas/V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsWritebackSchemasItems' description: Configure write-back for OAuth connections inputTableAuditLogSchema: $ref: '#/components/schemas/V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsInputTableAuditLogSchema' description: Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection. materializationWarehouse: type: string description: Warehouse used to run materialization jobs exportsWarehouse: type: string description: Warehouse used to run export jobs oauthMetadataUrl: type: string description: OAuth metadata URL configured directly on this connection. oauthClientId: type: string description: Client ID configured directly on this connection. oauthScopes: type: array items: type: string description: OAuth scopes configured directly on this connection. oauthIdpType: $ref: '#/components/schemas/V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType' description: OAuth provider type configured or inferred for this connection. oauthUsePkce: type: - boolean - 'null' description: Whether this connection-level OAuth configuration uses PKCE. oauthUseJwt: type: - boolean - 'null' description: Whether this connection-level OAuth configuration uses JWT bearer token authentication. oauthAudience: type: string description: Audience used for OAuth federation, such as the Google workforce identity federation audience for BigQuery. isIndependentOAuth: type: boolean description: Whether this connection uses connection-level OAuth instead of organization-level OAuth. userAttributes: $ref: '#/components/schemas/V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsUserAttributes' description: User attributes associated with the connection roleSwitching: $ref: '#/components/schemas/V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsRoleSwitching' description: Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful for Snowflake OAuth connections. required: - organizationId - connectionId - isSample - isAuditLog - lastActiveAt - name - type - useOauth - createdBy - updatedBy - createdAt - updatedAt title: V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItems connections_listConnections_Response_200: type: object properties: entries: type: array items: $ref: '#/components/schemas/V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItems' description: Array of results returned by the endpoint nextPage: type: - string - 'null' description: Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`. total: type: number format: double description: Total number of results. Useful to determine if there is a need to paginate. hasMore: type: boolean description: '**[Deprecated]** Indicates whether more results are available.' required: - entries - nextPage title: connections_listConnections_Response_200 V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType2: type: string enum: - gcp_databricks title: V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType2 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess: oneOf: - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess0' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess1' description: Specify write access for non-OAuth connections title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType: oneOf: - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType0' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType1' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType2' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType3' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType4' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType5' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType6' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType7' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType8' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType9' description: OAuth provider type configured or inferred for this connection. title: V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType V2ConnectionsPathsConnectionPathIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission: oneOf: - $ref: '#/components/schemas/V2ConnectionsPathsConnectionPathIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission0' - $ref: '#/components/schemas/V2ConnectionsPathsConnectionPathIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission1' - $ref: '#/components/schemas/V2ConnectionsPathsConnectionPathIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission2' description: The permission granted to the member title: V2ConnectionsPathsConnectionPathIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType3: type: string enum: - azuread title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType3 V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType7: type: string enum: - ping title: V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType7 V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType9: type: string enum: - unknown title: V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType9 V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaInputTableAuditLogSchema: type: object properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform writebackSchemaId: type: string description: Unique identifier of the writebackSchema required: - database - schema description: Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection. title: V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaInputTableAuditLogSchema V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password1: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4PasswordOneOf1Type' value: type: string required: - type - value title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password1 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType1: type: string enum: - azure_databricks title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType1 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType8: type: string enum: - snowflake title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType8 V2ConnectionsPostResponsesContentApplicationJsonSchemaWritebackSchemasItems: type: object properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform writebackSchemaId: type: string description: Unique identifier of the writebackSchema description: type: string description: Description for the write-back destination. required: - database - schema title: V2ConnectionsPostResponsesContentApplicationJsonSchemaWritebackSchemasItems V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType: oneOf: - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType0' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType1' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType2' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType3' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType4' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType5' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType6' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType7' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType8' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType9' description: OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaTimeout: type: object properties: default: type: number format: double worksheet: type: number format: double dashboard: type: number format: double download: type: number format: double required: - default description: Timeout settings for the connection, with a default value in seconds title: V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaTimeout V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password: oneOf: - type: string - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password1' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password2' description: Password used to authenticate to the database. This value is write-only and is not returned by the API. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaWrite0: type: string enum: - DISABLED title: V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaWrite0 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails0: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Type' host: type: string database: type: string user: type: string password: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password' port: type: number format: double useTls: type: boolean writeAccess: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0WriteAccess' required: - type - host - database description: Details of the PostgreSQL connection. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails0 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3WritebackSchemasItems: type: object properties: writeCatalog: type: string description: Catalog or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform writebackSchemaId: type: string description: Unique identifier of the write-back destination description: type: string description: Description for the write-back destination. required: - writeCatalog - writeSchema title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3WritebackSchemasItems V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WritebackSchemasItems: type: object properties: writeDatabase: type: string description: Database or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform writebackSchemaId: type: string description: Unique identifier of the write-back destination description: type: string description: Description for the write-back destination. required: - writeDatabase - writeSchema title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WritebackSchemasItems V2ConnectionsPathsConnectionPathIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee0: type: object properties: memberId: type: string required: - memberId description: The UUID of the member receiving the grant title: V2ConnectionsPathsConnectionPathIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee0 V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType5: type: string enum: - adfs title: V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType5 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecretsPythonUser: type: object properties: username: type: string password: type: string role: type: string required: - username - password title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecretsPythonUser V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsRoleSwitching: type: string enum: - allRoles - disabled description: Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful for Snowflake OAuth connections. title: V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsRoleSwitching V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password1: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4PasswordOneOf1Type' value: type: string required: - type - value title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password1 V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType1: type: string enum: - azure_databricks title: V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType1 connections_lookupConnection_Response_200: type: object properties: kind: $ref: '#/components/schemas/V2ConnectionConnectionIdLookupPostResponsesContentApplicationJsonSchemaKind' inodeId: type: string url: type: string required: - kind - inodeId - url title: connections_lookupConnection_Response_200 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType2: type: string enum: - gcp_databricks title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType2 V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaWritebackSchemasItems: type: object properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform writebackSchemaId: type: string description: Unique identifier of the writebackSchema description: type: string description: Description for the write-back destination. required: - database - schema title: V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaWritebackSchemasItems V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0Type: type: string enum: - postgres - redshift - alloydb title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0Type V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1ClientSecret1: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1ClientSecret1 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType6: type: string enum: - okta title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType6 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType6: type: string enum: - okta title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType6 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails5: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5Type' description: Azure SQL DB connection type. server: type: string description: Fully qualified server name or host. database: type: string description: Database to connect to on the Azure SQL DB server. port: type: number format: double description: Port for the database server. user: type: string description: Username used to authenticate to the database. password: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password' description: Password used to authenticate to the database. This value is write-only and is not returned by the API. useReadUncommittedIsolation: type: boolean description: Whether queries run with READ UNCOMMITTED transaction isolation. writeAccess: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5WriteAccess' description: Configure write-back for the connection. required: - type - server - database - port - user - password description: Details of the Azure SQL DB connection. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails5 V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType1: type: string enum: - azure_databricks title: V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType1 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType0: type: string enum: - aws_databricks title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType0 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1ServiceAccount1: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1ServiceAccount1 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType9: type: string enum: - unknown title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType9 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1Type: type: string enum: - bigQuery title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1Type V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType8: type: string enum: - snowflake title: V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType8 V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType0: type: string enum: - aws_databricks title: V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType0 V2ConnectionsTablesTableIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItemsType: type: object properties: {} description: The column's data type, represented as a recursive type object. title: V2ConnectionsTablesTableIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItemsType V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password2: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password2 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecrets: type: object properties: setupUser: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecretsSetupUser' pythonUser: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecretsPythonUser' title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecrets V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaWritebacksItems: type: object properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform writebackSchemaId: type: string description: Unique identifier of the writebackSchema description: type: string description: Description for the write-back destination. required: - database - schema title: V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaWritebacksItems V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password2: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password2 V2ConnectionsConnectionIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: grantId: type: string description: The unique identifier of the grant inodeId: type: string description: The unique identifier of the inode organizationId: type: string description: The unique identifier of the organization memberId: type: - string - 'null' description: The unique identifier of the member teamId: type: - string - 'null' description: The unique identifier of the team permission: $ref: '#/components/schemas/V2ConnectionsConnectionIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission' description: The permission granted to the member createdBy: type: string description: The identifier of the user who created this grant updatedBy: type: string description: The identifier of the user or process that last updated this grant createdAt: type: string format: date-time description: When the grant was created updatedAt: type: string format: date-time description: When the grant was last updated required: - grantId - inodeId - organizationId - memberId - teamId - permission - createdBy - updatedBy - createdAt - updatedAt title: V2ConnectionsConnectionIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItems V2ConnectionsPathsConnectionPathIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee: oneOf: - $ref: '#/components/schemas/V2ConnectionsPathsConnectionPathIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee0' - $ref: '#/components/schemas/V2ConnectionsPathsConnectionPathIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee1' title: V2ConnectionsPathsConnectionPathIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType0: type: string enum: - aws_databricks title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType0 V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType2: type: string enum: - gcp_databricks title: V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType2 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType4: type: string enum: - auth0 title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType4 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6Type: type: string enum: - sqlserver description: SQL Server connection type. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6Type V2ConnectionsPathsConnectionPathIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission1: type: string enum: - create - annotate - organize - explore - view - edit - apply description: 'Valid inode types: folder, workspace, workbook, dataset, and data model. Can Contribute permissions are listed as **organize** and Can Manage permissions are listed as **edit**.' title: V2ConnectionsPathsConnectionPathIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission1 connections_createConnectionGrant_Response_200: type: object properties: {} title: connections_createConnectionGrant_Response_200 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType6: type: string enum: - okta title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType6 V2ConnectionsTablesTableIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: name: type: string description: The name of the column in the warehouse table. type: $ref: '#/components/schemas/V2ConnectionsTablesTableIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItemsType' description: The column's data type, represented as a recursive type object. visibility: $ref: '#/components/schemas/V2ConnectionsTablesTableIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItemsVisibility' description: Visibility of the column. If "included", the column is visible. If "hidden", the column is hidden but available to be used. If "removed", the column has been deleted from the table. description: type: string description: The description of the column, if one has been set. required: - name - type - visibility title: V2ConnectionsTablesTableIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItems V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType3: type: string enum: - azuread title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType3 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5PasswordOneOf1Type: type: string enum: - plain title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5PasswordOneOf1Type V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password1: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5PasswordOneOf1Type' value: type: string required: - type - value title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password1 V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaRead1: type: string enum: - FAILED title: V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaRead1 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2ClientSecret: oneOf: - type: string - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2ClientSecret1' description: Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2ClientSecret V2ConnectionsPostResponsesContentApplicationJsonSchemaWritebacksItems: type: object properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform writebackSchemaId: type: string description: Unique identifier of the writebackSchema description: type: string description: Description for the write-back destination. required: - database - schema title: V2ConnectionsPostResponsesContentApplicationJsonSchemaWritebacksItems V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password1: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0PasswordOneOf1Type' value: type: string required: - type - value title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password1 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0WriteAccess: type: object properties: writeSchema: type: string required: - writeSchema title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0WriteAccess V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2InputTableAuditLogSchema: type: object properties: writeDatabase: type: string description: Database or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform writebackSchemaId: type: string description: Unique identifier of the writebackSchema required: - writeDatabase - writeSchema description: Specify a schema for input table write access logs title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2InputTableAuditLogSchema V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType0: type: string enum: - aws_databricks title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType0 V2ConnectionsConnectionIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee: oneOf: - $ref: '#/components/schemas/V2ConnectionsConnectionIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee0' - $ref: '#/components/schemas/V2ConnectionsConnectionIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee1' title: V2ConnectionsConnectionIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType5: type: string enum: - adfs title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType5 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType4: type: string enum: - auth0 title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType4 V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType9: type: string enum: - unknown title: V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType9 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password: oneOf: - type: string - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password1' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password2' title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password: oneOf: - type: string - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password1' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password2' description: Password used to authenticate to the database. This value is write-only and is not returned by the API. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password connections_createConnectionPathGrant_Response_200: type: object properties: {} title: connections_createConnectionPathGrant_Response_200 connections_testConnection_Response_200: type: object properties: read: $ref: '#/components/schemas/V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaRead' write: $ref: '#/components/schemas/V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaWrite' required: - read - write title: connections_testConnection_Response_200 V2ConnectionsConnectionIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission: oneOf: - $ref: '#/components/schemas/V2ConnectionsConnectionIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission0' - $ref: '#/components/schemas/V2ConnectionsConnectionIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission1' - $ref: '#/components/schemas/V2ConnectionsConnectionIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission2' description: The permission granted to the member title: V2ConnectionsConnectionIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType0: type: string enum: - aws_databricks title: V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType0 V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaInputTableAuditLogSchema: type: object properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform writebackSchemaId: type: string description: Unique identifier of the writebackSchema required: - database - schema description: Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection. title: V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaInputTableAuditLogSchema V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsWritebackSchemasItems: type: object properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform writebackSchemaId: type: string description: Unique identifier of the writebackSchema description: type: string description: Description for the write-back destination. required: - database - schema title: V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsWritebackSchemasItems V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType3: type: string enum: - azuread title: V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType3 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecretsSetupUser: type: object properties: username: type: string password: type: string role: type: string required: - username - password title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecretsSetupUser V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType9: type: string enum: - unknown title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType9 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4WriteAccess: type: object properties: writeSchema: type: string required: - writeSchema title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4WriteAccess V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType: oneOf: - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType0' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType1' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType2' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType3' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType4' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType5' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType6' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType7' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType8' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType9' description: OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsInputTableAuditLogSchema: type: object properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform writebackSchemaId: type: string description: Unique identifier of the writebackSchema required: - database - schema description: Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection. title: V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsInputTableAuditLogSchema V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType7: type: string enum: - ping title: V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType7 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1ClientSecret: oneOf: - type: string - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1ClientSecret1' description: Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1ClientSecret V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType0: type: string enum: - aws_databricks title: V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType0 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType1: type: string enum: - azure_databricks title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType1 V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType8: type: string enum: - snowflake title: V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType8 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonProperties: type: object properties: serviceNames: type: array items: type: string externalAccessIntegration: type: string description: Name of the Snowflake external access integration to enable for Python. warehouse: type: string description: Warehouse to use to run Python code. packages: type: string description: Comma-separated list of Python packages to install. description: Python configuration for this Snowflake connection. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonProperties connections_getInodeConnectionPath_Response_200: type: object properties: connectionId: type: string path: $ref: '#/components/schemas/V2ConnectionsPathsInodeIdGetResponsesContentApplicationJsonSchemaPath' required: - connectionId - path title: connections_getInodeConnectionPath_Response_200 connections_listConnectionGrants_Response_200: type: object properties: entries: type: array items: $ref: '#/components/schemas/V2ConnectionsConnectionIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItems' description: Array of results returned by the endpoint nextPage: type: - string - 'null' description: Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`. total: type: number format: double description: Total number of results. Useful to determine if there is a need to paginate. hasMore: type: boolean description: '**[Deprecated]** Indicates whether more results are available.' required: - entries - nextPage title: connections_listConnectionGrants_Response_200 V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType9: type: string enum: - unknown title: V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType9 V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType4: type: string enum: - auth0 title: V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType4 V2ConnectionsPathsInodeIdGetResponsesContentApplicationJsonSchemaPath: oneOf: - type: array items: type: string - type: array items: type: string - type: array items: type: string - type: array items: description: Any type title: V2ConnectionsPathsInodeIdGetResponsesContentApplicationJsonSchemaPath V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1ServiceAccount: oneOf: - type: string - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1ServiceAccount1' title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1ServiceAccount V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType2: type: string enum: - gcp_databricks title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType2 V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsPoolSizes: type: object properties: isPoolConfigured: type: boolean adhocPoolSize: type: number format: double catalogPoolSize: type: number format: double resultPoolSize: type: number format: double schedulePoolSize: type: number format: double description: Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize title: V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsPoolSizes V2ConnectionsConnectionIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee1: type: object properties: teamId: type: string required: - teamId description: The UUID of the team receiving the grant title: V2ConnectionsConnectionIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee1 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7Type: type: string enum: - starburst description: Starburst connection type. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7Type V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6WriteAccess: type: object properties: writeDatabase: type: string description: Database to contain tables written back to the data platform. writeSchema: type: string description: Schema to contain tables written back to the data platform. required: - writeDatabase - writeSchema description: Configure write-back for the connection. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6WriteAccess V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType6: type: string enum: - okta title: V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType6 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType9: type: string enum: - unknown title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType9 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5Type: type: string enum: - azuresql description: Azure SQL DB connection type. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5Type V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType8: type: string enum: - snowflake title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType8 V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType7: type: string enum: - ping title: V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType7 V2ConnectionsPathsConnectionPathIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: grantId: type: string description: The unique identifier of the grant inodeId: type: string description: The unique identifier of the inode organizationId: type: string description: The unique identifier of the organization memberId: type: - string - 'null' description: The unique identifier of the member teamId: type: - string - 'null' description: The unique identifier of the team permission: $ref: '#/components/schemas/V2ConnectionsPathsConnectionPathIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission' description: The permission granted to the member createdBy: type: string description: The identifier of the user who created this grant updatedBy: type: string description: The identifier of the user or process that last updated this grant createdAt: type: string format: date-time description: When the grant was created updatedAt: type: string format: date-time description: When the grant was last updated required: - grantId - inodeId - organizationId - memberId - teamId - permission - createdBy - updatedBy - createdAt - updatedAt title: V2ConnectionsPathsConnectionPathIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItems V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails2: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2Type' server: type: string account: type: string host: type: string warehouse: type: string role: type: string authType: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2AuthType' usePython: type: boolean pythonSecrets: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecrets' pythonProperties: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonProperties' description: Python configuration for this Snowflake connection. useSourceSwapPolicy: type: boolean sourceSwapPolicyId: type: string metadataUrl: type: string description: OAuth metadata URL for connection-level OAuth. clientId: type: string description: Client ID for the OAuth application used by this connection. clientSecret: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2ClientSecret' description: Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API. scopes: type: array items: type: string description: OAuth scopes to request when users authenticate to this connection. idpType: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType' description: OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown. usePkce: type: - boolean - 'null' description: Whether the OAuth flow should require Proof Key for Code Exchange (PKCE). Databricks-hosted OAuth providers require PKCE. useJwt: type: - boolean - 'null' description: Whether the OAuth flow should use JWT bearer token authentication instead of a client secret. exportsWarehouse: type: string description: Warehouse to use for export workloads. writeAccess: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess' description: Specify write access for non-OAuth connections userAttributes: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2UserAttributes' writebackSchemas: type: array items: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WritebackSchemasItems' description: Configure write-back for OAuth connections inputTableAuditLogSchema: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2InputTableAuditLogSchema' description: Specify a schema for input table write access logs roleSwitching: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2RoleSwitching' description: Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful when `useOauth` is true. required: - type description: Details of the Snowflake connection. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails2 V2ConnectionsPathsConnectionPathIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee1: type: object properties: teamId: type: string required: - teamId description: The UUID of the team receiving the grant title: V2ConnectionsPathsConnectionPathIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee1 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3WriteAccess: type: object properties: writeCatalog: type: string description: Catalog or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform required: - writeCatalog - writeSchema description: Configure write-back for non-OAuth connections title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3WriteAccess V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType: oneOf: - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType0' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType1' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType2' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType3' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType4' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType5' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType6' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType7' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType8' - $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType9' description: OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails5: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5Type' description: Azure SQL DB connection type. server: type: string description: Fully qualified server name or host. database: type: string description: Database to connect to on the Azure SQL DB server. port: type: number format: double description: Port for the database server. user: type: string description: Username used to authenticate to the database. password: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password' description: Password used to authenticate to the database. This value is write-only and is not returned by the API. useReadUncommittedIsolation: type: boolean description: Whether queries run with READ UNCOMMITTED transaction isolation. writeAccess: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5WriteAccess' description: Configure write-back for the connection. required: - type - server - database - port - user - password description: Details of the Azure SQL DB connection. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails5 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType: oneOf: - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType0' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType1' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType2' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType3' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType4' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType5' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType6' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType7' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType8' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType9' description: OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType connections_deleteConnectionGrant_Response_200: type: object properties: {} title: connections_deleteConnectionGrant_Response_200 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType8: type: string enum: - snowflake title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType8 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password2: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password2 V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaWrite1: type: string enum: - SUCCESS title: V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaWrite1 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password1: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7PasswordOneOf1Type' value: type: string required: - type - value title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password1 V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType9: type: string enum: - unknown title: V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType9 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password2: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password2 V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType8: type: string enum: - snowflake title: V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType8 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType7: type: string enum: - ping title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType7 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password1: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5PasswordOneOf1Type' value: type: string required: - type - value title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password1 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType8: type: string enum: - snowflake title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType8 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Type: type: string enum: - postgres - redshift - alloydb title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Type V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2AuthType: type: string enum: - basic-auth - key-pair - oauth title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2AuthType V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaInputTableAuditLogSchema: type: object properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform writebackSchemaId: type: string description: Unique identifier of the writebackSchema required: - database - schema description: Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection. title: V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaInputTableAuditLogSchema V2ConnectionsPostRequestBodyContentApplicationJsonSchemaPoolSizes: type: object properties: isPoolConfigured: type: boolean description: Whether custom connection pool sizes are configured. If any pool size is supplied without this field, the API stores it as true. adhocPoolSize: type: number format: double description: Pool size for ad hoc query workloads. schedulePoolSize: type: number format: double description: Pool size for scheduled workloads. catalogPoolSize: type: number format: double description: Pool size for catalog workloads. resultPoolSize: type: number format: double description: Pool size for result cache workloads. description: Connection pool sizes. Each pool bounds how many queries of a given type (ad hoc, scheduled, catalog, result cache) run concurrently against the warehouse. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaPoolSizes connections_listConnectionPaths_Response_200: type: object properties: entries: type: array items: $ref: '#/components/schemas/V2ConnectionsPathsGetResponsesContentApplicationJsonSchemaEntriesItems' description: Array of results returned by the endpoint nextPage: type: - string - 'null' description: Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`. total: type: number format: double description: Total number of results. Useful to determine if there is a need to paginate. hasMore: type: boolean description: '**[Deprecated]** Indicates whether more results are available.' required: - entries - nextPage title: connections_listConnectionPaths_Response_200 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType9: type: string enum: - unknown title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType9 V2ConnectionsPostResponsesContentApplicationJsonSchemaInputTableAuditLogSchema: type: object properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform writebackSchemaId: type: string description: Unique identifier of the writebackSchema required: - database - schema description: Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection. title: V2ConnectionsPostResponsesContentApplicationJsonSchemaInputTableAuditLogSchema V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaWritebackSchemasItems: type: object properties: database: type: string description: Database, catalog, or top-level object to contain tables written back to the data platform schema: type: string description: Schema, database, or second-level object to contain tables written back to the data platform writebackSchemaId: type: string description: Unique identifier of the writebackSchema description: type: string description: Description for the write-back destination. required: - database - schema title: V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaWritebackSchemasItems V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType5: type: string enum: - adfs title: V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType5 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType0: type: string enum: - aws_databricks title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType0 V2ConnectionsConnectionIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission2: type: string enum: - view - edit - apply description: 'Valid inode types: version tag.' title: V2ConnectionsConnectionIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission2 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4PasswordOneOf1Type: type: string enum: - plain title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4PasswordOneOf1Type V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails3: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3Type' host: type: string workspaceUrl: type: string useSourceSwapPolicy: type: boolean sourceSwapPolicyId: type: string metadataUrl: type: string description: OAuth metadata URL for connection-level OAuth. clientId: type: string description: Client ID for the OAuth application used by this connection. clientSecret: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3ClientSecret' description: Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API. scopes: type: array items: type: string description: OAuth scopes to request when users authenticate to this connection. idpType: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType' description: OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown. usePkce: type: - boolean - 'null' description: Whether the OAuth flow should require Proof Key for Code Exchange (PKCE). Databricks-hosted OAuth providers require PKCE. useJwt: type: - boolean - 'null' description: Whether the OAuth flow should use JWT bearer token authentication instead of a client secret. writeAccess: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3WriteAccess' description: Configure write-back for non-OAuth connections writebackSchemas: type: array items: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3WritebackSchemasItems' description: Configure write-back for OAuth connections inputTableAuditLogSchema: $ref: '#/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3InputTableAuditLogSchema' description: Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection. required: - type - host description: Details of the Databricks connection. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails3 V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaRead: oneOf: - $ref: '#/components/schemas/V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaRead0' - $ref: '#/components/schemas/V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaRead1' title: V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaRead V2ConnectionsPathsConnectionPathIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission0: type: string enum: - admin - annotate - update - usage - writeback description: 'Valid inode types: table, connection database, and connection schema.' title: V2ConnectionsPathsConnectionPathIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission0 V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType3: type: string enum: - azuread title: V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType3 connections_deleteConnection_Response_200: type: object properties: {} title: connections_deleteConnection_Response_200 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password: oneOf: - type: string - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password1' - $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password2' description: Password used to authenticate to the database. This value is write-only and is not returned by the API. title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType7: type: string enum: - ping title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType7 V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType4: type: string enum: - auth0 title: V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType4 V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType1: type: string enum: - azure_databricks title: V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType1 connections_createConnection_Response_201: type: object properties: organizationId: type: string description: Unique identifier of the organization connectionId: type: string description: Unique identifier of the connection isSample: type: boolean description: Whether the connection is the Sigma sample data connection isAuditLog: type: boolean description: Whether audit logging is enabled lastActiveAt: type: string format: date-time description: Last activity date and time name: type: string description: Name of the connection type: type: string description: Type of the connection (e.g., "bigQuery") useOauth: type: boolean description: Whether OAuth is used createdBy: type: string description: Identifier of the user who created this connection updatedBy: type: string description: Identifier of the user or process that last updated this connection createdAt: type: string format: date-time description: When the connection was created updatedAt: type: string format: date-time description: When the connection was last updated isArchived: type: boolean description: Whether the connection is archived account: type: string description: Account associated with the connection warehouse: type: string description: Warehouse associated with the connection user: type: string description: User associated with the connection httpPath: type: string description: For Databricks connections, HTTP path of the SQL warehouse. Not included when a user attribute sets the HTTP path. role: type: string description: Role used by the connection user timeout: $ref: '#/components/schemas/V2ConnectionsPostResponsesContentApplicationJsonSchemaTimeout' description: Timeout settings for the connection, with a default value in seconds poolSizes: $ref: '#/components/schemas/V2ConnectionsPostResponsesContentApplicationJsonSchemaPoolSizes' description: Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize writeAccess: type: boolean friendlyName: type: boolean description: Whether friendly names are enabled for this connection writebacks: type: array items: $ref: '#/components/schemas/V2ConnectionsPostResponsesContentApplicationJsonSchemaWritebacksItems' description: Configure write-back for non-OAuth connections writebackSchemas: type: array items: $ref: '#/components/schemas/V2ConnectionsPostResponsesContentApplicationJsonSchemaWritebackSchemasItems' description: Configure write-back for OAuth connections inputTableAuditLogSchema: $ref: '#/components/schemas/V2ConnectionsPostResponsesContentApplicationJsonSchemaInputTableAuditLogSchema' description: Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection. materializationWarehouse: type: string description: Warehouse used to run materialization jobs exportsWarehouse: type: string description: Warehouse used to run export jobs oauthMetadataUrl: type: string description: OAuth metadata URL configured directly on this connection. oauthClientId: type: string description: Client ID configured directly on this connection. oauthScopes: type: array items: type: string description: OAuth scopes configured directly on this connection. oauthIdpType: $ref: '#/components/schemas/V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType' description: OAuth provider type configured or inferred for this connection. oauthUsePkce: type: - boolean - 'null' description: Whether this connection-level OAuth configuration uses PKCE. oauthUseJwt: type: - boolean - 'null' description: Whether this connection-level OAuth configuration uses JWT bearer token authentication. oauthAudience: type: string description: Audience used for OAuth federation, such as the Google workforce identity federation audience for BigQuery. isIndependentOAuth: type: boolean description: Whether this connection uses connection-level OAuth instead of organization-level OAuth. userAttributes: $ref: '#/components/schemas/V2ConnectionsPostResponsesContentApplicationJsonSchemaUserAttributes' description: User attributes associated with the connection roleSwitching: $ref: '#/components/schemas/V2ConnectionsPostResponsesContentApplicationJsonSchemaRoleSwitching' description: Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful for Snowflake OAuth connections. required: - organizationId - connectionId - isSample - isAuditLog - lastActiveAt - name - type - useOauth - createdBy - updatedBy - createdAt - updatedAt title: connections_createConnection_Response_201 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3ClientSecret1: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3ClientSecret1 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType1: type: string enum: - azure_databricks title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType1 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7WriteAccess: type: object properties: writeCatalog: type: string description: Catalog to contain tables written back to the data platform. writeSchema: type: string description: Schema to contain tables written back to the data platform. required: - writeCatalog - writeSchema description: Configure write-back for the connection. title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7WriteAccess V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password1: type: object properties: type: $ref: '#/components/schemas/V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6PasswordOneOf1Type' value: type: string required: - type - value title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password1 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType2: type: string enum: - gcp_databricks title: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType2 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2ClientSecret1: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2ClientSecret1 V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType3: type: string enum: - azuread title: V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType3 V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess0: type: object properties: writeDatabase: type: string description: Database or top-level object to contain tables written back to the data platform writeSchema: type: string description: Schema or second-level object to contain tables written back to the data platform materializationWarehouse: type: string description: Warehouse to use for materialization workloads useDynamicTables: type: boolean description: Whether to use Snowflake dynamic tables for materialization workloads. required: - writeDatabase - writeSchema title: V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess0 V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaUserAttributes: type: object properties: role: type: string warehouse: type: string description: User attributes associated with the connection title: V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaUserAttributes securitySchemes: basicAuth: type: http scheme: basic bearerAuth: type: http scheme: bearer oauth2: type: oauth2 flows: clientCredentials: tokenUrl: /v2/auth/token refreshUrl: /v2/auth/token scopes: {} OAuth: type: http scheme: bearer description: OAuth 2.0 authentication x-refined-from: - sigma-computing-public-rest-api-openapi.json - sigma-computing-rest-api-openapi.yaml