pyxecm 3.4.6__tar.gz → 3.4.8__tar.gz

{pyxecm-3.4.6 → pyxecm-3.4.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyxecm
-Version: 3.4.6
+Version: 3.4.8
 Summary: A Python library to interact with Opentext Content Management Rest API
 Project-URL: Homepage, https://github.com/opentext/pyxecm
 Author-email: Kai Gatzweiler <kgatzweiler@opentext.com>, "Dr. Marc Diefenbruch" <mdiefenb@opentext.com>

{pyxecm-3.4.6 → pyxecm-3.4.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyxecm"
-version = "3.4.6"
+version = "3.4.8"
 description = 'A Python library to interact with Opentext Content Management Rest API'
 keywords = [
   'opentext',

{pyxecm-3.4.6 → pyxecm-3.4.8}/src/pyxecm/otcs.py

@@ -1892,7 +1892,13 @@ class OTCS:
 
         # First do some sanity checks:
         if not response:
-            self.logger.debug("Empty response - no results found!")
+            self.logger.debug("Empty REST response. Cannot get result value! Returning None.")
+            return None
+        if "error" in response:
+            self.logger.error(
+                "REST response contains an error -> %s. Cannot get result value! Returning None.",
+                str(response["error"]),
+            )
             return None
 
         # To support also iterators that yield from results,
@@ -1903,7 +1909,7 @@ class OTCS:
 
         if "results" not in response:
             if show_error:
-                self.logger.error("No 'results' key in REST response - returning None")
+                self.logger.error("No 'results' key in REST response. Cannot get result value! Returning None.")
             return None
 
         results = response["results"]
@@ -2034,10 +2040,16 @@ class OTCS:
 
         # First do some sanity checks:
         if not response:
-            self.logger.debug("Empty REST response - returning None")
+            self.logger.debug("Empty REST response. Cannot get result values! Returning None.")
+            return None
+        if "error" in response:
+            self.logger.error(
+                "REST response contains an error -> %s. Cannot get result values! Returning None.",
+                str(response["error"]),
+            )
             return None
         if "results" not in response:
-            self.logger.error("No 'results' key in REST response - returning None")
+            self.logger.error("No 'results' key in REST response. Cannot get result values! Returning None.")
             return None
 
         results = response["results"]
@@ -15032,6 +15044,7 @@ class OTCS:
         external_modify_date: str | None = None,
         external_create_date: str | None = None,
         show_error: bool = True,
+        parse_error_response: bool = False,
     ) -> dict | None:
         """Create a new business workspace.
 
@@ -15076,6 +15089,8 @@ class OTCS:
                 If True, log an error if workspace creation fails.
                 If False, log a warning instead.
                 True is the default.
+            parse_error_response (bool, optional):
+                Whether to parse the request response or not. Defaults to False.
 
         Returns:
             dict | None:
@@ -15202,8 +15217,12 @@ class OTCS:
             ),
             show_error=show_error,
             show_warning=(not show_error),
+            parse_error_response=parse_error_response,
         )
 
+        if "error" in response:
+            return response
+
         node_id = self.get_result_value(response=response, key="id")
         if node_id:
             trace.get_current_span().set_attribute("workspace.id", node_id)

{pyxecm-3.4.6 → pyxecm-3.4.8}/src/pyxecm/otds.py

@@ -957,6 +957,100 @@ class OTDS:
 
     # end method definition
 
+    @tracer.start_as_current_span(attributes=OTEL_TRACING_ATTRIBUTES, name="authenticate_user_token")
+    def authenticate_user_token(
+        self,
+        username: str,
+        password: str,
+        scope: str = "otds:roles",
+    ) -> str | None:
+        """Authenticate a user via the OAuth2 password grant and return a JWT access token.
+
+        Unlike :meth:`authenticate` with ``grant_type="password"`` (which hits the
+        legacy credential endpoint and returns an OTDS SSO ticket), this method posts
+        ``grant_type=password`` together with the configured OAuth client credentials to
+        the OAuth2 token endpoint (``/otdsws/oauth2/token``).  This produces a signed
+        JWT access token that can be used as a standard ``Authorization: Bearer`` token.
+
+        The ``client_id`` and ``client_secret`` must be configured on the OTDS object
+        (passed to the constructor) before calling this method.
+
+        Args:
+            username (str):
+                The OTDS login name of the user to authenticate.
+            password (str):
+                The password for the OTDS user.
+            scope (str, optional):
+                OAuth2 scope string to request.  Defaults to ``"otds:roles"``.
+
+        Returns:
+            str | None:
+                The JWT access token, or ``None`` if authentication fails.
+                The token is also stored in ``self._token``.
+
+        Example:
+                'eyJraWQiOiJvdGRzLXNpZ25pbmcta2V5IiwiYWxnIjoiUlMyNTYifQ...'
+
+        """
+
+        request_url = self.token_url()
+
+        request_data = {
+            "grant_type": "password",
+            "client_id": self.config()["clientId"],
+            "client_secret": self.config()["clientSecret"],
+            "username": username,
+            "password": password,
+            "scope": scope,
+        }
+
+        self.logger.debug(
+            "Requesting OTDS user access token for -> '%s'; calling -> %s",
+            username,
+            request_url,
+        )
+
+        try:
+            response = requests.post(
+                url=request_url,
+                headers=REQUEST_FORM_HEADERS,
+                data=request_data,
+                timeout=REQUEST_TIMEOUT,
+            )
+        except requests.exceptions.RequestException as exception:
+            self.logger.warning(
+                "Unable to connect to OTDS token endpoint -> %s; error -> %s",
+                request_url,
+                str(exception),
+            )
+            return None
+
+        if not response.ok:
+            self.logger.error(
+                "Failed to request user access token for -> '%s'; error -> %s",
+                username,
+                response.text,
+            )
+            return None
+
+        token_dict = self.parse_request_response(response)
+        if not token_dict:
+            return None
+
+        access_token = token_dict.get("access_token")
+        if not access_token:
+            self.logger.error(
+                "OTDS token response for user -> '%s' did not contain an access_token",
+                username,
+            )
+            return None
+
+        self._token = access_token
+        self._cookie = None
+        return self._token
+
+    # end method definition
+
     @tracer.start_as_current_span(attributes=OTEL_TRACING_ATTRIBUTES, name="impersonate_user")
     def impersonate_user(
         self,