> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://help.sigmacomputing.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://help.sigmacomputing.com/_mcp/server. # Update a connection PUT https://api.sigmacomputing.com/v2/connections/{connectionId} Content-Type: application/json 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. ### Usage notes - To restore a deleted connection, pass the `restore` parameter. - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint. Reference: https://help.sigmacomputing.com/reference/update-connection ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: sigma-rest-api version: 1.0.0 paths: /v2/connections/{connectionId}: put: operationId: updateConnection 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. ### Usage notes - To restore a deleted connection, pass the `restore` parameter. - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint. tags: - Connections parameters: - name: connectionId in: path required: true schema: type: string - name: Authorization in: header description: OAuth authentication required: true schema: type: string responses: '200': description: The response body. content: application/json: schema: $ref: '#/components/schemas/connections_updateConnection_Response_200' requestBody: description: The request body. content: application/json: schema: type: object properties: details: $ref: >- #/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails name: type: string description: type: object additionalProperties: description: Any type timeoutSecs: type: number format: double useFriendlyNames: type: boolean restore: type: boolean required: - details - name 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: schemas: V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Type: type: string enum: - postgres - redshift - alloydb title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Type V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0PasswordOneOf1Type: type: string enum: - plain title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0PasswordOneOf1Type V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password1: type: object properties: type: $ref: >- #/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0PasswordOneOf1Type value: type: string required: - type - value title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password1 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password2: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password2 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password: oneOf: - type: string - $ref: >- #/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password1 - $ref: >- #/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password2 title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0WriteAccess: type: object properties: writeSchema: type: string required: - writeSchema title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0WriteAccess 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 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1Type: type: string enum: - bigQuery title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1Type V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1ServiceAccount1: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1ServiceAccount1 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1ServiceAccount: oneOf: - type: string - $ref: >- #/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1ServiceAccount1 title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1ServiceAccount V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1ClientSecret1: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1ClientSecret1 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 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType0: type: string enum: - aws_databricks title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType0 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType1: type: string enum: - azure_databricks title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType1 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType2: type: string enum: - gcp_databricks title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType2 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType3: type: string enum: - azuread title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType3 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType4: type: string enum: - auth0 title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType4 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType5: type: string enum: - adfs title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType5 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType6: type: string enum: - okta title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType6 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType7: type: string enum: - ping title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType7 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType8: type: string enum: - snowflake title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType8 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType9: type: string enum: - unknown title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType9 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 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1WriteAccess: type: object properties: writeProject: type: string writeDataset: type: string required: - writeProject - writeDataset title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1WriteAccess 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 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2Type: type: string enum: - snowflake title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2Type V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2AuthType: type: string enum: - basic-auth - key-pair - oauth title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2AuthType V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecretsSetupUser: type: object properties: username: type: string password: type: string role: type: string required: - username - password title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecretsSetupUser V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecretsPythonUser: type: object properties: username: type: string password: type: string role: type: string required: - username - password title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecretsPythonUser V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecrets: type: object properties: setupUser: $ref: >- #/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecretsSetupUser pythonUser: $ref: >- #/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecretsPythonUser title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecrets V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonProperties: type: object properties: serviceNames: type: array items: type: string title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonProperties V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2ClientSecret1: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2ClientSecret1 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 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType0: type: string enum: - aws_databricks title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType0 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType1: type: string enum: - azure_databricks title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType1 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType2: type: string enum: - gcp_databricks title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType2 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType3: type: string enum: - azuread title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType3 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType4: type: string enum: - auth0 title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType4 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType5: type: string enum: - adfs title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType5 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType6: type: string enum: - okta title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType6 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType7: type: string enum: - ping title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType7 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType8: type: string enum: - snowflake title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType8 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType9: type: string enum: - unknown title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType9 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 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 required: - writeDatabase - writeSchema title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess0 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess1: type: object properties: materializationWarehouse: type: string description: Warehouse to use for materialization workloads title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess1 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess: oneOf: - $ref: >- #/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess0 - $ref: >- #/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess1 description: Specify write access for non-OAuth connections title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2UserAttributes: type: object properties: role: type: string warehouse: type: string title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2UserAttributes 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 writebackSchema required: - writeDatabase - writeSchema title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WritebackSchemasItems 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 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 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 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 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3Type: type: string enum: - databricks title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3Type V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3ClientSecret1: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3ClientSecret1 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 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType0: type: string enum: - aws_databricks title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType0 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType1: type: string enum: - azure_databricks title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType1 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType2: type: string enum: - gcp_databricks title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType2 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType3: type: string enum: - azuread title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType3 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType4: type: string enum: - auth0 title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType4 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType5: type: string enum: - adfs title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType5 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType6: type: string enum: - okta title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType6 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType7: type: string enum: - ping title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType7 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType8: type: string enum: - snowflake title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType8 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType9: type: string enum: - unknown title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType9 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 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 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 writebackSchema required: - writeCatalog - writeSchema title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3WritebackSchemasItems 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 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 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Type: type: string enum: - mysql title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Type V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4PasswordOneOf1Type: type: string enum: - plain title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4PasswordOneOf1Type V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password1: type: object properties: type: $ref: >- #/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4PasswordOneOf1Type value: type: string required: - type - value title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password1 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password2: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password2 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password: oneOf: - type: string - $ref: >- #/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password1 - $ref: >- #/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password2 title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4WriteAccess: type: object properties: writeSchema: type: string required: - writeSchema title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4WriteAccess 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 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5Type: type: string enum: - azuresql description: Azure SQL DB connection type. title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5Type V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5PasswordOneOf1Type: type: string enum: - plain title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5PasswordOneOf1Type V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password1: type: object properties: type: $ref: >- #/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5PasswordOneOf1Type value: type: string required: - type - value title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password1 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password2: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password2 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 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 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 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6Type: type: string enum: - sqlserver description: SQL Server connection type. title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6Type V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6PasswordOneOf1Type: type: string enum: - plain title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6PasswordOneOf1Type V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password1: type: object properties: type: $ref: >- #/components/schemas/V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6PasswordOneOf1Type value: type: string required: - type - value title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password1 V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password2: type: object properties: secretManagerId: type: string secretId: type: string required: - secretManagerId - secretId title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password2 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 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 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 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 title: >- V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails 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 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 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 required: - database - schema title: >- V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaWritebacksItems 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 required: - database - schema title: >- V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaWritebackSchemasItems 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 V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType0: type: string enum: - aws_databricks title: >- V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType0 V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType1: type: string enum: - azure_databricks title: >- V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType1 V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType2: type: string enum: - gcp_databricks title: >- V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType2 V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType3: type: string enum: - azuread title: >- V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType3 V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType4: type: string enum: - auth0 title: >- V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType4 V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType5: type: string enum: - adfs title: >- V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType5 V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType6: type: string enum: - okta title: >- V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType6 V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType7: type: string enum: - ping title: >- V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType7 V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType8: type: string enum: - snowflake title: >- V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType8 V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType9: type: string enum: - unknown title: >- V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType9 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 V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaUserAttributes: type: object properties: role: type: string warehouse: type: string description: User attributes associated with the connection title: >- V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaUserAttributes 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 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 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 securitySchemes: OAuth: type: http scheme: bearer description: OAuth 2.0 authentication ``` ## Examples **Request** ```json { "details": { "database": "string", "host": "string", "type": "postgres" }, "name": "string" } ``` **Response** ```json { "organizationId": "string", "connectionId": "string", "isSample": true, "isAuditLog": true, "lastActiveAt": "2024-01-15T09:30:00Z", "name": "string", "type": "string", "useOauth": true, "createdBy": "string", "updatedBy": "string", "createdAt": "2024-01-15T09:30:00Z", "updatedAt": "2024-01-15T09:30:00Z", "isArchived": true, "account": "string", "warehouse": "string", "user": "string", "role": "string", "timeout": { "default": 1.1, "worksheet": 1.1, "dashboard": 1.1, "download": 1.1 }, "poolSizes": { "isPoolConfigured": true, "adhocPoolSize": 1.1, "catalogPoolSize": 1.1, "resultPoolSize": 1.1, "schedulePoolSize": 1.1 }, "writeAccess": true, "friendlyName": true, "writebacks": [ { "database": "string", "schema": "string", "writebackSchemaId": "string" } ], "writebackSchemas": [ { "database": "string", "schema": "string", "writebackSchemaId": "string" } ], "inputTableAuditLogSchema": { "database": "string", "schema": "string", "writebackSchemaId": "string" }, "materializationWarehouse": "string", "exportsWarehouse": "string", "oauthMetadataUrl": "string", "oauthClientId": "string", "oauthScopes": [ "string" ], "oauthIdpType": "aws_databricks", "oauthUsePkce": true, "oauthUseJwt": true, "oauthAudience": "string", "isIndependentOAuth": true, "userAttributes": { "role": "string", "warehouse": "string" }, "roleSwitching": "allRoles" } ``` **SDK Code** ```python import requests url = "https://api.sigmacomputing.com/v2/connections/connectionId" payload = { "details": { "database": "string", "host": "string", "type": "postgres" }, "name": "string" } headers = { "Authorization": ".", "Content-Type": "application/json" } response = requests.put(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.sigmacomputing.com/v2/connections/connectionId'; const options = { method: 'PUT', headers: {Authorization: '.', 'Content-Type': 'application/json'}, body: '{"details":{"database":"string","host":"string","type":"postgres"},"name":"string"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.sigmacomputing.com/v2/connections/connectionId" payload := strings.NewReader("{\n \"details\": {\n \"database\": \"string\",\n \"host\": \"string\",\n \"type\": \"postgres\"\n },\n \"name\": \"string\"\n}") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("Authorization", ".") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.sigmacomputing.com/v2/connections/connectionId") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Put.new(url) request["Authorization"] = '.' request["Content-Type"] = 'application/json' request.body = "{\n \"details\": {\n \"database\": \"string\",\n \"host\": \"string\",\n \"type\": \"postgres\"\n },\n \"name\": \"string\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.put("https://api.sigmacomputing.com/v2/connections/connectionId") .header("Authorization", ".") .header("Content-Type", "application/json") .body("{\n \"details\": {\n \"database\": \"string\",\n \"host\": \"string\",\n \"type\": \"postgres\"\n },\n \"name\": \"string\"\n}") .asString(); ``` ```php request('PUT', 'https://api.sigmacomputing.com/v2/connections/connectionId', [ 'body' => '{ "details": { "database": "string", "host": "string", "type": "postgres" }, "name": "string" }', 'headers' => [ 'Authorization' => '.', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.sigmacomputing.com/v2/connections/connectionId"); var request = new RestRequest(Method.PUT); request.AddHeader("Authorization", "."); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"details\": {\n \"database\": \"string\",\n \"host\": \"string\",\n \"type\": \"postgres\"\n },\n \"name\": \"string\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": ".", "Content-Type": "application/json" ] let parameters = [ "details": [ "database": "string", "host": "string", "type": "postgres" ], "name": "string" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.sigmacomputing.com/v2/connections/connectionId")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PUT" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```