feat: get groups for user

vusaverse · Jan 4, 2024 · 9ecf48e · 9ecf48e
1 parent d1dc393
commit 9ecf48e
Show file tree

Hide file tree

Showing 31 changed files with 148 additions and 1 deletion.
diff --git a/NAMESPACE b/NAMESPACE
@@ -17,6 +17,7 @@ export(download_workbooks_server_pdf)
 export(download_workbooks_server_powerpoint)
 export(get_actions)
 export(get_folders)
+export(get_groups_for_user)
 export(get_hierarchy)
 export(get_nodenames)
 export(get_parameter)

diff --git a/R/get_groups_for_user.R b/R/get_groups_for_user.R
@@ -0,0 +1,54 @@
+#' Get Groups for a User
+#'
+#' Gets a list of groups that the specified user is a member of.
+#'
+#' @param tableau A list containing the Tableau authentication variables: `base_url`, `token`, `user_id`, and `site_id`.
+#' @param api_version The API version to use (default: 3.19).
+#' @param user_id The ID of the user whose group memberships are listed.
+#' @param page_size
+#' (Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
+#' @param page_number
+#' (Optional) The offset for paging. The default is 1. For more information, see Paginating Results.
+#' @param include_metadata Logical indicating whether to include metadata columns in the result (default: FALSE).
+#'
+#' @return A table containing the groups for the specified user.
+#' @export
+#' @family Tableau REST API
+get_groups_for_user <- function(tableau, api_version = 3.19, user_id, page_size = 100, page_number = 1, include_metadata = FALSE) {
+  base_url <- tableau$base_url
+  site_id <- tableau$site_id
+  token <- tableau$token
+
+  url <- paste0(
+    base_url,
+    "api/",
+    api_version,
+    "/sites/",
+    site_id,
+    "/users/",
+    user_id,
+    "/groups"
+  )
+
+  api_response <- httr::GET(url,
+                            httr::add_headers("X-Tableau-Auth" = token),
+                            httr::content_type("application/xml"),
+                            httr::accept_json())
+
+  if (httr::status_code(api_response) != 200) {
+    stop("API call failed.")
+  }
+
+  jsonResponseText <- httr::content(api_response, as = "text")
+
+  df <- jsonlite::fromJSON(jsonResponseText) %>%
+    as.data.frame(check.names = FALSE) %>%
+    dplyr::rename_with(~ stringr::str_remove(., "groups.group."), dplyr::everything())
+
+  if (!include_metadata) {
+    df <- df %>%
+      dplyr::select(-dplyr::starts_with("pagination"))
+  }
+
+  return(df)
+}
diff --git a/TODO.md b/TODO.md
@@ -287,7 +287,7 @@
 -   [ ] Create Group
 -   [ ] Delete Group
 -   [ ] Delete Users from Site with CSV
--   [ ] Get Groups for a User
+-   [x] Get Groups for a User
 -   [x] Get Users in Group
 -   [x] Get Users on Site
 -   [ ] Import Users to Site from CSV

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/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/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