Set Up the Tableau App for Microsoft Teams

Applies to: Tableau Cloud, Tableau Server

The Tableau app for Microsoft Teams lets your users interact with Tableau views (visualizations) and metrics without leaving their flow of work. As a Tableau admin, you install and configure the app to connect your existing Tableau site with your Microsoft Teams deployment. You can install the app for Tableau Cloud directly from the Microsoft apps Marketplace. To install the app for Tableau Server, you download and side load the app.

For information about using the Tableau app for Microsoft Teams, see Access Tableau Content in Microsoft Teams. This article is about setting up the Tableau App.

See also

Prerequisites

To set up the Tableau app for Microsoft Teams, you need the following apps and accounts.

  • Tableau Cloud or Tableau Server version 2023.1 or later
  • A site admin account for Tableau Cloud or a server admin account for Tableau Server
  • A Microsoft 365 for Enterprise subscription
  • Microsoft Teams
  • A Microsoft 365 admin account, if your organization's policies require an admin account to install apps
  • User licenses for both Tableau and Microsoft Teams that are mapped to each other based on one of the user mapping attributes

User mapping attributes

To allow for single sign-on with Tableau, you map the user accounts in Microsoft Teams to the user accounts in Tableau. You can set up this mapping using attributes from either the Microsoft Teams SDK or from a user's Microsoft Entra profile.

Microsoft Teams SDK attributes

Attribute Description
Preferred_Username(Link opens in a new window) The Microsoft Teams user's email address. In some cases, this value differs from the email defined in Microsoft Entra.
User Principal Name(Link opens in a new window) The primary way users log in to Microsoft Entra.

Microsoft Entra profile attributes

Attribute Description
Primary Email(Link opens in a new window) Corresponds to the user.mail attribute and represents the user's email address.
Mail Nickname(Link opens in a new window) Corresponds to the user.mailNickname attribute and represents an alias for the user.
Employee ID(Link opens in a new window) Corresponds to the user.employeeId attribute and represents an employee identifier assigned by the organization.
On-Premise Distinguished Name(Link opens in a new window) Corresponds to the user.onPremiseDistinguishedName attribute and represents the distinguished name (DN) synced from an on-premise Active Directory.
On-Premise User Principal Name(Link opens in a new window) Corresponds to the user.onPremiseUserPrincipalName attribute and represents the userPrincipalName synced from an on-premise Active Directory.
On-premise SAM Account Name(Link opens in a new window) Corresponds to the user.onPremiseSamAccountName attribute and represents the samAccountName synced from an on-premise Active Directory.
Extension Attribute X(Link opens in a new window) Microsoft Entra lets you add up to 15 extra attributes to a user's Entra profile. If the Tableau user name doesn’t exist in Microsoft Entra, use an extension attribute to store the Tableau user name for each Entra user.

Additional prerequisites for Tableau Server

The Tableau app uses API calls to communicate with Tableau Server and embed interactive content. These calls must be able to reach Tableau Server.

  • If Tableau Server is behind a firewall, allow incoming HTTP requests from the IP ranges 4.152.0.0/15 and 20.2.0.0/16.
  • Make sure that users can access Tableau Server the same way that they access Microsoft Teams.
    • If users must be on a VPN to access Microsoft Teams, then Tableau Server must be accessible from the same VPN.
    • If users can access Microsoft Teams from the public internet, then Tableau Server must be accessible from the public internet.
    • If users can access Microsoft Teams via mobile apps, then Tableau Server must be accessible from mobile devices.

Install the Tableau app for Tableau Server

To install the Tableau app for Tableau Server, you edit the app manifest to customize the host name then upload the app manifest to Microsoft Teams.

To install the Tableau app for Tableau Cloud, see the Tableau Cloud set up guide.

1. Download and edit the app manifest

  1. From GitHub, download the app manifest.

  2. Extract the files from the manifest file tableau-server-app-for-teams.zip.

  3. Open the file manifest.json in a text editor.

  4. Search manifest.json for *.online.tableau.com and replace that domain with the host name of your Tableau Server environment. If your Tableau Server URL is https://analytics.company.com, then the host name would be analytics.company.com.

  5. Save your changes to manifest.json.

  6. Compress the files in the tableau-app-for-teams-server folder to create a zip file that includes your changes.

2. Upload the app manifest

Your organization’s app policies determine whether you’re able to install Microsoft Teams apps. A Microsoft 365 admin account might be required to install apps.

  1. Open the Microsoft Teams admin center(Link opens in a new window).

  2. From the navigation panel, select Teams apps > Manage apps.

  3. Select Actions > Upload new app.

  4. Upload the tableau-server-app-for-teams.zip file that you edited. You receive a confirmation message with a link to manage the app.

3. Install and pin the app for your users

You can install the app to make it available to all, or a subset, of your users. You can also pin the app so it appears in the app bar for your users.

  1. Open the Microsoft Teams admin center(Link opens in a new window).

  2. From the navigation panel, select Teams apps > Setup policies.

  3. Under Installed apps, select Add apps, then add the Tableau app.

  4. Optionally, under Pinned apps, select Add apps, then add the Tableau app.

  5. Save your changes.

After you add the Tableau app, it might take up to 24 hours for the app to be available to your users.

Configure the Tableau app

After you install the Tableau app, Microsoft Teams prompts you to set up the app. You configure your site information to connect the app to your Tableau site.

1. Create a connected app

The Tableau app for Microsoft Teams uses a connected app to authenticate users with single sign-on. You create this connected app in Tableau Cloud or Tableau Server.

  1. In Tableau Cloud or Tableau Server, create a direct trust connected app. For more information, see Configure Connected Apps with Direct Trust for Tableau Cloud or Configure Connected Apps with Direct Trust for Tableau Server(Link opens in a new window).

    • If you limit the domain allowlist for the connected app to only specified domains, add the following domains to the allowlist.
      • tableau-ms-teams-prod-gycea7csh5hsbfh5.a02.azurefd.net
      • teams.microsoft.com
      • *.teams.microsoft.com
    • If your users will access the app from other Microsoft platforms, add additional domains from the list of Microsoft 365 URLs(Link opens in a new window).

  2. Enable the connected app.

  3. Generate a connected app secret.

  4. Copy the connected app client ID, secret ID, and secret value. Save these values. You will need them when you configure your Tableau site in Microsoft Teams.

2. Add your site configuration to the Tableau app

When you open the Tableau app, if you haven’t yet configured the app, you see a set up screen.

  1. For the Label, give the site a name. This name appears to users of the Microsoft Teams app. If you don’t enter a label, the app displays the site name. This field is optional.

  2. For the Tableau Site Name, enter the name as it appears in the URL for your site. For example, for the URL https://us-west-2b.online.tableau.com/#/site/mysitename/home, you would enter mysitename. If you’re connecting the app to Tableau Server and want to use the default site, leave this field blank.

  3. For the Base URL, enter the portion of the site URL that ends with tableau.com, for example, https://us-west-2b.online.tableau.com.

  4. For the User Mapping Attribute, select the Microsoft Entra attribute that is used to authenticate the user with single sign-on.

  5. For the Connected App ID, Connected App Secret ID, and Connected App Secret Value, paste in the values that you copied when you created the connected app.

  6. Select Add Site Config.

The Tableau app tests the connection before saving the configuration details. The site configuration won’t be added if the app can’t connect to Tableau. This failure could be because the connected app isn’t able to authenticate, the connected app isn’t enabled, the site information is wrong, or because the account that you're using isn’t a Tableau admin account. It could also mean the app can't reach Tableau Server because it’s behind a firewall.

Add or delete site configurations

After you've added a site configuration, you can add additional sites or delete an existing site configuration.

  1. In the Tableau app for Microsoft Teams, select the Configuration tab.

  2. Under Configuration, select the Tableau Site Config tab. Only Tableau admins can access the settings on this tab.

  3. To add a site, select Add Site Details. Or, to remove a site, select the delete icon for that site.

Back to top
Thanks for your feedback!Your feedback has been successfully submitted. Thank you!