Custom OAuth Clients

This connector supports the Tableau Integrated Azure AD auth scheme. It is recommended for multi-user Tableau deployments because it simplifies sharing data sources between users. Instead of creating per-user data sources and managing OAuth tokens manually, Tableau Server allows each user to connect to data sources with their own login.

Tableau-integrated auth supports custom OAuth apps but requires special configuration. You must create an OAuth config file and register it with Tableau. This config file includes the application client ID and secret, a list of scopes, as well as other Tableau-specific OAuth options. See the Tableau Connector SDK documentation for a full list of supported options and OAuth capabilities.

The connector includes a sample configuration file called customOAuthExample.xml in the installation directory. It is based on the OAuth config used by the connector's embedded OAuth app, but with some sensitive details removed. Create a copy of this file and apply these changes to make it work with your custom OAuth app:

1. Change oauthConfigId. This can be anything, it is just a unique value that identifies your OAuth config.
2. Change clientIdDesktop to the client ID of your OAuth app. Do the same for clientSecretDesktop if your OAuth app requires a client secret.
3. Check if authUri is a complete URL or just a path. If authUri is a path, you must update authUri and tokenUri to include the base URL of your identity provider. For example, if authUri is /authorize and your IdP is Azure AD, update authUri to https://login.microsoft.com/TENANT/authorize. Make sure that the new value ends in the old value.

Once the OAuth config is complete, deploy it to either Tableau Desktop, Tableau Prep Builder, or Tableau Server.

Tableau Desktop and Tableau Prep Builder

Move the file into the OAuthConfigs folder in your Tableau repository. When you restart Tableau, the connection window includes a new field called OAuth Config Id. The default starts with builtin_ but you can change it to select different OAuth configs. Pick the one that matches the oauthConfigId element from your config.

Tableau Server

1. Sign into the Tableau Server site as an administrator and open the Settings page.
2. Navigate to the OAuth Clients Registry and click Add OAuth Client.
3. Find the Connection Type for Azure DevOps and select Custom IdP as the OAuth Type.
4. Upload the OAuth config XML file.