feat: support _all_ fields for UserItem

Author: jorwoods

tableauserverclient/models/user_item.py

@@ -94,6 +94,9 @@ def __init__(
         self.name: Optional[str] = name
         self.site_role: Optional[str] = site_role
         self.auth_setting: Optional[str] = auth_setting
+        self._locale: Optional[str] = None
+        self._language: Optional[str] = None
+        self._idp_configuration_id: Optional[str] = None
 
         return None
 
@@ -184,6 +187,18 @@ def groups(self) -> "Pager":
             raise UnpopulatedPropertyError(error)
         return self._groups()
 
+    @property
+    def locale(self) -> Optional[str]:
+        return self._locale
+
+    @property
+    def language(self) -> Optional[str]:
+        return self._language
+
+    @property
+    def idp_configuration_id(self) -> Optional[str]:
+        return self._idp_configuration_id
+
     def _set_workbooks(self, workbooks) -> None:
         self._workbooks = workbooks
 
@@ -204,8 +219,11 @@ def _parse_common_tags(self, user_xml, ns) -> "UserItem":
                 email,
                 auth_setting,
                 _,
+                _,
+                _,
+                _,
             ) = self._parse_element(user_xml, ns)
-            self._set_values(None, None, site_role, None, None, fullname, email, auth_setting, None)
+            self._set_values(None, None, site_role, None, None, fullname, email, auth_setting, None, None, None, None)
         return self
 
     def _set_values(
@@ -219,6 +237,9 @@ def _set_values(
         email,
         auth_setting,
         domain_name,
+        locale,
+        language,
+        idp_configuration_id,
     ):
         if id is not None:
             self._id = id
@@ -238,6 +259,12 @@ def _set_values(
             self._auth_setting = auth_setting
         if domain_name:
             self._domain_name = domain_name
+        if locale:
+            self._locale = locale
+        if language:
+            self._language = language
+        if idp_configuration_id:
+            self._idp_configuration_id = idp_configuration_id
 
     @classmethod
     def from_response(cls, resp, ns) -> list["UserItem"]:
@@ -271,6 +298,9 @@ def _parse_xml(cls, element_name, resp, ns):
                 email,
                 auth_setting,
                 domain_name,
+                locale,
+                language,
+                idp_configuration_id,
             ) = cls._parse_element(user_xml, ns)
             user_item = cls(name, site_role)
             user_item._set_values(
@@ -283,6 +313,9 @@ def _parse_xml(cls, element_name, resp, ns):
                 email,
                 auth_setting,
                 domain_name,
+                locale,
+                language,
+                idp_configuration_id,
             )
             all_user_items.append(user_item)
         return all_user_items
@@ -301,6 +334,9 @@ def _parse_element(user_xml, ns):
         fullname = user_xml.get("fullName", None)
         email = user_xml.get("email", None)
         auth_setting = user_xml.get("authSetting", None)
+        locale = user_xml.get("locale", None)
+        language = user_xml.get("language", None)
+        idp_configuration_id = user_xml.get("idpConfigurationId", None)
 
         domain_name = None
         domain_elem = user_xml.find(".//t:domain", namespaces=ns)
@@ -317,6 +353,9 @@ def _parse_element(user_xml, ns):
             email,
             auth_setting,
             domain_name,
+            locale,
+            language,
+            idp_configuration_id,
         )
 
     class CSVImport:
@@ -367,6 +406,9 @@ def create_user_from_line(line: str):
                     values[UserItem.CSVImport.ColumnType.EMAIL],
                     values[UserItem.CSVImport.ColumnType.AUTH],
                     None,
+                    None,
+                    None,
+                    None,
                 )
             return user
 

test/assets/user_get_all_fields.xml

@@ -0,0 +1,11 @@
+<ns0:tsResponse xmlns:ns0="http://tableau.com/api" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://tableau.com/api https://help.tableau.com/samples/en-us/rest_api/ts-api_3_25.xsd">
+  <ns0:pagination pageNumber="1" pageSize="100" totalAvailable="2" />
+  <ns0:users>
+    <ns0:user authSetting="TableauIDWithMFA" email="[email protected]" externalAuthUserId="38c870c3ac5e84ec66e6ced9fb23681835b07e56d5660371ac1f705cc65bd610" fullName="Bob Smith" id="ee8bc9ca-77fe-4ae0-8093-cf77f0ee67a9" lastLogin="2025-02-04T06:39:20Z" name="[email protected]" siteRole="SiteAdministratorCreator" locale="" language="en" idpConfigurationId="22222222-2222-2222-2222-222222222222">
+      <ns0:domain name="TABID_WITH_MFA" />
+    </ns0:user>
+    <ns0:user authSetting="TableauIDWithMFA" email="[email protected]" externalAuthUserId="96f66b893b22669cdfa632275d354cd1d92cea0266f3be7702151b9b8c52be29" fullName="Alice Jones" id="f6d72445-285b-48e5-8380-f90b519ce682" name="[email protected]" siteRole="ExplorerCanPublish" locale="" language="en" idpConfigurationId="22222222-2222-2222-2222-222222222222">
+      <ns0:domain name="TABID_WITH_MFA" />
+    </ns0:user>
+  </ns0:users>
+</ns0:tsResponse>

test/test_user.py

@@ -4,11 +4,12 @@
 import requests_mock
 
 import tableauserverclient as TSC
-from tableauserverclient.datetime_helpers import format_datetime
+from tableauserverclient.datetime_helpers import format_datetime, parse_datetime
 
 TEST_ASSET_DIR = os.path.join(os.path.dirname(__file__), "assets")
 
 GET_XML = os.path.join(TEST_ASSET_DIR, "user_get.xml")
+GET_XML_ALL_FIELDS = os.path.join(TEST_ASSET_DIR, "user_get_all_fields.xml")
 GET_EMPTY_XML = os.path.join(TEST_ASSET_DIR, "user_get_empty.xml")
 GET_BY_ID_XML = os.path.join(TEST_ASSET_DIR, "user_get_by_id.xml")
 UPDATE_XML = os.path.join(TEST_ASSET_DIR, "user_update.xml")
@@ -233,3 +234,37 @@ def test_get_users_from_file(self):
             users, failures = self.server.users.create_from_file(USERS)
         assert users[0].name == "Cassie", users
         assert failures == []
+
+    def test_get_users_all_fields(self) -> None:
+        self.server.version = "3.7"
+        baseurl = self.server.users.baseurl
+        with open(GET_XML_ALL_FIELDS) as f:
+            response_xml = f.read()
+
+        with requests_mock.mock() as m:
+            m.get(f"{baseurl}?fields=_all_", text=response_xml)
+            all_users, _ = self.server.users.get()
+
+        assert all_users[0].auth_setting == "TableauIDWithMFA"
+        assert all_users[0].email == "[email protected]"
+        assert all_users[0].external_auth_user_id == "38c870c3ac5e84ec66e6ced9fb23681835b07e56d5660371ac1f705cc65bd610"
+        assert all_users[0].fullname == "Bob Smith"
+        assert all_users[0].id == "ee8bc9ca-77fe-4ae0-8093-cf77f0ee67a9"
+        assert all_users[0].last_login == parse_datetime("2025-02-04T06:39:20Z")
+        assert all_users[0].name == "[email protected]"
+        assert all_users[0].site_role == "SiteAdministratorCreator"
+        assert all_users[0].locale is None
+        assert all_users[0].language == "en"
+        assert all_users[0].idp_configuration_id == "22222222-2222-2222-2222-222222222222"
+        assert all_users[0].domain_name == "TABID_WITH_MFA"
+        assert all_users[1].auth_setting == "TableauIDWithMFA"
+        assert all_users[1].email == "[email protected]"
+        assert all_users[1].external_auth_user_id == "96f66b893b22669cdfa632275d354cd1d92cea0266f3be7702151b9b8c52be29"
+        assert all_users[1].fullname == "Alice Jones"
+        assert all_users[1].id == "f6d72445-285b-48e5-8380-f90b519ce682"
+        assert all_users[1].name == "[email protected]"
+        assert all_users[1].site_role == "ExplorerCanPublish"
+        assert all_users[1].locale is None
+        assert all_users[1].language == "en"
+        assert all_users[1].idp_configuration_id == "22222222-2222-2222-2222-222222222222"
+        assert all_users[1].domain_name == "TABID_WITH_MFA"