feat: remove user from site

vusaverse · Jan 4, 2024 · 3e9005f · 3e9005f
1 parent 776f524
commit 3e9005f
Show file tree

Hide file tree

Showing 24 changed files with 129 additions and 22 deletions.
diff --git a/R/remove_user_from_site.R b/R/remove_user_from_site.R
@@ -0,0 +1,36 @@
+#' Remove User from Site
+#'
+#' Removes a user from the specified site. The user will be deleted if they do not own any other assets other than subscriptions. If a user still owns content (assets) on Tableau Server, the user cannot be deleted unless the ownership is reassigned first.
+#'
+#' @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 user_id The ID of the user to remove.
+#' @param mapAssetsTo Optional. The ID of a user that receives ownership of contents of the user being removed.
+#'
+#' @return No return value.
+#'
+#' @family Tableau REST API
+remove_user_from_site <- function(tableau, api_version = 3.19, user_id, mapAssetsTo = NULL) {
+  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
+  )
+
+  if (!is.null(mapAssetsTo)) {
+    url <- paste0(url, "?mapAssetsTo=", mapAssetsTo)
+  }
+
+  httr::DELETE(
+    url,
+    httr::add_headers("X-Tableau-Auth" = token)
+  )
+}
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/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/remove_user_from_site.Rd b/man/remove_user_from_site.Rd