Return user response in update/patch user (#500)

Author: dorsha

descope/management/user.py

@@ -326,7 +326,7 @@ def update(
         verified_phone: Optional[bool] = None,
         additional_login_ids: Optional[List[str]] = None,
         sso_app_ids: Optional[List[str]] = None,
-    ):
+    ) -> dict:
         """
         Update an existing user with the given various fields. IMPORTANT: All parameters are used as overrides
         to the existing user. Empty fields will override populated fields. Use carefully.
@@ -348,13 +348,18 @@ def update(
         custom_attributes (dict): Optional, set the different custom attributes values of the keys that were previously configured in Descope console app
         sso_app_ids (List[str]): Optional, list of SSO applications IDs to be associated with the user.
 
+        Return value (dict):
+        Return dict in the format
+             {"user": {}}
+        Containing the updated user information.
+
         Raise:
         AuthException: raised if update operation fails
         """
         role_names = [] if role_names is None else role_names
         user_tenants = [] if user_tenants is None else user_tenants
 
-        self._auth.do_post(
+        response = self._auth.do_post(
             MgmtV1.user_update_path,
             User._compose_update_body(
                 login_id,
@@ -377,6 +382,7 @@ def update(
             ),
             pswd=self._auth.management_key,
         )
+        return response.json()
 
     def patch(
         self,
@@ -394,7 +400,7 @@ def patch(
         verified_email: Optional[bool] = None,
         verified_phone: Optional[bool] = None,
         sso_app_ids: Optional[List[str]] = None,
-    ):
+    ) -> dict:
         """
         Patches an existing user with the given various fields. Only the given fields will be used to update the user.
 
@@ -414,10 +420,15 @@ def patch(
         custom_attributes (dict): Optional, set the different custom attributes values of the keys that were previously configured in Descope console app
         sso_app_ids (List[str]): Optional, list of SSO applications IDs to be associated with the user.
 
+        Return value (dict):
+        Return dict in the format
+             {"user": {}}
+        Containing the patched user information.
+
         Raise:
         AuthException: raised if patch operation fails
         """
-        self._auth.do_patch(
+        response = self._auth.do_patch(
             MgmtV1.user_patch_path,
             User._compose_patch_body(
                 login_id,
@@ -437,6 +448,7 @@ def patch(
             ),
             pswd=self._auth.management_key,
         )
+        return response.json()
 
     def delete(
         self,

tests/management/test_user.py

@@ -445,17 +445,20 @@ def test_update(self):
 
         # Test success flow
         with patch("requests.post") as mock_post:
-            mock_post.return_value.ok = True
-            self.assertIsNone(
-                self.client.mgmt.user.update(
-                    "id",
-                    display_name="new-name",
-                    role_names=["domain.com"],
-                    picture="https://test.com",
-                    custom_attributes={"ak": "av"},
-                    sso_app_ids=["app1", "app2"],
-                )
+            network_resp = mock.Mock()
+            network_resp.ok = True
+            network_resp.json.return_value = json.loads("""{"user": {"id": "u1"}}""")
+            mock_post.return_value = network_resp
+            resp = self.client.mgmt.user.update(
+                "id",
+                display_name="new-name",
+                role_names=["domain.com"],
+                picture="https://test.com",
+                custom_attributes={"ak": "av"},
+                sso_app_ids=["app1", "app2"],
             )
+            user = resp["user"]
+            self.assertEqual(user["id"], "u1")
             mock_post.assert_called_with(
                 f"{common.DEFAULT_BASE_URL}{MgmtV1.user_update_path}",
                 headers={
@@ -482,12 +485,15 @@ def test_update(self):
             )
         # Test success flow with verified flags
         with patch("requests.post") as mock_post:
-            mock_post.return_value.ok = True
-            self.assertIsNone(
-                self.client.mgmt.user.update(
-                    "id", verified_email=True, verified_phone=False
-                )
+            network_resp = mock.Mock()
+            network_resp.ok = True
+            network_resp.json.return_value = json.loads("""{"user": {"id": "u1"}}""")
+            mock_post.return_value = network_resp
+            resp = self.client.mgmt.user.update(
+                "id", verified_email=True, verified_phone=False
             )
+            user = resp["user"]
+            self.assertEqual(user["id"], "u1")
             mock_post.assert_called_with(
                 f"{common.DEFAULT_BASE_URL}{MgmtV1.user_update_path}",
                 headers={
@@ -528,21 +534,24 @@ def test_patch(self):
 
         # Test success flow with some params set
         with patch("requests.patch") as mock_patch:
-            mock_patch.return_value.ok = True
-            self.assertIsNone(
-                self.client.mgmt.user.patch(
-                    "id",
-                    display_name="new-name",
-                    email=None,
-                    phone=None,
-                    given_name=None,
-                    role_names=["domain.com"],
-                    user_tenants=None,
-                    picture="https://test.com",
-                    custom_attributes={"ak": "av"},
-                    sso_app_ids=["app1", "app2"],
-                )
+            network_resp = mock.Mock()
+            network_resp.ok = True
+            network_resp.json.return_value = json.loads("""{"user": {"id": "u1"}}""")
+            mock_patch.return_value = network_resp
+            resp = self.client.mgmt.user.patch(
+                "id",
+                display_name="new-name",
+                email=None,
+                phone=None,
+                given_name=None,
+                role_names=["domain.com"],
+                user_tenants=None,
+                picture="https://test.com",
+                custom_attributes={"ak": "av"},
+                sso_app_ids=["app1", "app2"],
             )
+            user = resp["user"]
+            self.assertEqual(user["id"], "u1")
             mock_patch.assert_called_with(
                 f"{common.DEFAULT_BASE_URL}{MgmtV1.user_patch_path}",
                 headers={
@@ -564,25 +573,28 @@ def test_patch(self):
             )
         # Test success flow with other params
         with patch("requests.patch") as mock_patch:
-            mock_patch.return_value.ok = True
-            self.assertIsNone(
-                self.client.mgmt.user.patch(
-                    "id",
-                    email="[email protected]",
-                    phone="+123456789",
-                    given_name="given",
-                    middle_name="middle",
-                    family_name="family",
-                    role_names=None,
-                    user_tenants=[
-                        AssociatedTenant("tenant1"),
-                        AssociatedTenant("tenant2", ["role1", "role2"]),
-                    ],
-                    custom_attributes=None,
-                    verified_email=True,
-                    verified_phone=False,
-                )
+            network_resp = mock.Mock()
+            network_resp.ok = True
+            network_resp.json.return_value = json.loads("""{"user": {"id": "u1"}}""")
+            mock_patch.return_value = network_resp
+            resp = self.client.mgmt.user.patch(
+                "id",
+                email="[email protected]",
+                phone="+123456789",
+                given_name="given",
+                middle_name="middle",
+                family_name="family",
+                role_names=None,
+                user_tenants=[
+                    AssociatedTenant("tenant1"),
+                    AssociatedTenant("tenant2", ["role1", "role2"]),
+                ],
+                custom_attributes=None,
+                verified_email=True,
+                verified_phone=False,
             )
+            user = resp["user"]
+            self.assertEqual(user["id"], "u1")
             mock_patch.assert_called_with(
                 f"{common.DEFAULT_BASE_URL}{MgmtV1.user_patch_path}",
                 headers={