feat: enable idp_configuration_id in bulk_add

Author: jorwoods

tableauserverclient/server/endpoint/users_endpoint.py

@@ -403,7 +403,8 @@ def bulk_add(self, users: Iterable[UserItem]) -> JobItem:
 
         Email is optional, but if provided, it must be a valid email address.
 
-        If auth_setting is not provided, the default is ServerDefault.
+        If auth_setting is not provided, and idp_configuration_id is None, then
+        default is ServerDefault.
 
         If site_role is not provided, the default is Unlicensed.
 
@@ -414,6 +415,10 @@ def bulk_add(self, users: Iterable[UserItem]) -> JobItem:
         Details about administrator level and publishing capability are
         inferred from the site_role.
 
+        If the user belongs to a different IDP configuration, the UserItem's
+        idp_configuration_id attribute must be set to the IDP configuration ID
+        that the user belongs to.
+
         Parameters
         ----------
         users: Iterable[UserItem]
@@ -733,7 +738,7 @@ def filter(self, *invalid, page_size: Optional[int] = None, **kwargs) -> QuerySe
         return super().filter(*invalid, page_size=page_size, **kwargs)
 
 
-def create_users_csv(users: Iterable[UserItem], identity_pool=None) -> bytes:
+def create_users_csv(users: Iterable[UserItem]) -> bytes:
     """
     Create a CSV byte string from an Iterable of UserItem objects. The CSV will
     have the following columns, and no header row:
@@ -761,8 +766,6 @@ def create_users_csv(users: Iterable[UserItem], identity_pool=None) -> bytes:
     bytes
         A byte string containing the CSV data.
     """
-    if identity_pool is not None:
-        raise NotImplementedError("Identity pool is not supported in this version")
     with io.StringIO() as output:
         writer = csv.writer(output, quoting=csv.QUOTE_MINIMAL)
         for user in users:

tableauserverclient/server/request_factory.py

@@ -943,7 +943,12 @@ def import_from_csv_req(self, csv_content: bytes, users: Iterable[UserItem]):
                 raise ValueError("User name must be populated.")
             user_element = ET.SubElement(xml_request, "user")
             user_element.attrib["name"] = user.name
-            user_element.attrib["authSetting"] = user.auth_setting or "ServerDefault"
+            if user.auth_setting is not None and user.idp_configuration_id is not None:
+                raise ValueError("User cannot have both authSetting and idpConfigurationId.")
+            elif user.idp_configuration_id is not None:
+                user_element.attrib["idpConfigurationId"] = user.idp_configuration_id
+            else:
+                user_element.attrib["authSetting"] = user.auth_setting or "ServerDefault"
 
         parts = {
             "tableau_user_import": ("tsc_users_file.csv", csv_content, "file"),

test/test_user.py

@@ -37,6 +37,7 @@ def make_user(
     domain: str = "",
     fullname: str = "",
     email: str = "",
+    idp_id: str = "",
 ) -> TSC.UserItem:
     user = TSC.UserItem(name, site_role or None)
     if auth_setting:
@@ -47,6 +48,8 @@ def make_user(
         user.fullname = fullname
     if email:
         user.email = email
+    if idp_id:
+        user.idp_configuration_id = idp_id
     return user
 
 
@@ -415,6 +418,7 @@ def test_bulk_add(self):
             make_user("Frank", "SiteAdministratorExplorer", "TableauIDWithMFA", email="Frank@example.com"),
             make_user("Grace", "SiteAdministratorCreator", "SAML", "example.com", "Grace Example", "gex@example.com"),
             make_user("Hank", "Unlicensed"),
+            make_user("Ivy", "Unlicensed", idp_id="0123456789"),
         ]
         with requests_mock.mock() as m:
             m.post(f"{self.server.users.baseurl}/import", text=BULK_ADD_XML.read_text())
@@ -446,7 +450,11 @@ def test_bulk_add(self):
 
             for user, xml_user in zip(users, xml_users):
                 assert user.name == xml_user.get("name")
-                assert xml_user.get("authSetting") == (user.auth_setting or "ServerDefault")
+                if user.idp_configuration_id is None:
+                    assert xml_user.get("authSetting") == (user.auth_setting or "ServerDefault")
+                else:
+                    assert xml_user.get("idpConfigurationId") == user.idp_configuration_id
+                    assert xml_user.get("authSetting") is None
 
             csv_data = create_users_csv(users).replace(b"\r\n", b"\n")
             assert csv_data.strip() == segments[0].split(b"\n\n")[1].strip()
@@ -505,3 +513,10 @@ def test_add_all(self) -> None:
                 self.server.users.add_all(users)
 
         assert mock_add.call_count == len(users)
+
+    def test_add_idp_and_auth_error(self) -> None:
+        self.server.version = "3.24"
+        users = [make_user("Alice", "Viewer", auth_setting="SAML", idp_id="01234")]
+
+        with pytest.raises(ValueError, match="User cannot have both authSetting and idpConfigurationId."):
+            self.server.users.bulk_add(users)