Return suspended status when querying user account (#17952)

changelog.d/17952.misc

@@ -0,0 +1 @@
+Return whether the user is suspended when querying the user account in the Admin API.

docs/admin_api/user_admin_api.md

@@ -55,7 +55,8 @@ It returns a JSON body like the following:
         }
     ],
     "user_type": null,
-    "locked": false
+    "locked": false,
+    "suspended": false
 }
 ```
 

synapse/handlers/admin.py

@@ -124,6 +124,7 @@ async def get_user(self, user: UserID) -> Optional[JsonMapping]:
             "consent_ts": user_info.consent_ts,
             "user_type": user_info.user_type,
             "is_guest": user_info.is_guest,
+            "suspended": user_info.suspended,
         }
 
         if self._msc3866_enabled:

tests/rest/admin/test_user.py

@@ -3222,6 +3222,7 @@ def _check_fields(self, content: JsonDict) -> None:
         self.assertIn("consent_ts", content)
         self.assertIn("external_ids", content)
         self.assertIn("last_seen_ts", content)
+        self.assertIn("suspended", content)
 
         # This key was removed intentionally. Ensure it is not accidentally re-included.
         self.assertNotIn("password_hash", content)