Skip to content

docs: add Snowflake keypair auth conversion how-to - #1845

Open
jacalata wants to merge 1 commit into
tableau:gh-pagesfrom
jacalata:jac/docs-keypair-howto
Open

docs: add Snowflake keypair auth conversion how-to#1845
jacalata wants to merge 1 commit into
tableau:gh-pagesfrom
jacalata:jac/docs-keypair-howto

Conversation

@jacalata

Copy link
Copy Markdown
Contributor

Summary

Adds a short how-to block under datasources.update_connection in docs/api-ref.md describing how to convert an existing connection from username/password authentication to Snowflake keypair authentication.

  • States REST API v3.27+ support.
  • Documents the prerequisite: save the private key on the site under Site Settings -> Saved Credentials for Data Sources.
  • Includes a compact runnable snippet using the existing auth_type / username / embed_password fields on ConnectionItem.
  • Links to the paired runnable sample samples/update_connection_to_keypair.py (added in feat: add sample for converting connection auth to Snowflake keypair #1844) and the Tableau REST API authenticationType reference.

Closes #1602 (paired with #1844 on development).

Test plan

Refs #1602

🤖 Generated with Claude Code

Adds a short how-to under datasources.update_connection describing
how to flip an existing connection from username/password to Snowflake
keypair authentication (REST API v3.27+), including the prerequisite
of saving the private key under Site Settings -> Saved Credentials for
Data Sources. Links to the new samples/update_connection_to_keypair.py
runnable sample.

Refs tableau#1602

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant