feat: remove user from group

vusaverse · Jan 4, 2024 · 489326d · 489326d
1 parent a666306
commit 489326d
Show file tree

Hide file tree

Showing 30 changed files with 118 additions and 2 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -41,4 +41,5 @@ export(get_variables)
 export(get_workbook_id)
 export(get_workbook_tabs)
 export(make_rootnodes)
+export(remove_user_from_group)
 importFrom(magrittr,"%>%")
diff --git a/R/remove_user_from_group.R b/R/remove_user_from_group.R
@@ -0,0 +1,36 @@
+#' Remove User from Group
+#'
+#' Removes a user from the specified group.
+#'
+#' @param tableau A list containing the Tableau authentication variables: `base_url`, `token`, `user_id`, and `site_id`.
+#' @param api_version The version of the API to use, such as 3.19 (default: 3.19).
+#' @param group_id The ID of the group to remove the user from.
+#' @param user_id The ID of the user to remove.
+#'
+#' @return The response from the API.
+#' @export
+#' @family Tableau REST API
+remove_user_from_group <- function(tableau, api_version = 3.19, group_id, user_id) {
+  base_url <- tableau$base_url
+  site_id <- tableau$site_id
+  token <- tableau$token
+
+  url <- paste0(
+    base_url,
+    "api/",
+    api_version,
+    "/sites/",
+    site_id,
+    "/groups/",
+    group_id,
+    "/users/",
+    user_id
+  )
+
+  api_response <- httr::DELETE(
+    url,
+    httr::add_headers("X-Tableau-Auth" = token)
+  )
+
+  return(api_response)
+}
diff --git a/TODO.md b/TODO.md
@@ -293,7 +293,7 @@
 -   [ ] Import Users to Site from CSV
 -   [x] Query Groups
 -   [ ] Query User On Site
--   [ ] Remove User from Group
+-   [x] Remove User from Group
 -   [x] Remove User from Site
 -   [ ] Update Group
 -   [ ] Update User

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