Skip to contents

Authenticate to Tableau Server or Tableau Cloud

Source: R/authenticate_PAT.R
authenticate_PAT.Rd

This function authenticates to a Tableau Server or Tableau Cloud using a personal access token (PAT).

Usage

authenticate_PAT(
  pat_name = tableau_pat_name(),
  pat_secret = tableau_pat_secret(),
  content_url = tableau_content_url(),
  base_url = tableau_base_url(),
  api_version = 3.4
)

Arguments

pat_name

The name of the personal access token (PAT). Defaults to the `TABLEAU_PAT_NAME` environment variable.

pat_secret

The secret of the personal access token (PAT). Defaults to the `TABLEAU_PAT_SECRET` environment variable.

content_url

The URL of the content to authenticate. Defaults to the `TABLEAU_CONTENT_URL` environment variable. For Tableau Server, this is typically the URL of the Tableau server followed by the site ID. For Tableau Cloud, this is usually the URL of the Tableau cloud workbook.

base_url

The base URL of the Tableau server or Tableau cloud. Defaults to the `TABLEAU_BASE_URL` environment variable. For Tableau Server, this is usually the URL of the Tableau server. For Tableau Cloud, this is usually the URL of the Tableau cloud, and it must contain the pod name, such as 10az, 10ay, or us-east-1. For example, the base URL to sign in to a site in the 10ay pod would be: https://10ay.online.tableau.com.

api_version

The API version to use. Default is 3.4.

Value

A list containing the base URL, the access token, the site ID, and the user ID.

See also

Other Tableau REST API: add_tags_to_view(), add_tags_to_workbook(), add_user_to_group(), add_user_to_site(), authenticate_server(), create_group(), delete_group(), download_datasource(), download_filtered_tableau_image(), download_tableau_crosstab_excel(), download_tableau_data(), download_workbooks_server(), download_workbooks_server_pdf(), download_workbooks_server_powerpoint(), get_groups_for_user(), get_mobile_security_settings(), get_server_connected_apps(), get_server_datasources(), get_server_groups(), get_server_info(), get_server_jobs(), get_server_projects(), get_server_refresh_tasks(), get_server_schedules(), get_server_user_favorites(), get_server_users(), get_server_views(), get_server_workbooks(), get_table_assets(), get_users_in_group(), query_user_on_site(), remove_user_from_group(), remove_user_from_site(), run_extract_refresh_task(), update_data_source_now(), update_group(), update_user(), update_workbook_now()