SIsigmacomputing
Connections

Update a connection

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} endpoint.

Usage notes

  • To restore a deleted connection, pass the restore parameter.
  • Retrieve the connectionId by calling the /v2/connections endpoint.
  • To sign JWT bearer assertions with a JWK set, pass its jwkSetId. Retrieve it by calling the /v2/jsonWebKeys endpoint.
put/v2/connections/{connectionId}

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

connectionIdstring required

Request body

namestring required
descriptionobject
timeoutSecsnumber double
useFriendlyNamesboolean
restoreboolean

Response

The response body.

organizationIdstring required

Unique identifier of the organization

connectionIdstring required

Unique identifier of the connection

isSampleboolean required

Whether the connection is the Sigma sample data connection

isAuditLogboolean required

Whether audit logging is enabled

lastActiveAtstring date-time required

Last activity date and time

namestring required

Name of the connection

typestring required

Type of the connection (e.g., "bigQuery")

useOauthboolean required

Whether OAuth is used

createdBystring required

Identifier of the user who created this connection

updatedBystring required

Identifier of the user or process that last updated this connection

createdAtstring date-time required

When the connection was created

updatedAtstring date-time required

When the connection was last updated

isArchivedboolean

Whether the connection is archived

accountstring

Account associated with the connection

warehousestring

Warehouse associated with the connection

userstring

User associated with the connection

httpPathstring

For Databricks connections, HTTP path of the SQL warehouse. Not included when a user attribute sets the HTTP path.

rolestring

Role used by the connection user

writeAccessboolean
friendlyNameboolean

Whether friendly names are enabled for this connection

materializationWarehousestring

Warehouse used to run materialization jobs

exportsWarehousestring

Warehouse used to run export jobs

oauthMetadataUrlstring

OAuth metadata URL configured directly on this connection.

oauthClientIdstring

Client ID configured directly on this connection.

oauthScopesstring[]

OAuth scopes configured directly on this connection.

oauthUsePkceboolean nullable

Whether this connection-level OAuth configuration uses PKCE.

oauthUseJwtboolean nullable

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

oauthJwkSetIdstring

Unique identifier of the JWK set used to sign JWT bearer assertions for this connection.

oauthAudiencestring

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

isIndependentOAuthboolean

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

roleSwitching'allRoles' | 'disabled'

Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only relevant for Snowflake OAuth connections.

enableHiveMetastoreboolean

Whether this Databricks connection exposes the hive_metastore catalog in Sigma. Only relevant for Databricks connections.

usePythonboolean
pythonComputeClusterIdstring

ID of the all-purpose compute cluster used to run Python queries. Only relevant for Databricks connections with Python enabled.

Changes

No recorded changes to this operation across all 1 revision of this API.