add: details on Tableau Cloud authentication using PAT

vusaverse · Jan 12, 2024 · e57c89e · e57c89e
1 parent a24606e
commit e57c89e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/R/authenticate_PAT.R b/R/authenticate_PAT.R
@@ -5,7 +5,11 @@
 #' @param pat_name The name of the personal access token (PAT). Defaults to the `TABLEAU_PAT_NAME` environment variable.
 #' @param pat_secret The secret of the personal access token (PAT). Defaults to the `TABLEAU_PAT_SECRET` environment variable.
 #' @param 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.
 #' @param 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.
 #' @param api_version The API version to use. Default is 3.4.
 #' @return A list containing the base URL, the access token, the site ID, and the user ID.
 #' @export

diff --git a/man/authenticate_PAT.Rd b/man/authenticate_PAT.Rd