From 6780f20742c9405ea902726e80344652903b45a5 Mon Sep 17 00:00:00 2001
From: Jordan Woods <13803242+jorwoods@users.noreply.github.com>
Date: Mon, 19 Aug 2024 21:43:22 -0500
Subject: [PATCH 1/2] docs: bulk add/remove users
---
docs/api-ref.md | 100 ++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 100 insertions(+)
diff --git a/docs/api-ref.md b/docs/api-ref.md
index 19211449f..8935f5db9 100644
--- a/docs/api-ref.md
+++ b/docs/api-ref.md
@@ -933,6 +933,56 @@ None.
+#### groups.add_users
+
+```py
+groups.add_users(group_item, user_id):
+```
+
+Adds multiple users to the specified group.
+
+
+REST API [Add User to Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_group)
+
+**Version**
+
+This endpoint is available with REST API version 3.21 and up. Method added in
+version v0.33
+
+**Parameters**
+
+Name | Description
+:--- | :---
+`group_item` | The `group_item` specifies the group to update.
+`users` | An Iterable of UserItems, or user ids.
+
+
+
+
+**Returns**
+
+list[UserItem]
+
+
+**Example**
+
+```py
+# Adding a user to a group
+#
+# get the group item
+ all_groups, pagination_item = server.groups.get()
+ mygroup = all_groups[1]
+
+# Add Viewers to the group
+ added_users = server.groups.add_users(
+ mygroup,
+ server.users.filter(site_role=TSC.UserItem.Roles.Viewer)
+ )
+```
+
+
+
+
#### groups.create
```py
@@ -1244,6 +1294,56 @@ None. The user is removed from the group.
+#### groups.remove_users
+
+```py
+groups.remove_users(group_item, user_id):
+```
+
+Removes multiple users to the specified group.
+
+
+REST API [Remove User from Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_to_group)
+
+**Version**
+
+This endpoint is available with REST API version 3.21 and up. Method removeed in
+version v0.33
+
+**Parameters**
+
+Name | Description
+:--- | :---
+`group_item` | The `group_item` specifies the group to update.
+`users` | An Iterable of UserItems, or user ids.
+
+
+
+
+**Returns**
+
+None
+
+
+**Example**
+
+```py
+# Removing a user to a group
+#
+# get the group item
+ all_groups, pagination_item = server.groups.get()
+ mygroup = all_groups[1]
+
+# remove Viewers from the group
+ server.groups.remove_users(
+ mygroup,
+ server.users.filter(site_role=TSC.UserItem.Roles.Viewer)
+ )
+```
+
+
+
+
#### groups.update
From 45d90cc0a92f822c1e1eefa8372916776e99f306 Mon Sep 17 00:00:00 2001
From: Jordan Woods <13803242+jorwoods@users.noreply.github.com>
Date: Tue, 20 Aug 2024 21:42:18 -0500
Subject: [PATCH 2/2] fix(docs): typos
---
docs/api-ref.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/docs/api-ref.md b/docs/api-ref.md
index 8935f5db9..b4aa45661 100644
--- a/docs/api-ref.md
+++ b/docs/api-ref.md
@@ -1300,14 +1300,14 @@ None. The user is removed from the group.
groups.remove_users(group_item, user_id):
```
-Removes multiple users to the specified group.
+Removes multiple users from the specified group.
REST API [Remove User from Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_to_group)
**Version**
-This endpoint is available with REST API version 3.21 and up. Method removeed in
+This endpoint is available with REST API version 3.21 and up. Method added in
version v0.33
**Parameters**
@@ -1328,13 +1328,13 @@ None
**Example**
```py
-# Removing a user to a group
+# Removing a user from a group
#
# get the group item
all_groups, pagination_item = server.groups.get()
mygroup = all_groups[1]
-# remove Viewers from the group
+# Remove Viewers from the group
server.groups.remove_users(
mygroup,
server.users.filter(site_role=TSC.UserItem.Roles.Viewer)