Skip to contents

Update Group

Source: R/update_group.R
update_group.Rd

Updates a group on a Tableau Server or Tableau Cloud site.

Usage

update_group(
  tableau,
  group_id,
  group_name = NULL,
  AD_group_name = NULL,
  AD_domain = NULL,
  minimum_site_role = NULL,
  license_mode = NULL,
  on_demand_access = NULL,
  asJob = FALSE,
  api_version = 3.19
)

Arguments

tableau

A list containing the Tableau authentication variables: `base_url`, `token`, and `site_id`.

group_id

The ID of the group to update.

group_name

The new name for the group (optional).

AD_group_name

The name of the Active Directory group to synchronize with (optional).

AD_domain

The domain for the Active Directory group (optional).

minimum_site_role

Required if an import element or grantLicenseMode attribute are present in the request. The site role assigned to users who are imported from Active Directory or granted a license automatically using the grant license on-sync or on-login mode.

license_mode

Optional. The mode for automatically applying licenses for group members. When the mode is onLogin, a license is granted for each group member when they log in to a site.

on_demand_access

Optional. A boolean value that is used to enable on-demand access for embedded Tableau content when the Tableau Cloud site is licensed with Embedded Analytics usage-based model.

asJob

A Boolean value indicating whether to synchronize with Active Directory as a background task (true) or synchronize immediately (false). Default is false.

api_version

The API version to use (default: 3.19).

Value

TRUE if the operation was successful, FALSE otherwise.

See also

Other Tableau REST API: add_tags_to_view(), add_tags_to_workbook(), add_user_to_group(), add_user_to_site(), authenticate_PAT(), authenticate_server(), create_group(), delete_group(), download_datasource(), download_filtered_tableau_image(), download_tableau_crosstab_excel(), download_tableau_data(), download_workbooks_server(), download_workbooks_server_pdf(), download_workbooks_server_powerpoint(), get_groups_for_user(), get_mobile_security_settings(), get_server_connected_apps(), get_server_datasources(), get_server_groups(), get_server_info(), get_server_jobs(), get_server_projects(), get_server_refresh_tasks(), get_server_schedules(), get_server_user_favorites(), get_server_users(), get_server_views(), get_server_workbooks(), get_table_assets(), get_users_in_group(), query_user_on_site(), remove_user_from_group(), remove_user_from_site(), run_extract_refresh_task(), update_data_source_now(), update_user(), update_workbook_now()