Merge branch 'development' into jorwoods/oidc_strs

Author: jacalata

samples/update_connection_auth.py

@@ -51,7 +51,7 @@ def main():
         connection = connections[0]
         connection.username = args.datasource_username
         connection.password = args.datasource_password
-        connection.authentication_type = args.authentication_type
+        connection.auth_type = args.authentication_type
         connection.embed_password = True
 
         updated_connection = update_function(resource, connection)

samples/update_connections_auth.py

@@ -35,7 +35,7 @@ def main():
     logging_level = getattr(logging, args.logging_level.upper())
     logging.basicConfig(level=logging_level)
 
-    tableau_auth = TSC.TableauAuth(args.token_name, args.token_value, site_id=args.site)
+    tableau_auth = TSC.PersonalAccessTokenAuth(args.token_name, args.token_value, site_id=args.site)
     server = TSC.Server(args.server, use_server_version=True)
 
     with server.auth.sign_in(tableau_auth):

tableauserverclient/__init__.py

@@ -37,6 +37,7 @@
     RevisionItem,
     ScheduleItem,
     SiteAuthConfiguration,
+    SiteOIDCConfiguration,
     SiteItem,
     ServerInfoItem,
     SubscriptionItem,
@@ -125,6 +126,7 @@
     "ServerResponseError",
     "SiteItem",
     "SiteAuthConfiguration",
+    "SiteOIDCConfiguration",
     "Sort",
     "SubscriptionItem",
     "TableauAuth",

tableauserverclient/models/__init__.py

@@ -30,6 +30,7 @@
 )
 from tableauserverclient.models.location_item import LocationItem
 from tableauserverclient.models.metric_item import MetricItem
+from tableauserverclient.models.oidc_item import SiteOIDCConfiguration
 from tableauserverclient.models.pagination_item import PaginationItem
 from tableauserverclient.models.permissions_item import PermissionsRule, Permission
 from tableauserverclient.models.project_item import ProjectItem
@@ -79,6 +80,7 @@
     "BackgroundJobItem",
     "LocationItem",
     "MetricItem",
+    "SiteOIDCConfiguration",
     "PaginationItem",
     "Permission",
     "PermissionsRule",
@@ -88,6 +90,7 @@
     "ServerInfoItem",
     "SiteAuthConfiguration",
     "SiteItem",
+    "SiteOIDCConfiguration",
     "SubscriptionItem",
     "TableItem",
     "TableauAuth",

tableauserverclient/models/oidc_item.py

@@ -0,0 +1,82 @@
+from typing import Optional
+from defusedxml.ElementTree import fromstring
+
+
+class SiteOIDCConfiguration:
+    def __init__(self) -> None:
+        self.enabled: bool = False
+        self.test_login_url: Optional[str] = None
+        self.known_provider_alias: Optional[str] = None
+        self.allow_embedded_authentication: bool = False
+        self.use_full_name: bool = False
+        self.idp_configuration_name: Optional[str] = None
+        self.idp_configuration_id: Optional[str] = None
+        self.client_id: Optional[str] = None
+        self.client_secret: Optional[str] = None
+        self.authorization_endpoint: Optional[str] = None
+        self.token_endpoint: Optional[str] = None
+        self.userinfo_endpoint: Optional[str] = None
+        self.jwks_uri: Optional[str] = None
+        self.end_session_endpoint: Optional[str] = None
+        self.custom_scope: Optional[str] = None
+        self.essential_acr_values: Optional[str] = None
+        self.email_mapping: Optional[str] = None
+        self.first_name_mapping: Optional[str] = None
+        self.last_name_mapping: Optional[str] = None
+        self.full_name_mapping: Optional[str] = None
+        self.prompt: Optional[str] = None
+        self.client_authentication: Optional[str] = None
+        self.voluntary_acr_values: Optional[str] = None
+
+    def __str__(self) -> str:
+        return (
+            f"{self.__class__.__qualname__}(enabled={self.enabled}, "
+            f"test_login_url={self.test_login_url}, "
+            f"idp_configuration_name={self.idp_configuration_name}, "
+            f"idp_configuration_id={self.idp_configuration_id}, "
+            f"client_id={self.client_id})"
+        )
+
+    def __repr__(self) -> str:
+        return f"<{str(self)}>"
+
+    @classmethod
+    def from_response(cls, raw_xml: bytes, ns) -> "SiteOIDCConfiguration":
+        """
+        Parses the raw XML bytes and returns a SiteOIDCConfiguration object.
+        """
+        root = fromstring(raw_xml)
+        elem = root.find("t:siteOIDCConfiguration", namespaces=ns)
+        if elem is None:
+            raise ValueError("No siteOIDCConfiguration element found in the XML.")
+        config = cls()
+
+        config.enabled = str_to_bool(elem.get("enabled", "false"))
+        config.test_login_url = elem.get("testLoginUrl")
+        config.known_provider_alias = elem.get("knownProviderAlias")
+        config.allow_embedded_authentication = str_to_bool(elem.get("allowEmbeddedAuthentication", "false").lower())
+        config.use_full_name = str_to_bool(elem.get("useFullName", "false").lower())
+        config.idp_configuration_name = elem.get("idpConfigurationName")
+        config.idp_configuration_id = elem.get("idpConfigurationId")
+        config.client_id = elem.get("clientId")
+        config.client_secret = elem.get("clientSecret")
+        config.authorization_endpoint = elem.get("authorizationEndpoint")
+        config.token_endpoint = elem.get("tokenEndpoint")
+        config.userinfo_endpoint = elem.get("userinfoEndpoint")
+        config.jwks_uri = elem.get("jwksUri")
+        config.end_session_endpoint = elem.get("endSessionEndpoint")
+        config.custom_scope = elem.get("customScope")
+        config.essential_acr_values = elem.get("essentialAcrValues")
+        config.email_mapping = elem.get("emailMapping")
+        config.first_name_mapping = elem.get("firstNameMapping")
+        config.last_name_mapping = elem.get("lastNameMapping")
+        config.full_name_mapping = elem.get("fullNameMapping")
+        config.prompt = elem.get("prompt")
+        config.client_authentication = elem.get("clientAuthentication")
+        config.voluntary_acr_values = elem.get("voluntaryAcrValues")
+
+        return config
+
+
+def str_to_bool(s: str) -> bool:
+    return s == "true"

tableauserverclient/models/site_item.py

@@ -85,6 +85,9 @@ class SiteItem:
     state: str
         Shows the current state of the site (Active or Suspended).
 
+    attribute_capture_enabled: Optional[str]
+        Enables user attributes for all Tableau Server embedding workflows.
+
     """
 
     _user_quota: Optional[int] = None
@@ -164,6 +167,7 @@ def __init__(
         time_zone=None,
         auto_suspend_refresh_enabled: bool = True,
         auto_suspend_refresh_inactivity_window: int = 30,
+        attribute_capture_enabled: Optional[bool] = None,
     ):
         self._admin_mode = None
         self._id: Optional[str] = None
@@ -217,6 +221,7 @@ def __init__(
         self.time_zone = time_zone
         self.auto_suspend_refresh_enabled = auto_suspend_refresh_enabled
         self.auto_suspend_refresh_inactivity_window = auto_suspend_refresh_inactivity_window
+        self.attribute_capture_enabled = attribute_capture_enabled
 
     @property
     def admin_mode(self) -> Optional[str]:
@@ -720,6 +725,7 @@ def _parse_common_tags(self, site_xml, ns):
                 time_zone,
                 auto_suspend_refresh_enabled,
                 auto_suspend_refresh_inactivity_window,
+                attribute_capture_enabled,
             ) = self._parse_element(site_xml, ns)
 
             self._set_values(
@@ -774,6 +780,7 @@ def _parse_common_tags(self, site_xml, ns):
                 time_zone,
                 auto_suspend_refresh_enabled,
                 auto_suspend_refresh_inactivity_window,
+                attribute_capture_enabled,
             )
         return self
 
@@ -830,6 +837,7 @@ def _set_values(
         time_zone,
         auto_suspend_refresh_enabled,
         auto_suspend_refresh_inactivity_window,
+        attribute_capture_enabled,
     ):
         if id is not None:
             self._id = id
@@ -937,6 +945,7 @@ def _set_values(
             self.auto_suspend_refresh_enabled = auto_suspend_refresh_enabled
         if auto_suspend_refresh_inactivity_window is not None:
             self.auto_suspend_refresh_inactivity_window = auto_suspend_refresh_inactivity_window
+        self.attribute_capture_enabled = attribute_capture_enabled
 
     @classmethod
     def from_response(cls, resp, ns) -> list["SiteItem"]:
@@ -996,6 +1005,7 @@ def from_response(cls, resp, ns) -> list["SiteItem"]:
                 time_zone,
                 auto_suspend_refresh_enabled,
                 auto_suspend_refresh_inactivity_window,
+                attribute_capture_enabled,
             ) = cls._parse_element(site_xml, ns)
 
             site_item = cls(name, content_url)
@@ -1051,6 +1061,7 @@ def from_response(cls, resp, ns) -> list["SiteItem"]:
                 time_zone,
                 auto_suspend_refresh_enabled,
                 auto_suspend_refresh_inactivity_window,
+                attribute_capture_enabled,
             )
             all_site_items.append(site_item)
         return all_site_items
@@ -1132,6 +1143,9 @@ def _parse_element(site_xml, ns):
 
         flows_enabled = string_to_bool(site_xml.get("flowsEnabled", ""))
         cataloging_enabled = string_to_bool(site_xml.get("catalogingEnabled", ""))
+        attribute_capture_enabled = (
+            string_to_bool(ace) if (ace := site_xml.get("attributeCaptureEnabled")) is not None else None
+        )
 
         return (
             id,
@@ -1185,6 +1199,7 @@ def _parse_element(site_xml, ns):
             time_zone,
             auto_suspend_refresh_enabled,
             auto_suspend_refresh_inactivity_window,
+            attribute_capture_enabled,
         )
 
 

tableauserverclient/server/endpoint/__init__.py

@@ -17,6 +17,7 @@
 from tableauserverclient.server.endpoint.linked_tasks_endpoint import LinkedTasks
 from tableauserverclient.server.endpoint.metadata_endpoint import Metadata
 from tableauserverclient.server.endpoint.metrics_endpoint import Metrics
+from tableauserverclient.server.endpoint.oidc_endpoint import OIDC
 from tableauserverclient.server.endpoint.projects_endpoint import Projects
 from tableauserverclient.server.endpoint.schedules_endpoint import Schedules
 from tableauserverclient.server.endpoint.server_info_endpoint import ServerInfo
@@ -52,6 +53,7 @@
     "LinkedTasks",
     "Metadata",
     "Metrics",
+    "OIDC",
     "Projects",
     "Schedules",
     "ServerInfo",