As a Tableau Server admin, you can register an external authorization server (EAS) to establish a trust relationship between your Tableau Server and the EAS using the OAuth 2.0 standard protocol. By establishing a trust relationship, you’re able to:

  • Provide your users a single sign-on (SSO) experience to Tableau content embedded in your external applications through the identity provider (IdP) you’ve already configured for Tableau Server
  • Programatically authorize access to the Tableau REST API on users' behalf using a JSON Web Token (JWT)

When embedded Tableau content is loaded in your external application, a standard OAuth flow is used. After users successfully sign in to the IdP, they are then automatically signed in to Tableau Server. Follow the steps described below to register your EAS with Tableau Server.

Important:

  • Some of the procedures in this topic require configuration with third party software and services. We’ve made a best effort to verify the procedures to enable the EAS feature on Tableau Server. However, third-party software and services might change or your organization might differ. If you encounter issues, refer to your third-party documentation for authoritative configuration details and support.
  • To enable embedding through EAS, Tableau Server must be configured to use SSL for HTTP traffic.
  • If your connected app is running in a container, such as an EC2 instance, both the container and the host clocks must be set to UTC in order for the session token to be valid. If either clock uses a different standard, the connected app will not be trusted.

Step 1: Before you begin

To register an EAS with Tableau Server , you must have an EAS already configured. In addition, the EAS must send a valid JSON Web Token (JWT) that contains the registered claims and header listed in the table below.

Claim Description or required value
"kid" (Key ID) Required (in header). A unique key identifier from the identity provider.
"iss" (Issuer) Required (in header or as a claim). Unique issuer URIthat identifies the trusted connect app and its signing key.
"alg" (Algorithm) Required (in header). JWT signing algorithm. Supported algorithm names are listed in the Class JWSAlgorithm(Link opens in a new window) page in the javadoc.io documentation. The signing algorithm can be configured using the vizportal.oauth.external_authorization_server.blocklisted_jws_algorithms command.
"sub" (Subject) User name of the authenticated Tableau Server user.
"aud" (Audience)

Value must be: "tableau"

"exp" (Expiration Time) A valid JWT must not be expired. The expiration time (in UTC) of the JWT must be within the configured maximum validity period. Maximum validity period can be configured using vizportal.oauth.external_authorization_server.max_expiration_period_in_minutes command.
"jti" (JWT ID) The JWT ID claim provides a unique identifier for the JWT and is case sensitive.
"scp" (Scope)

For embedding workflows, supported values include:

"tableau:views:embed"
"tableau:views:embed_authoring" (Added in Tableau Server 2022.3)
"tableau:metrics:embed"

Notes:

  • Values must be passed as a list type.
  • For tableau:views:embed, the scope respects users’ permissions already configured in Tableau Server and allows users to interact with the tools in the embedded view if available in the original view.
  • We recommend the embed code exclude the toolbar parameter. For more information see Known issues (embedding workflows only) below.

For REST API authorization workflows, see REST API methods that support JWT authorization.

Note: The JWT claims above are documented in the Registered Claim Names(Link opens in a new window) section in the documentation distributed by the Internet Engineering Task Force (IETF) organization.

Step 2: Register your EAS with Tableau Server

By registering your EAS with Tableau Server, you establish a trust relationship between the EAS and Tableau Server . This means when users access Tableau content embedded in your external application, they are redirected to authenticate with the IdP. The EAS generates the authentication token, which is passed to Tableau Server for verification. After the trust relationship is verified, access to the embedded content is granted users.

After registering the EAS, the trust established trust relationship applies to all sites on Tableau Server.

Note: Some EAS support the option to display a consent dialog that asks for users’ approval for the application to access Tableau content. To ensure the best experience for your users, we recommend you configure your EAS to automatically consent to the external application’s request on users’ behalf.

  1. As a Tableau Server admin, sign in to the Tableau Services Manager (TSM) web UI. For more information, see Sign in to Tableau Services Manager Web UI.

  2. Navigate to User Identity & Access > Authorization Server, and do the following:
    1. Select the Enable OAuth access for embedded content check box.

    2. In the Issuer URL text box, paste the issuer URL of the EAS.

    3. Click the Save Pending Changes button.

  3. When finished, do the following:
    1. In the upper-right corner of the page, click the Pending Changes button.

    2. In the bottom-right corner of the page, click the Apply Changes and Restart button to stop and restart Tableau Server.

  1. Open a command prompt as an admin on the initial node (where TSM is installed) in the cluster.
  2. Run the following commands:

    tsm configuration set -k vizportal.oauth.external_authorization.enabled -v true
    tsm configuration set -k vizportal.oauth.external_authorization_server.issuer -v "<issuer_url_of_EAS>"
    tsm restart

Step 3: Embedding next steps

For embedding workflows

After configuring Tableau Server to use your EAS, you must add embed code to your external application. Ensure that you include the valid JWT generated by your EAS, as described in Step 1, in the web component that your external application calls.

For more information about embedding Tableau content, see one or both of the following:

Note: For users to successfully authenticate when they access embedded content, browsers must be configured to allow third-party cookies.

For REST API authorization workflows

After the JWT has been configured, you must add the valid JWT to the REST API Sign In request for authorized access. For more information, see Access Scopes for Connected Apps.

Known issues (embedding workflows only)

There are a couple of known issues when using connected apps that will be addressed in a future release.

  • Toolbar features: When embedded content has the toolbar parameter defined, not all toolbar features will work. To work around this issue, we recommend you hide the toolbar parameter like in the example below.

    <tableau-viz id='tab-viz' src='https://<your_server>/t/<your_site>/...'
    	toolbar='hidden'>
    </tableau-viz>

  • Published data sources: Published data sources set to Prompt User for database credentials will not display. To work around this issue, if possible, we recommend data source owners embed their database credentials instead.

Troubleshoot

When embedded content fails to display in your external application or Tableau REST API authorization fails, you can use a browser’s developer tools to inspect and identify error codes that might be associated with the EAS feature enabled Tableau Server .

Refer to the table below to review the description of the error code and potential resolution.

Error code Summary Description Potential resolution or explanation
5 SYSTEM_USER_NOT_FOUND Tableau user could not be found
To resolve this issue, verify the 'sub' (Subject) claim value in the JWT is "username" for the authenticated Tableau Server. This value is case sensitive.
16 LOGIN_FAILED Login failed This error is typically caused by one of the following claim issues in the JWT:
10081 COULD_NOT_RETRIEVE_IDP_METADATA Missing EAS metadata endpoint To resolve this issue, verify the EAS is configured correctly and the correct issuer is being called.
10082 AUTHORIZATION_SERVER_ISSUER_NOT_SPECIFIED Missing issuer To resolve this issue, verify the correct issuer is being called. To change the issuer URL, you can use the vizportal.oauth.external_authorization_server.issuer command.
10083 BAD_JWT JWT header contains issues This error is typically caused by one of the following issues with the JWT header:
  • The 'secret key' (Kid) or 'clientId' (Issuer) claims are missing from the JWT header. To resolve this issue, ensure this information is included.
  • The JWT is unsigned or encrypted. Tableau does not support unsigned or encrypted JWTs.
10084 JWT_PARSE_ERROR JWT contains issues

To resolve this issue, verify the following:

  • The 'aud' (Audience) value referenced in the JWT uses the "tableau" value. This value is case sensitive.
  • The 'aud' (Audience) and 'sub' (Subject) are included in the JWT.
10085 COULD_NOT_FETCH_JWT_KEYS JWT could not find keys

Could not find the secret.

To resolve this issue, verify the correct issuer is being called. To change the issuer URL, you can use the vizportal.oauth.external_authorization_server.issuer command.

10087 BLOCKLISTED_JWS_ALGORITHM_USED_TO_SIGN Issue with the JWT signing algorithm

To resolve the issue, you can remove the signing algorithm. For more information, see vizportal.oauth.external_authorization_server.blocklisted_jws_algorithms.

10088 RSA_KEY_SIZE_INVALID Issue with JWT signing requirements To resolve this issue, verify with the EAS or IdP the JWT is being signed with an RSA key size of 2048.
10091 JTI_ALREADY_USED Unique JWT required

The JWT has already been used in the authentication process. To resolve this issue, the EAS or IdP must generate a new JWT.

10094 MISSING_REQUIRED_JTI Missing JWT ID To resolve this issue, verify the 'jti' (JWT ID) is included in the JWT.
Thanks for your feedback!