get_groups_for_user {vvtableau}

Get Groups for a User

Description

Gets a list of groups that the specified user is a member of.

Usage

get_groups_for_user(
  tableau,
  api_version = 3.19,
  user_id,
  page_size = 100,
  page_number = 1,
  include_metadata = FALSE
)

Arguments

tableau

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

api_version

The API version to use (default: 3.19).

user_id

The ID of the user whose group memberships are listed.

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.

page_number

(Optional) The offset for paging. The default is 1. For more information, see Paginating Results.

include_metadata

Logical indicating whether to include metadata columns in the result (default: FALSE).

Value

A table containing the groups for the specified user.

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_pdf(), download_workbooks_server_powerpoint(), download_workbooks_server(), 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_group(), update_user(), update_workbook_now()