docs: expand update_connection_auth sample header for Snowflake keypair - #1844
Open
jacalata wants to merge 1 commit into
Open
docs: expand update_connection_auth sample header for Snowflake keypair#1844jacalata wants to merge 1 commit into
jacalata wants to merge 1 commit into
Conversation
Adds samples/update_connection_to_keypair.py demonstrating how to convert an existing Tableau Cloud datasource or workbook connection from username/password to Snowflake keypair authentication using the REST API v3.27 flow. Documents the prerequisite that the private key must first be saved under Site Settings -> Saved Credentials for Data Sources on the site. Refs tableau#1602 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This was referenced Jul 30, 2026
jacalata
changed the title
There was a problem hiding this comment.
Pull request overview
This PR aims to improve guidance for converting Tableau Cloud content connections from Snowflake username/password authentication to Snowflake keypair authentication, addressing the request in #1602 with an end-to-end example.
Changes:
- Adds a new sample script that updates a datasource/workbook connection to
auth-keypairand setsembed_password=True. - Documents prerequisites and version support within the sample’s header comments.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+1
to
+4
| #### | ||
| # This script demonstrates how to convert an existing Tableau Cloud connection | ||
| # from username/password authentication to Snowflake keypair authentication. | ||
| # |
Comment on lines
+36
to
+37
| parser.add_argument("--token-name", "-p", help="name of the personal access token used to sign into the server") | ||
| parser.add_argument("--token-value", "-v", help="value of the personal access token used to sign into the server") |
Comment on lines
+7
to
+10
| # sample. Tableau Cloud stores the private key at the site level, keyed on | ||
| # (server address, username). If the credential has not been saved first, the | ||
| # update will succeed but subsequent extract refreshes / connection tests will | ||
| # fail authentication. |
Comment on lines
+12
to
+13
| # Supported since REST API v3.27. | ||
| # See: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_data_sources.htm#update_data_source_connection |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #1602.
Motivation
#1602 asked for an end-to-end example of converting a Tableau Cloud
datasource or workbook connection from Snowflake username/password auth
to keypair auth. The existing
update_connection_auth.pyalready runsthe right code path -- it takes
authentication_typeas an arg andsets
embed_password=True. What it was missing was context: whichauthentication_typestrings are common, and the pre-saved-credentialprerequisite that applies to any embed_password conversion.
Initial draft of this PR added a dedicated keypair sample; folded that
into a header-comment update on
update_connection_auth.pyafternoticing the code duplication. See 949d602 for the fold-in.
Behavior change
Samples only -- no library changes. Adds a ~25-line header comment to
samples/update_connection_auth.py:authentication_typevalues includingauth-keypair,oauth,AD Service Principal,sqlserver, andUsername Passwordembed_password=Truebinds the connection to amatching pre-saved credential on the site, looked up by
(username, connection class, role)
be saved on the site under Site Settings -> Saved Credentials for
Data Sources before the sample runs. Without it, the update writes
the new auth type into metadata but subsequent extract refreshes
and connection tests fail.
connections, v3.28 for flows)
Test plan
Docs-only change to a sample; no automated tests exist for
samples/.python samples/update_connection_auth.py --helpstill shows thesame args (help output unchanged)
private-key credential, run the sample with
authentication_type=auth-keypair; connection'sauth_typeflipsand extract refresh succeeds
post-update as documented
🤖 Generated with Claude Code