Sign In and Out

The first step to using the TSC library is to sign in to your Tableau Server (or Tableau Online). This page explains how to sign in, sign out, and switch sites, with examples for both Tableau Server and Tableau Online.

• Sign In
  • Sign in with Personal Access Token
  • Sign in with Username and Password
  • 405000 Method Not Allowed Response
• Sign Out
• Simplify by using Python with block
• Switch Site

Sign In

Signing in can be done two different ways:

• Personal Access Tokens - In most cases this is the preferred method because it improves security by avoiding the need to use or store passwords directly. Access tokens also expire by default if not used after 15 consecutive days. This option is available for Tableau Server 2019.4 and newer. Refer to Personal Access Tokens for more details.
• Username and Password - Direct sign in with account username and password.

Examples showing both of these cases are included below.

Note: When you sign in, the TSC library manages the authenticated session for you. However, the validity of the underlying credentials token is limited by the maximum session length set on your Tableau Server (2 hours by default).

Sign in with Personal Access Token

To sign in to Tableau Server or Tableau Online with a personal access token, you’ll need the following values:

This example illustrates using the above values to sign in with a personal access token, do some operations, and then sign out:

import tableauserverclient as TSC

tableau_auth = TSC.PersonalAccessTokenAuth('TOKEN_NAME', 'TOKEN_VALUE', 'SITENAME')
server = TSC.Server('https://SERVER_URL', use_server_version=True)
server.auth.sign_in(tableau_auth)

# Do awesome things here!

server.auth.sign_out()

Sign in with Username and Password

To sign in to Tableau Server or Tableau Online with a username and password, you’ll need the following values:

This example illustrates using the above values to sign in with a username and password, do some operations, and then sign out:

import tableauserverclient as TSC

tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', 'SITENAME')
server = TSC.Server('https://SERVER_URL', use_server_version=True)
server.auth.sign_in(tableau_auth)

# Do awesome things here!

server.auth.sign_out()

405000 Method Not Allowed Response

In some cases, you may find that sign in fails with a 405 message:

405000: Method Not Allowed
    The HTTP method 'GET' is not supported for the given resource

The most likely cause of this is signing in to a Tableau Server using the HTTP address which the server redirects to a secure HTTPS address. However, during the redirect the POST request turns into a GET request which is then considered an invalid method for the login entrypoint. (For security reasons, the server is following the standards correctly in this case).

The solution is to avoid the redirect by using the HTTPS URL for the site. For example, instead of:

server = TSC.Server('http://SERVER_URL')

Switch to the HTTPS (SSL) URL instead:

server = TSC.Server('https://SERVER_URL')

Sign Out

Signing out cleans up the current session and invalidates the authentication token being held by the TSC library.

As shown in the examples above, the sign out call is simply:

server.auth.sign_out()

Simplify by using Python with block

The sign in/out flow can be simplified (and handled in a more Python way) by using the built-in support for the with block. After the block execution completes, the sign out is called automatically.

For example:

import tableauserverclient as TSC

tableau_auth = TSC.PersonalAccessTokenAuth('TOKEN_NAME', 'TOKEN_VALUE', 'SITENAME')
server = TSC.Server('https://SERVER_URL')

with server.auth.sign_in(tableau_auth):
    all_wb, pagination_item = server.workbooks.get()
    print("\nThere are {} workbooks on site: ".format(pagination_item.total_available))
    for wb in all_wb:
        print(wb.id, wb.name)

All of the samples provided in TSC library use this technique.

Switch Site

Tableau Server has a feature which enables switching to another site without having to authenticate again. (The user must have access permissions for the new site as well.)

Note: This method is not available on Tableau Online.

The following example will switch the authenticated user to the NEW_SITENAME site on the same server:

# assume we already have an authenticated server object

server.auth.switch_site('NEW_SITENAME')