feat: add email as a filter field for users endpoint (#1789)

feat: document email filter for users endpoint

Fixes #1562

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

Author: jacalata

tableauserverclient/server/endpoint/users_endpoint.py

@@ -717,6 +717,8 @@ def filter(self, *invalid, page_size: int | None = None, **kwargs) -> QuerySet[U
 
         domain_name=...
         domain_name__in=...
+        email=...
+        email__in=...
         friendly_name=...
         friendly_name__in=...
         is_local=...

tableauserverclient/server/request_options.py

@@ -137,6 +137,7 @@ class Field:
         DisplayTabs = "displayTabs"
         DomainName = "domainName"
         DomainNickname = "domainNickname"
+        Email = "email"
         FavoritesTotal = "favoritesTotal"
         Fields = "fields"
         FlowId = "flowId"

test/test_user.py

@@ -541,6 +541,33 @@ def test_add_idp_and_auth_error(server: TSC.Server) -> None:
         server.users.bulk_add(users)
 
 
+def test_filter_by_email(server: TSC.Server) -> None:
+    response_xml = GET_XML.read_text()
+    with requests_mock.mock() as m:
+        m.get(requests_mock.ANY, text=response_xml)
+        qs = server.users.filter(email="test@example.com")
+
+        # Access total_available to trigger the HTTP request and inspect the query string
+        assert qs.total_available == 2
+        assert len(m.request_history) >= 1
+        first_request_qs = m.request_history[0].qs
+        assert "filter" in first_request_qs
+        assert "email:eq:test@example.com" in first_request_qs["filter"]
+
+
+def test_filter_by_email_in(server: TSC.Server) -> None:
+    response_xml = GET_XML.read_text()
+    with requests_mock.mock() as m:
+        m.get(requests_mock.ANY, text=response_xml)
+        qs = server.users.filter(email__in=["alice@example.com", "bob@example.com"])
+
+        assert qs.total_available == 2
+        assert len(m.request_history) >= 1
+        first_request_qs = m.request_history[0].qs
+        assert "filter" in first_request_qs
+        assert "email:in:[alice@example.com,bob@example.com]" in first_request_qs["filter"]
+
+
 def test_remove_users_csv(server: TSC.Server) -> None:
     server.version = "3.15"
     users = [