Update a connection

Deprecated

PATCH

/v2/connections/:connectionId

PATCH

/v2/connections/:connectionId

$ curl -X PATCH https://api.sigmacomputing.com/v2/connections/connectionId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

200Updated

1 {
2   "organizationId": "org-9f8b7c6d5e4a3b2c1d0e",
3   "connectionId": "conn-1234567890abcdef",
4   "isSample": false,
5   "isAuditLog": true,
6   "lastActiveAt": "2024-04-20T14:45:00Z",
7   "name": "Sales Data Warehouse",
8   "type": "snowflake",
9   "useOauth": true,
10   "createdBy": "user-9876543210fedcba",
11   "updatedBy": "user-1234567890abcdef",
12   "createdAt": "2023-11-10T08:00:00Z",
13   "updatedAt": "2024-04-15T12:30:00Z",
14   "isArchived": false,
15   "account": "sales_account_01",
16   "warehouse": "analytics_wh",
17   "user": "analytics_user",
18   "role": "read_only",
19   "timeout": {
20     "default": 120,
21     "worksheet": 180,
22     "dashboard": 300,
23     "download": 600
24   },
25   "poolSizes": {
26     "isPoolConfigured": true,
27     "adhocPoolSize": 10,
28     "catalogPoolSize": 5,
29     "resultPoolSize": 15,
30     "schedulePoolSize": 8
31   },
32   "writeAccess": false,
33   "friendlyName": true,
34   "writebacks": [
35     {
36       "database": "sales_db",
37       "schema": "writeback_schema",
38       "writebackSchemaId": "wb-schema-001"
39     }
40   ],
41   "writebackSchemas": [
42     {
43       "database": "sales_db",
44       "schema": "oauth_writeback_schema",
45       "writebackSchemaId": "wb-schema-oauth-01"
46     }
47   ],
48   "inputTableAuditLogSchema": {
49     "database": "audit_db",
50     "schema": "audit_log_schema",
51     "writebackSchemaId": "audit-schema-01"
52   },
53   "materializationWarehouse": "materialization_wh",
54   "exportsWarehouse": "export_wh",
55   "oauthMetadataUrl": "https://auth.example.com/.well-known/openid-configuration",
56   "oauthClientId": "client-abc123xyz",
57   "oauthScopes": [
58     "openid",
59     "profile",
60     "email"
61   ],
62   "oauthIdpType": "aws_databricks",
63   "oauthUsePkce": true,
64   "oauthUseJwt": false,
65   "oauthAudience": "https://api.sigmacomputing.com",
66   "isIndependentOAuth": false,
67   "userAttributes": {
68     "role": "data_analyst",
69     "warehouse": "analytics_wh"
70   },
71   "roleSwitching": "allRoles"
72 }

Update the metadata of a specific connection. This endpoint is deprecated. Instead, use the PUT endpoint.

Update the metadata of a specific connection. This endpoint is deprecated. Instead, use the [PUT endpoint](https://help.sigmacomputing.com/reference/updateconnection).

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

connectionIdstringRequired

Request

The request body.

namestringOptional

useOauthbooleanOptional

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

isArchivedboolean

Whether the connection is archived

accountstring

Account associated with the connection

warehousestring

Warehouse associated with the connection

userstring

User associated with the connection

rolestring

Role used by the connection user

timeoutobject

Timeout settings for the connection, with a default value in seconds

poolSizesobject

Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize

writeAccessboolean

friendlyNameboolean

Whether friendly names are enabled for this connection

writebackslist of objects

Configure write-back for non-OAuth connections

writebackSchemaslist of objects

Configure write-back for OAuth connections

inputTableAuditLogSchemaobject

Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on 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.

oauthScopeslist of strings

OAuth scopes configured directly on this connection.

oauthIdpTypeenum

OAuth provider type configured or inferred for this connection.

oauthUsePkceboolean or null

Whether this connection-level OAuth configuration uses PKCE.

oauthUseJwtboolean or null

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

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.

userAttributesobject

User attributes associated with the connection

roleSwitchingenum

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