Sigma REST APIConnections

Create a connection

View as Markdown
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).

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

The request body.
detailsobjectRequired
namestringRequired
descriptionmap from strings to anyOptional
poolSizesobjectOptional

Connection pool sizes. Each pool bounds how many queries of a given type (ad hoc, scheduled, catalog, result cache) run concurrently against the warehouse.

timeoutSecsdoubleOptional
useFriendlyNamesbooleanOptional

Response

The response body.
organizationIdstring
Unique identifier of the organization
connectionIdstring
Unique identifier of the connection
isSampleboolean
Whether the connection is the Sigma sample data connection
isAuditLogboolean
Whether audit logging is enabled
lastActiveAtdatetime
Last activity date and time
namestring
Name of the connection
typestring

Type of the connection (e.g., “bigQuery”)

useOauthboolean
Whether OAuth is used
createdBystring
Identifier of the user who created this connection
updatedBystring
Identifier of the user or process that last updated this connection
createdAtdatetime
When the connection was created
updatedAtdatetime
When the connection was last updated
isArchivedbooleanOptional
Whether the connection is archived
accountstringOptional
Account associated with the connection
warehousestringOptional
Warehouse associated with the connection
userstringOptional
User associated with the connection
rolestringOptional
Role used by the connection user
timeoutobjectOptional
Timeout settings for the connection, with a default value in seconds
poolSizesobjectOptional
Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize
writeAccessbooleanOptional
friendlyNamebooleanOptional
Whether friendly names are enabled for this connection
writebackslist of objectsOptional

Configure write-back for non-OAuth connections

writebackSchemaslist of objectsOptional

Configure write-back for OAuth connections

inputTableAuditLogSchemaobjectOptional

Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection.

materializationWarehousestringOptional
Warehouse used to run materialization jobs
exportsWarehousestringOptional
Warehouse used to run export jobs
oauthMetadataUrlstringOptional
OAuth metadata URL configured directly on this connection.
oauthClientIdstringOptional
Client ID configured directly on this connection.
oauthScopeslist of stringsOptional
OAuth scopes configured directly on this connection.
oauthIdpTypeenumOptional
OAuth provider type configured or inferred for this connection.
oauthUsePkceboolean or nullOptional

Whether this connection-level OAuth configuration uses PKCE.

oauthUseJwtboolean or nullOptional

Whether this connection-level OAuth configuration uses JWT bearer token authentication.

oauthAudiencestringOptional
Audience used for OAuth federation, such as the Google workforce identity federation audience for BigQuery.
isIndependentOAuthbooleanOptional

Whether this connection uses connection-level OAuth instead of organization-level OAuth.

userAttributesobjectOptional
User attributes associated with the connection
roleSwitchingenumOptional
Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful for Snowflake OAuth connections.