Tableau Component
Manage projects and workbooks in your Tableau site
Component key: tableauDescription#
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
| Input | Key | Notes | Example |
|---|---|---|---|
Content Permissions string | contentPermissions | This 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 | description | Provide a string value for the description of the project. | This is an example description |
Host Name string / Required | hostName | Provide a string value for the host name of the Tableau server. | 10ay.online.tableau.com |
Parent Project Id string | parentProjectId | Provide a string value for the id of the parent project. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Project Name string / Required | projectName | Provide a string value for the name of the project. | MyProject |
Site Id string / Required | siteId | Provide a string value for the Id of your Tableau Site | my-test-site |
timeout string | timeout | The maximum amount of time the client will await a response. | 3000 |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| Private Key | private_key | Private 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
| Input | Key | Notes | Example |
|---|---|---|---|
Auth Setting string | authSetting | Provide a string value for the username of the user. | |
Host Name string / Required | hostName | Provide a string value for the host name of the Tableau server. | 10ay.online.tableau.com |
Site Id string / Required | siteId | Provide a string value for the Id of your Tableau Site | my-test-site |
Site Role string | siteRole | Provide a value for the role of the user. | |
timeout string | timeout | The maximum amount of time the client will await a response. | 3000 |
Username string | username | Provide a string value for the username of the user. For Tableau Online, this value is an email address. | someone@example.com |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| Private Key | private_key | Private 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
| Input | Key | Notes | Example |
|---|---|---|---|
Host Name string / Required | hostName | Provide a string value for the host name of the Tableau server. | 10ay.online.tableau.com |
Project Id string / Required | projectId | Provide a string value for the Id of your Tableau Project. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Site Id string / Required | siteId | Provide a string value for the Id of your Tableau Site | my-test-site |
timeout string | timeout | The maximum amount of time the client will await a response. | 3000 |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| Private Key | private_key | Private 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
| Input | Key | Notes | Example |
|---|---|---|---|
Host Name string / Required | hostName | Provide a string value for the host name of the Tableau server. | 10ay.online.tableau.com |
Site Id string / Required | siteId | Provide a string value for the Id of your Tableau Site | my-test-site |
timeout string | timeout | The maximum amount of time the client will await a response. | 3000 |
UserId string | userId | Provide a value for the unique identifier of the user. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| Private Key | private_key | Private 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
| Input | Key | Notes | Example |
|---|---|---|---|
Host Name string / Required | hostName | Provide a string value for the host name of the Tableau server. | 10ay.online.tableau.com |
Site Id string / Required | siteId | Provide a string value for the Id of your Tableau Site | my-test-site |
timeout string | timeout | The maximum amount of time the client will await a response. | 3000 |
Workbook Id string / Required | workbookId | Provide a string value for the unique identifier of the workbook. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| Private Key | private_key | Private 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
| Input | Key | Notes | Example |
|---|---|---|---|
Host Name string / Required | hostName | Provide a string value for the host name of the Tableau server. | 10ay.online.tableau.com |
Project Id string / Required | projectId | Provide a string value for the Id of your Tableau Project. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Site Id string / Required | siteId | Provide a string value for the Id of your Tableau Site | my-test-site |
timeout string | timeout | The maximum amount of time the client will await a response. | 3000 |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| Private Key | private_key | Private 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
| Input | Key | Notes | Example |
|---|---|---|---|
Host Name string / Required | hostName | Provide a string value for the host name of the Tableau server. | 10ay.online.tableau.com |
Site Id string / Required | siteId | Provide a string value for the Id of your Tableau Site | my-test-site |
timeout string | timeout | The maximum amount of time the client will await a response. | 3000 |
UserId string | userId | Provide a value for the unique identifier of the user. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| Private Key | private_key | Private 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
| Input | Key | Notes | Example |
|---|---|---|---|
Host Name string / Required | hostName | Provide a string value for the host name of the Tableau server. | 10ay.online.tableau.com |
Site Id string / Required | siteId | Provide a string value for the Id of your Tableau Site | my-test-site |
timeout string | timeout | The maximum amount of time the client will await a response. | 3000 |
Workbook Id string / Required | workbookId | Provide a string value for the unique identifier of the workbook. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| Private Key | private_key | Private 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
| Input | Key | Notes | Example |
|---|---|---|---|
Host Name string / Required | hostName | Provide a string value for the host name of the Tableau server. | 10ay.online.tableau.com |
Site Id string / Required | siteId | Provide a string value for the Id of your Tableau Site | my-test-site |
timeout string | timeout | The maximum amount of time the client will await a response. | 3000 |
Workbook Id string / Required | workbookId | Provide a string value for the unique identifier of the workbook. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| Private Key | private_key | Private 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
| Input | Key | Notes | Example |
|---|---|---|---|
Host Name string / Required | hostName | Provide a string value for the host name of the Tableau server. | 10ay.online.tableau.com |
Site Id string / Required | siteId | Provide a string value for the Id of your Tableau Site | my-test-site |
timeout string | timeout | The maximum amount of time the client will await a response. | 3000 |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| Private Key | private_key | Private 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
| Input | Key | Notes | Example |
|---|---|---|---|
Host Name string / Required | hostName | Provide a string value for the host name of the Tableau server. | 10ay.online.tableau.com |
Site Id string / Required | siteId | Provide a string value for the Id of your Tableau Site | my-test-site |
timeout string | timeout | The maximum amount of time the client will await a response. | 3000 |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| Private Key | private_key | Private 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
| Input | Key | Notes | Example |
|---|---|---|---|
Host Name string / Required | hostName | Provide a string value for the host name of the Tableau server. | 10ay.online.tableau.com |
Site Id string / Required | siteId | Provide a string value for the Id of your Tableau Site | my-test-site |
timeout string | timeout | The maximum amount of time the client will await a response. | 3000 |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| Private Key | private_key | Private 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
| Input | Key | Notes | Example |
|---|---|---|---|
Connection Id string | connectionId | Provide a value for the unique identifier of the connection. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Connection Password string | connectionPassword | Provide a value for the password used to authenticate the connection. | mySafePassword |
Connection Username string | connectionUsername | Provide a string value for the username used to authenticate the connection. | myExampleUsername |
Embed Password boolean | embedPassword | Enable this flag to embed the password for the connection. | |
Host Name string / Required | hostName | Provide a string value for the host name of the Tableau server. | 10ay.online.tableau.com |
Query Tagging Enabled boolean | queryTaggingEnabled | Associates a specific server log query event with the Tableau resource that made the query. | |
Server Address string | serverAddress | Provide a string value for the address of the server you want to connect. | 192.168.0.1 |
Server Port string | serverPort | Provide a string value for the port of the server you want to connect. | 8080 |
Site Id string / Required | siteId | Provide a string value for the Id of your Tableau Site | my-test-site |
timeout string | timeout | The maximum amount of time the client will await a response. | 3000 |
Workbook Id string / Required | workbookId | Provide a string value for the unique identifier of the workbook. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| Private Key | private_key | Private 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
| Input | Key | Notes | Example |
|---|---|---|---|
Content Permissions string | contentPermissions | This 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 | description | Provide a string value for the description of the project. | This is an example description |
Host Name string / Required | hostName | Provide a string value for the host name of the Tableau server. | 10ay.online.tableau.com |
Parent Project Id string | parentProjectId | Provide a string value for the id of the parent project. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Project Id string / Required | projectId | Provide a string value for the Id of your Tableau Project. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Project Name string | projectName | Provide a string value for the name of the project. | MyProject |
Site Id string / Required | siteId | Provide a string value for the Id of your Tableau Site | my-test-site |
timeout string | timeout | The maximum amount of time the client will await a response. | 3000 |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| Private Key | private_key | Private 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
| Input | Key | Notes | Example |
|---|---|---|---|
Auth Setting string | authSetting | Provide a string value for the username of the user. | |
Host Name string / Required | hostName | Provide a string value for the host name of the Tableau server. | 10ay.online.tableau.com |
Site Id string / Required | siteId | Provide a string value for the Id of your Tableau Site | my-test-site |
Site Role string | siteRole | Provide a value for the role of the user. | |
timeout string | timeout | The maximum amount of time the client will await a response. | 3000 |
UserId string | userId | Provide a value for the unique identifier of the user. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 |
Username string | username | Provide a string value for the username of the user. For Tableau Online, this value is an email address. | someone@example.com |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| Private Key | private_key | Private 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
| Input | Key | Default | Notes | Example |
|---|---|---|---|---|
Host Name string / Required | hostName | Provide a string value for the host name of the Tableau server. | 10ay.online.tableau.com | |
Project Id string / Required | projectId | Provide a string value for the Id of your Tableau Project. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 | |
Show Tabs boolean | showTabs | false | Specify true to have the updated workbook show views in tabs. | |
Site Id string / Required | siteId | Provide a string value for the Id of your Tableau Site | my-test-site | |
timeout string | timeout | The maximum amount of time the client will await a response. | 3000 | |
UserId string | userId | Provide a value for the unique identifier of the user. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 | |
Workbook Id string / Required | workbookId | Provide a string value for the unique identifier of the workbook. | f12a9855-1059-4cd7-9e6a-a4ba5089e374 | |
Workbook Name string / Required | workbookName | Provide a string value for the name of the workbook. | My Workbook |
Authorization#
| Auth Type | Key | Description | Fields |
|---|---|---|---|
| Private Key | private_key | Private Key authorization based on a username/private key combination | Username | username Private Key | private_key |