Skip to main content

Tableau Component

Manage projects and workbooks in your Tableau site

Component key: tableau

Description#

Tableau is an interactive data visualization software company focused on business intelligence. The Tableau component allows you to manage your users, projects, workbooks, and connections through the Tableau Rest API.

Authorization Notes#

Tableau uses a private key credential to authorize requests made to the API. To create a credential for Tableau, start by logging into your Tableau account. Next click the user icon in the top right, and click on account settings. On this page you will see a field called personal access tokens, go ahead and create one and give it a name. Now, you will have to configure a private key in Prismatic. Create a new credential of type Private Key.

  • For Username enter the name you gave to the token in the Tableau settings.
  • For Private key enter the token that was generated in the Tableau settings.

For additional information regarding authentication, please refer to the Tableau docs

Actions#

Create Project#

Create a new project inside your Tableau site | key: createProject

InputKeyNotesExample

Content Permissions

string
contentPermissionsThis value controls user permissions in a project. However, if the project is nested within a project, it will inherit those permissions and these settings will have no effect.

Description

string
descriptionProvide a string value for the description of the project.This is an example description

Host Name

string
/ Required
hostNameProvide a string value for the host name of the Tableau server.10ay.online.tableau.com

Parent Project Id

string
parentProjectIdProvide a string value for the id of the parent project.f12a9855-1059-4cd7-9e6a-a4ba5089e374

Project Name

string
/ Required
projectNameProvide a string value for the name of the project.MyProject

Site Id

string
/ Required
siteIdProvide a string value for the Id of your Tableau Sitemy-test-site

timeout

string
timeoutThe maximum amount of time the client will await a response.3000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Private Keyprivate_keyPrivate Key authorization based on a username/private key combination

Username |  username

Private Key |  private_key


Create User#

Create a new user in your tableau site | key: createUser

InputKeyNotesExample

Auth Setting

string
authSettingProvide a string value for the username of the user.

Host Name

string
/ Required
hostNameProvide a string value for the host name of the Tableau server.10ay.online.tableau.com

Site Id

string
/ Required
siteIdProvide a string value for the Id of your Tableau Sitemy-test-site

Site Role

string
siteRoleProvide a value for the role of the user.

timeout

string
timeoutThe maximum amount of time the client will await a response.3000

Username

string
usernameProvide a string value for the username of the user. For Tableau Online, this value is an email address.someone@example.com

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Private Keyprivate_keyPrivate Key authorization based on a username/private key combination

Username |  username

Private Key |  private_key


Delete Projects#

Delete an existing project by Id | key: deleteProjects

InputKeyNotesExample

Host Name

string
/ Required
hostNameProvide a string value for the host name of the Tableau server.10ay.online.tableau.com

Project Id

string
/ Required
projectIdProvide a string value for the Id of your Tableau Project.f12a9855-1059-4cd7-9e6a-a4ba5089e374

Site Id

string
/ Required
siteIdProvide a string value for the Id of your Tableau Sitemy-test-site

timeout

string
timeoutThe maximum amount of time the client will await a response.3000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Private Keyprivate_keyPrivate Key authorization based on a username/private key combination

Username |  username

Private Key |  private_key


Delete User#

Delete an existing user by Id | key: deleteUser

InputKeyNotesExample

Host Name

string
/ Required
hostNameProvide a string value for the host name of the Tableau server.10ay.online.tableau.com

Site Id

string
/ Required
siteIdProvide a string value for the Id of your Tableau Sitemy-test-site

timeout

string
timeoutThe maximum amount of time the client will await a response.3000

UserId

string
userIdProvide a value for the unique identifier of the user.f12a9855-1059-4cd7-9e6a-a4ba5089e374

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Private Keyprivate_keyPrivate Key authorization based on a username/private key combination

Username |  username

Private Key |  private_key


Delete Workbooks#

Delete an existing workbook by Id | key: deleteWorkbook

InputKeyNotesExample

Host Name

string
/ Required
hostNameProvide a string value for the host name of the Tableau server.10ay.online.tableau.com

Site Id

string
/ Required
siteIdProvide a string value for the Id of your Tableau Sitemy-test-site

timeout

string
timeoutThe maximum amount of time the client will await a response.3000

Workbook Id

string
/ Required
workbookIdProvide a string value for the unique identifier of the workbook.f12a9855-1059-4cd7-9e6a-a4ba5089e374

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Private Keyprivate_keyPrivate Key authorization based on a username/private key combination

Username |  username

Private Key |  private_key


Get Project#

Get an existing project by Id | key: getProject

InputKeyNotesExample

Host Name

string
/ Required
hostNameProvide a string value for the host name of the Tableau server.10ay.online.tableau.com

Project Id

string
/ Required
projectIdProvide a string value for the Id of your Tableau Project.f12a9855-1059-4cd7-9e6a-a4ba5089e374

Site Id

string
/ Required
siteIdProvide a string value for the Id of your Tableau Sitemy-test-site

timeout

string
timeoutThe maximum amount of time the client will await a response.3000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Private Keyprivate_keyPrivate Key authorization based on a username/private key combination

Username |  username

Private Key |  private_key


Get User#

Get an existing user by Id | key: getUser

InputKeyNotesExample

Host Name

string
/ Required
hostNameProvide a string value for the host name of the Tableau server.10ay.online.tableau.com

Site Id

string
/ Required
siteIdProvide a string value for the Id of your Tableau Sitemy-test-site

timeout

string
timeoutThe maximum amount of time the client will await a response.3000

UserId

string
userIdProvide a value for the unique identifier of the user.f12a9855-1059-4cd7-9e6a-a4ba5089e374

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Private Keyprivate_keyPrivate Key authorization based on a username/private key combination

Username |  username

Private Key |  private_key


Get Workbooks#

Get an existing workbook by Id | key: getWorkbook

InputKeyNotesExample

Host Name

string
/ Required
hostNameProvide a string value for the host name of the Tableau server.10ay.online.tableau.com

Site Id

string
/ Required
siteIdProvide a string value for the Id of your Tableau Sitemy-test-site

timeout

string
timeoutThe maximum amount of time the client will await a response.3000

Workbook Id

string
/ Required
workbookIdProvide a string value for the unique identifier of the workbook.f12a9855-1059-4cd7-9e6a-a4ba5089e374

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Private Keyprivate_keyPrivate Key authorization based on a username/private key combination

Username |  username

Private Key |  private_key


List Connections#

Retrieve a list of connections connected to your Tableau site | key: listConnections

InputKeyNotesExample

Host Name

string
/ Required
hostNameProvide a string value for the host name of the Tableau server.10ay.online.tableau.com

Site Id

string
/ Required
siteIdProvide a string value for the Id of your Tableau Sitemy-test-site

timeout

string
timeoutThe maximum amount of time the client will await a response.3000

Workbook Id

string
/ Required
workbookIdProvide a string value for the unique identifier of the workbook.f12a9855-1059-4cd7-9e6a-a4ba5089e374

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Private Keyprivate_keyPrivate Key authorization based on a username/private key combination

Username |  username

Private Key |  private_key


List Projects#

Retrieve a list of projects connected to your Tableau site | key: listProjects

InputKeyNotesExample

Host Name

string
/ Required
hostNameProvide a string value for the host name of the Tableau server.10ay.online.tableau.com

Site Id

string
/ Required
siteIdProvide a string value for the Id of your Tableau Sitemy-test-site

timeout

string
timeoutThe maximum amount of time the client will await a response.3000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Private Keyprivate_keyPrivate Key authorization based on a username/private key combination

Username |  username

Private Key |  private_key


List users#

Retrieve a list of users connected to your Tableau site | key: listUsers

InputKeyNotesExample

Host Name

string
/ Required
hostNameProvide a string value for the host name of the Tableau server.10ay.online.tableau.com

Site Id

string
/ Required
siteIdProvide a string value for the Id of your Tableau Sitemy-test-site

timeout

string
timeoutThe maximum amount of time the client will await a response.3000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Private Keyprivate_keyPrivate Key authorization based on a username/private key combination

Username |  username

Private Key |  private_key


List Workbooks#

Retrieve a list of workbooks connected to your Tableau site | key: listWorkbooks

InputKeyNotesExample

Host Name

string
/ Required
hostNameProvide a string value for the host name of the Tableau server.10ay.online.tableau.com

Site Id

string
/ Required
siteIdProvide a string value for the Id of your Tableau Sitemy-test-site

timeout

string
timeoutThe maximum amount of time the client will await a response.3000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Private Keyprivate_keyPrivate Key authorization based on a username/private key combination

Username |  username

Private Key |  private_key


Update Connection#

Update the information and metadata of an existing connection by Id | key: updateConnection

InputKeyNotesExample

Connection Id

string
connectionIdProvide a value for the unique identifier of the connection.f12a9855-1059-4cd7-9e6a-a4ba5089e374

Connection Password

string
connectionPasswordProvide a value for the password used to authenticate the connection.mySafePassword

Connection Username

string
connectionUsernameProvide a string value for the username used to authenticate the connection.myExampleUsername

Embed Password

boolean
embedPasswordEnable this flag to embed the password for the connection.

Host Name

string
/ Required
hostNameProvide a string value for the host name of the Tableau server.10ay.online.tableau.com

Query Tagging Enabled

boolean
queryTaggingEnabledAssociates a specific server log query event with the Tableau resource that made the query.

Server Address

string
serverAddressProvide a string value for the address of the server you want to connect.192.168.0.1

Server Port

string
serverPortProvide a string value for the port of the server you want to connect.8080

Site Id

string
/ Required
siteIdProvide a string value for the Id of your Tableau Sitemy-test-site

timeout

string
timeoutThe maximum amount of time the client will await a response.3000

Workbook Id

string
/ Required
workbookIdProvide a string value for the unique identifier of the workbook.f12a9855-1059-4cd7-9e6a-a4ba5089e374

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Private Keyprivate_keyPrivate Key authorization based on a username/private key combination

Username |  username

Private Key |  private_key


Update Project#

Update the contents and metadata of an existing project by Id | key: updateProject

InputKeyNotesExample

Content Permissions

string
contentPermissionsThis value controls user permissions in a project. However, if the project is nested within a project, it will inherit those permissions and these settings will have no effect.

Description

string
descriptionProvide a string value for the description of the project.This is an example description

Host Name

string
/ Required
hostNameProvide a string value for the host name of the Tableau server.10ay.online.tableau.com

Parent Project Id

string
parentProjectIdProvide a string value for the id of the parent project.f12a9855-1059-4cd7-9e6a-a4ba5089e374

Project Id

string
/ Required
projectIdProvide a string value for the Id of your Tableau Project.f12a9855-1059-4cd7-9e6a-a4ba5089e374

Project Name

string
projectNameProvide a string value for the name of the project.MyProject

Site Id

string
/ Required
siteIdProvide a string value for the Id of your Tableau Sitemy-test-site

timeout

string
timeoutThe maximum amount of time the client will await a response.3000

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Private Keyprivate_keyPrivate Key authorization based on a username/private key combination

Username |  username

Private Key |  private_key


Update User#

Update the information and metadata of an existing user | key: updateUser

InputKeyNotesExample

Auth Setting

string
authSettingProvide a string value for the username of the user.

Host Name

string
/ Required
hostNameProvide a string value for the host name of the Tableau server.10ay.online.tableau.com

Site Id

string
/ Required
siteIdProvide a string value for the Id of your Tableau Sitemy-test-site

Site Role

string
siteRoleProvide a value for the role of the user.

timeout

string
timeoutThe maximum amount of time the client will await a response.3000

UserId

string
userIdProvide a value for the unique identifier of the user.f12a9855-1059-4cd7-9e6a-a4ba5089e374

Username

string
usernameProvide a string value for the username of the user. For Tableau Online, this value is an email address.someone@example.com

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Private Keyprivate_keyPrivate Key authorization based on a username/private key combination

Username |  username

Private Key |  private_key


Update Workbook#

Update the information and metadata of an existing workbook by Id | key: updateWorkbook

InputKeyDefaultNotesExample

Host Name

string
/ Required
hostNameProvide a string value for the host name of the Tableau server.10ay.online.tableau.com

Project Id

string
/ Required
projectIdProvide a string value for the Id of your Tableau Project.f12a9855-1059-4cd7-9e6a-a4ba5089e374

Show Tabs

boolean
showTabsfalseSpecify true to have the updated workbook show views in tabs.

Site Id

string
/ Required
siteIdProvide a string value for the Id of your Tableau Sitemy-test-site

timeout

string
timeoutThe maximum amount of time the client will await a response.3000

UserId

string
userIdProvide a value for the unique identifier of the user.f12a9855-1059-4cd7-9e6a-a4ba5089e374

Workbook Id

string
/ Required
workbookIdProvide a string value for the unique identifier of the workbook.f12a9855-1059-4cd7-9e6a-a4ba5089e374

Workbook Name

string
/ Required
workbookNameProvide a string value for the name of the workbook.My Workbook

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Private Keyprivate_keyPrivate Key authorization based on a username/private key combination

Username |  username

Private Key |  private_key