Repository navigation
@W-24145082 - docs: document WIF connection fields and bulk kwargs - #1892
Merged
sushmasreedharan-tableau merged 1 commit intoOct 15, 2026
Conversation
Adds documentation on the gh-pages site for the WIF support added in PR tableau#1887: - ConnectionItem attribute table: new rows for workgroup_auth_mode and auth_federation_service_account, naming the ConnectionItem.WorkgroupAuthMode nested value set and its two values. - datasources.update_connection: WIF how-to with direct and impersonation examples plus the server-side usage rules. - datasources.update_connections (bulk): updated signature, new parameter rows, version note, and a WIF example. - flows.update_connection: short note that WIF fields reach the request via the shared Connection.update_req builder, with the caveat that server-side flow handling may differ. - workbooks.update_connection: WIF how-to mirroring the datasource section. - workbooks.update_connections (bulk): updated signature, new parameter rows, version note, and a WIF example. Requires REST API 3.30+ (Tableau Server release 26.3) with WIF configured on the site. Older servers silently ignore unknown connection attributes. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
bcantoni
approved these changes
Oct 15, 2026
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.
Motivation
Companion gh-pages docs PR for #1887 (
@W-24145082— WIF connection update support). That PR adds user-visible API surface thatdocs/api-ref.mddoesn't currently cover.What changes
All edits are confined to
docs/api-ref.md.ConnectionItemattribute table — new rows forworkgroup_auth_modeandauth_federation_service_account, naming theConnectionItem.WorkgroupAuthModenested value set and its two string values (WIF="workload-identity-federation",WIF_IMPERSONATION="workload-identity-federation-impersonation").datasources.update_connection— adds a "How-to: convert an existing connection to Workload Identity Federation (WIF)" section mirroring the existing Snowflake keypair how-to, with direct (Snowflake) and impersonation (Google BigQuery) examples plus the server-enforced usage rules.datasources.update_connections(bulk) — updated signature line, newworkgroup_auth_modeandauth_federation_service_accountparameter rows, a version note that these parameters require REST API 3.30+, and a WIF (impersonation) example.flows.update_connection— short note that WIF fields reach the request payload via the sharedConnection.update_reqbuilder, with the caveat that server-side handling of WIF on flow connections is governed by the flow endpoint and may differ from workbook and datasource behavior.workbooks.update_connection— WIF how-to mirroring the datasource section.workbooks.update_connections(bulk) — updated signature line, new parameter rows, version note, and a WIF (direct) example.Usage rules documented verbatim from the companion PR body and CHANGELOG:
workgroup_auth_modeon every subsequent update of a WIF connection; omitting it on a later update returns HTTP 400.auth_typeunset or"oauth"when sending a WIF mode; the server derives the stored auth type from the mode.auth_federation_service_accountonly withWorkgroupAuthMode.WIF_IMPERSONATION.workgroupAuthModeorauthFederationServiceAccounton connections-GET responses today, so parsed values are typicallyNoneeven when the connection is WIF-configured.Requires REST API 3.30+ (Tableau Server release 26.3) with WIF configured and enabled on the site. Older servers silently ignore unknown connection attributes.
Non-changes
docs/api-ref.md.datasources.update_connectionsection earlier in the file (that's a separate cleanup, out of scope for this doc update).🤖 Generated with Claude Code