feat: get user information

vusaverse · Jan 5, 2024 · 5cc2fe7 · 5cc2fe7
1 parent 20ae1f8
commit 5cc2fe7
Show file tree

Hide file tree

Showing 33 changed files with 127 additions and 1 deletion.
diff --git a/NAMESPACE b/NAMESPACE
@@ -43,5 +43,6 @@ export(get_variables)
 export(get_workbook_id)
 export(get_workbook_tabs)
 export(make_rootnodes)
+export(query_user_on_site)
 export(remove_user_from_group)
 importFrom(magrittr,"%>%")
diff --git a/R/query_user_on_site.R b/R/query_user_on_site.R
@@ -0,0 +1,42 @@
+#' Query User On Site
+#'
+#' Returns information about the specified user.
+#'
+#' @param tableau A list containing the Tableau authentication variables: `base_url`, `token`, and `site_id`.
+#' @param user_id The ID of the user to get information for.
+#' @param api_version The API version to use (default: 3.19).
+#'
+#' @return Information about the specified user.
+#' @export
+#' @family Tableau REST API
+query_user_on_site <- function(tableau, user_id, api_version = "3.19") {
+  base_url <- tableau$base_url
+  token <- tableau$token
+  site_id <- tableau$site_id
+
+  url <- paste0(
+    base_url,
+    "/api/",
+    api_version,
+    "/sites/",
+    site_id,
+    "/users/",
+    user_id
+  )
+
+  api_response <- httr::GET(
+    url,
+    httr::add_headers("X-Tableau-Auth" = token)
+  )
+
+  # Check the response status code
+  if (httr::status_code(api_response) != 200) {
+    stop("Failed to query user on site. Please check your API key and base URL.")
+  }
+
+  jsonResponseText <- httr::content(api_response, as = "text")
+  user_info <- jsonlite::fromJSON(jsonResponseText) %>%
+    as.data.frame(check.names = FALSE)
+
+  return(user_info)
+}
diff --git a/TODO.md b/TODO.md
@@ -292,7 +292,7 @@
 -   [x] Get Users on Site
 -   [ ] Import Users to Site from CSV
 -   [x] Query Groups
--   [ ] Query User On Site
+-   [x] Query User On Site
 -   [x] Remove User from Group
 -   [x] Remove User from Site
 -   [ ] Update Group

diff --git a/man/add_tags_to_view.Rd b/man/add_tags_to_view.Rd
diff --git a/man/add_tags_to_workbook.Rd b/man/add_tags_to_workbook.Rd
diff --git a/man/add_user_to_group.Rd b/man/add_user_to_group.Rd
diff --git a/man/add_user_to_site.Rd b/man/add_user_to_site.Rd
diff --git a/man/authenticate_server.Rd b/man/authenticate_server.Rd
diff --git a/man/create_group.Rd b/man/create_group.Rd
diff --git a/man/download_filtered_tableau_image.Rd b/man/download_filtered_tableau_image.Rd
diff --git a/man/download_tableau_crosstab_excel.Rd b/man/download_tableau_crosstab_excel.Rd
diff --git a/man/download_tableau_data.Rd b/man/download_tableau_data.Rd
diff --git a/man/download_workbooks_server.Rd b/man/download_workbooks_server.Rd
diff --git a/man/download_workbooks_server_pdf.Rd b/man/download_workbooks_server_pdf.Rd
diff --git a/man/download_workbooks_server_powerpoint.Rd b/man/download_workbooks_server_powerpoint.Rd
diff --git a/man/get_groups_for_user.Rd b/man/get_groups_for_user.Rd
diff --git a/man/get_server_connected_apps.Rd b/man/get_server_connected_apps.Rd
diff --git a/man/get_server_datasources.Rd b/man/get_server_datasources.Rd
diff --git a/man/get_server_groups.Rd b/man/get_server_groups.Rd
diff --git a/man/get_server_info.Rd b/man/get_server_info.Rd
diff --git a/man/get_server_jobs.Rd b/man/get_server_jobs.Rd
diff --git a/man/get_server_projects.Rd b/man/get_server_projects.Rd
diff --git a/man/get_server_refresh_tasks.Rd b/man/get_server_refresh_tasks.Rd
diff --git a/man/get_server_schedules.Rd b/man/get_server_schedules.Rd
diff --git a/man/get_server_user_favorites.Rd b/man/get_server_user_favorites.Rd
diff --git a/man/get_server_users.Rd b/man/get_server_users.Rd
diff --git a/man/get_server_views.Rd b/man/get_server_views.Rd
diff --git a/man/get_server_workbooks.Rd b/man/get_server_workbooks.Rd
diff --git a/man/get_table_assets.Rd b/man/get_table_assets.Rd
diff --git a/man/get_users_in_group.Rd b/man/get_users_in_group.Rd
diff --git a/man/query_user_on_site.Rd b/man/query_user_on_site.Rd
diff --git a/man/remove_user_from_group.Rd b/man/remove_user_from_group.Rd
diff --git a/man/remove_user_from_site.Rd b/man/remove_user_from_site.Rd