Updated TSC with new API's

Author: vchavatapalli

samples/update_connection_auth.py

@@ -4,18 +4,15 @@
 
 
 def main():
-    parser = argparse.ArgumentParser(
-        description="Update a single connection on a datasource or workbook to embed credentials"
-    )
+    parser = argparse.ArgumentParser(description="Update a single connection on a datasource or workbook to embed credentials")
 
     # Common options
     parser.add_argument("--server", "-s", help="Server address", required=True)
     parser.add_argument("--site", "-S", help="Site name", required=True)
     parser.add_argument("--token-name", "-p", help="Personal access token name", required=True)
     parser.add_argument("--token-value", "-v", help="Personal access token value", required=True)
     parser.add_argument(
-        "--logging-level",
-        "-l",
+        "--logging-level", "-l",
         choices=["debug", "info", "error"],
         default="error",
         help="Logging level (default: error)",
@@ -39,7 +36,10 @@ def main():
     server = TSC.Server(args.server, use_server_version=True)
 
     with server.auth.sign_in(tableau_auth):
-        endpoint = {"workbook": server.workbooks, "datasource": server.datasources}.get(args.resource_type)
+        endpoint = {
+            "workbook": server.workbooks,
+            "datasource": server.datasources
+        }.get(args.resource_type)
 
         update_function = endpoint.update_connection
         resource = endpoint.get_by_id(args.resource_id)
@@ -51,7 +51,7 @@ def main():
         connection = connections[0]
         connection.username = args.datasource_username
         connection.password = args.datasource_password
-        connection.auth_type = args.authentication_type
+        connection.authentication_type = args.authentication_type
         connection.embed_password = True
 
         updated_connection = update_function(resource, connection)

samples/update_connections_auth.py

@@ -9,8 +9,8 @@ def main():
     # Common options
     parser.add_argument("--server", "-s", help="Server address", required=True)
     parser.add_argument("--site", "-S", help="Site name", required=True)
-    parser.add_argument("--token-name", "-p", help="Personal access token name", required=True)
-    parser.add_argument("--token-value", "-v", help="Personal access token value", required=True)
+    parser.add_argument("--username", "-p", help="Personal access token name", required=True)
+    parser.add_argument("--password", "-v", help="Personal access token value", required=True)
     parser.add_argument(
         "--logging-level",
         "-l",
@@ -25,21 +25,22 @@ def main():
     parser.add_argument("datasource_username")
     parser.add_argument("authentication_type")
     parser.add_argument("--datasource_password", default=None, help="Datasource password (optional)")
-    parser.add_argument(
-        "--embed_password", default="true", choices=["true", "false"], help="Embed password (default: true)"
-    )
+    parser.add_argument("--embed_password", default="true", choices=["true", "false"], help="Embed password (default: true)")
 
     args = parser.parse_args()
 
     # Set logging level
     logging_level = getattr(logging, args.logging_level.upper())
     logging.basicConfig(level=logging_level)
 
-    tableau_auth = TSC.PersonalAccessTokenAuth(args.token_name, args.token_value, site_id=args.site)
+    tableau_auth = TSC.TableauAuth(args.username, args.password, site_id=args.site)
     server = TSC.Server(args.server, use_server_version=True)
 
     with server.auth.sign_in(tableau_auth):
-        endpoint = {"workbook": server.workbooks, "datasource": server.datasources}.get(args.resource_type)
+        endpoint = {
+            "workbook": server.workbooks,
+            "datasource": server.datasources
+        }.get(args.resource_type)
 
         resource = endpoint.get_by_id(args.resource_id)
         endpoint.populate_connections(resource)
@@ -48,16 +49,16 @@ def main():
         embed_password = args.embed_password.lower() == "true"
 
         # Call unified update_connections method
-        connection_items = endpoint.update_connections(
+        updated_ids = endpoint.update_connections(
             resource,
             connection_luids=connection_luids,
             authentication_type=args.authentication_type,
             username=args.datasource_username,
             password=args.datasource_password,
-            embed_password=embed_password,
+            embed_password=embed_password
         )
 
-        print(f"Updated connections on {args.resource_type} {args.resource_id}: {connection_items}")
+        print(f"Updated connections on {args.resource_type} {args.resource_id}: {updated_ids}")
 
 
 if __name__ == "__main__":

tableauserverclient/models/connection_item.py

@@ -84,6 +84,10 @@ def connection_type(self) -> Optional[str]:
     def query_tagging(self) -> Optional[bool]:
         return self._query_tagging
 
+    @property
+    def auth_type(self) -> Optional[str]:
+        return self._auth_type
+
     @query_tagging.setter
     @property_is_boolean
     def query_tagging(self, value: Optional[bool]):

tableauserverclient/server/endpoint/datasources_endpoint.py

@@ -376,14 +376,8 @@ def update_connection(
 
     @api(version="3.26")
     def update_connections(
-        self,
-        datasource_item: DatasourceItem,
-        connection_luids: Iterable[str],
-        authentication_type: str,
-        username: Optional[str] = None,
-        password: Optional[str] = None,
-        embed_password: Optional[bool] = None,
-    ) -> list[ConnectionItem]:
+        self, datasource_item: DatasourceItem, connection_luids: list[str], authentication_type: str, username: Optional[str] = None, password: Optional[str] = None, embed_password: Optional[bool] = None
+    ) -> list[str]:
         """
         Bulk updates one or more datasource connections by LUID.
 
@@ -392,7 +386,7 @@ def update_connections(
         datasource_item : DatasourceItem
             The datasource item containing the connections.
 
-        connection_luids : Iterable of str
+        connection_luids : list of str
             The connection LUIDs to update.
 
         authentication_type : str
@@ -409,25 +403,42 @@ def update_connections(
 
         Returns
         -------
-        Iterable of str
+        list of str
             The connection LUIDs that were updated.
         """
+        from xml.etree.ElementTree import Element, SubElement, tostring
 
         url = f"{self.baseurl}/{datasource_item.id}/connections"
+        print("Method URL:", url)
 
-        request_body = RequestFactory.Datasource.update_connections_req(
-            connection_luids=connection_luids,
-            authentication_type=authentication_type,
-            username=username,
-            password=password,
-            embed_password=embed_password,
-        )
-        server_response = self.put_request(url, request_body)
-        connection_items = ConnectionItem.from_response(server_response.content, self.parent_srv.namespace)
-        updated_ids: list[str] = [conn.id for conn in connection_items]
+        ts_request = Element("tsRequest")
+
+        # <connectionLuids>
+        conn_luids_elem = SubElement(ts_request, "connectionLuids")
+        for luid in connection_luids:
+            SubElement(conn_luids_elem, "connectionLuid").text = luid
+
+        # <connection>
+        connection_elem = SubElement(ts_request, "connection")
+        connection_elem.set("authenticationType", authentication_type)
 
-        logger.info(f"Updated connections for datasource {datasource_item.id}: {', '.join(updated_ids)}")
-        return connection_items
+        if username:
+            connection_elem.set("userName", username)
+
+        if password:
+            connection_elem.set("password", password)
+
+        if embed_password is not None:
+            connection_elem.set("embedPassword", str(embed_password).lower())
+
+        request_body = tostring(ts_request)
+
+        response = self.put_request(url, request_body)
+
+        logger.info(
+            f"Updated connections for datasource {datasource_item.id}: {', '.join(connection_luids)}"
+        )
+        return connection_luids
 
     @api(version="2.8")
     def refresh(self, datasource_item: Union[DatasourceItem, str], incremental: bool = False) -> JobItem:

tableauserverclient/server/endpoint/workbooks_endpoint.py

@@ -330,79 +330,69 @@ def update_connection(self, workbook_item: WorkbookItem, connection_item: Connec
 
     # Update workbook_connections
     @api(version="3.26")
-    def update_connections(
-        self,
-        workbook_item: WorkbookItem,
-        connection_luids: Iterable[str],
-        authentication_type: str,
-        username: Optional[str] = None,
-        password: Optional[str] = None,
-        embed_password: Optional[bool] = None,
-    ) -> list[ConnectionItem]:
-        """
-        Bulk updates one or more workbook connections by LUID, including authenticationType, username, password, and embedPassword.
+    def update_connections(self, workbook_item: WorkbookItem, connection_luids: list[str], authentication_type: str, username: Optional[str] = None, password: Optional[str] = None, embed_password: Optional[bool] = None
+     ) -> list[str]:
+         """
+         Bulk updates one or more workbook connections by LUID, including authenticationType, username, password, and embedPassword.
 
-        Parameters
-        ----------
-        workbook_item : WorkbookItem
-            The workbook item containing the connections.
+         Parameters
+         ----------
+         workbook_item : WorkbookItem
+             The workbook item containing the connections.
 
-        connection_luids : Iterable of str
-            The connection LUIDs to update.
+         connection_luids : list of str
+             The connection LUIDs to update.
 
-        authentication_type : str
-            The authentication type to use (e.g., 'AD Service Principal').
+         authentication_type : str
+             The authentication type to use (e.g., 'AD Service Principal').
 
-        username : str, optional
-            The username to set (e.g., client ID for keypair auth).
+         username : str, optional
+             The username to set (e.g., client ID for keypair auth).
 
-        password : str, optional
-            The password or secret to set.
+         password : str, optional
+             The password or secret to set.
 
-        embed_password : bool, optional
-            Whether to embed the password.
+         embed_password : bool, optional
+             Whether to embed the password.
 
-        Returns
-        -------
-        Iterable of str
-            The connection LUIDs that were updated.
-        """
+         Returns
+         -------
+         list of str
+             The connection LUIDs that were updated.
+         """
+         from xml.etree.ElementTree import Element, SubElement, tostring
 
-        url = f"{self.baseurl}/{workbook_item.id}/connections"
+         url = f"{self.baseurl}/{workbook_item.id}/connections"
 
-        request_body = RequestFactory.Workbook.update_connections_req(
-            connection_luids,
-            authentication_type,
-            username=username,
-            password=password,
-            embed_password=embed_password,
-        )
+         ts_request = Element("tsRequest")
 
-        # Send request
-        server_response = self.put_request(url, request_body)
-        connection_items = ConnectionItem.from_response(server_response.content, self.parent_srv.namespace)
-        updated_ids: list[str] = [conn.id for conn in connection_items]
+         # <connectionLuids>
+         conn_luids_elem = SubElement(ts_request, "connectionLuids")
+         for luid in connection_luids:
+             SubElement(conn_luids_elem, "connectionLuid").text = luid
 
-        logger.info(f"Updated connections for workbook {workbook_item.id}: {', '.join(updated_ids)}")
-        return connection_items
+         # <connection>
+         connection_elem = SubElement(ts_request, "connection")
+         connection_elem.set("authenticationType", authentication_type)
 
-    T = TypeVar("T", bound=FileObjectW)
+         if username:
+             connection_elem.set("userName", username)
 
-    @overload
-    def download(
-        self,
-        workbook_id: str,
-        filepath: T,
-        include_extract: bool = True,
-    ) -> T: ...
+         if password:
+             connection_elem.set("password", password)
 
-    @overload
-    def download(
-        self,
-        workbook_id: str,
-        filepath: Optional[FilePath] = None,
-        include_extract: bool = True,
-    ) -> str: ...
+         if embed_password is not None:
+             connection_elem.set("embedPassword", str(embed_password).lower())
+
+         request_body = tostring(ts_request)
+
+         # Send request
+         response = self.put_request(url, request_body)
+
+         logger.info(
+             f"Updated connections for workbook {workbook_item.id}: {', '.join(connection_luids)}"
+         )
+         return connection_luids
 
     # Download workbook contents with option of passing in filepath
     @api(version="2.0")

test/assets/datasource_connections_update.xml

@@ -1,21 +1,21 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <tsResponse xmlns="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">
+            xsi:schemaLocation="http://tableau.com/api http://tableau.com/api/ts-api-3.26.xsd">
     <connections>
         <connection id="be786ae0-d2bf-4a4b-9b34-e2de8d2d4488"
                     type="sqlserver"
                     serverAddress="updated-server"
                     serverPort="1433"
                     userName="user1"
                     embedPassword="true"
-                    authenticationType="auth-keypair" />
+                    authentication="auth-keypair" />
         <connection id="a1b2c3d4-e5f6-7a8b-9c0d-123456789abc"
                     type="sqlserver"
                     serverAddress="updated-server"
                     serverPort="1433"
                     userName="user1"
                     embedPassword="true"
-                    authenticationType="auth-keypair" />
+                    authentication="auth-keypair" />
     </connections>
 </tsResponse>

test/assets/workbook_update_connections.xml

@@ -1,21 +1,21 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <tsResponse xmlns="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">
+            xsi:schemaLocation="http://tableau.com/api http://tableau.com/api/ts-api-3.26.xsd">
     <connections>
         <connection id="abc12345-def6-7890-gh12-ijklmnopqrst"
                     type="sqlserver"
                     serverAddress="updated-db-host"
                     serverPort="1433"
                     userName="svc-client"
                     embedPassword="true"
-                    authenticationType="AD Service Principal" />
+                    authentication="AD Service Principal" />
         <connection id="1234abcd-5678-efgh-ijkl-0987654321mn"
                     type="sqlserver"
                     serverAddress="updated-db-host"
                     serverPort="1433"
                     userName="svc-client"
                     embedPassword="true"
-                    authenticationType="AD Service Principal" />
+                    authentication="AD Service Principal" />
     </connections>
 </tsResponse>