From 4587decd678300217969f1d2f69b226421a33ced Mon Sep 17 00:00:00 2001
From: Shay <hillerys@element.io>
Date: Fri, 22 Nov 2024 04:37:19 -0800
Subject: [PATCH] Return suspended status when querying user account (#17952)

---
 changelog.d/17952.misc           | 1 +
 docs/admin_api/user_admin_api.md | 3 ++-
 synapse/handlers/admin.py        | 1 +
 tests/rest/admin/test_user.py    | 1 +
 4 files changed, 5 insertions(+), 1 deletion(-)
 create mode 100644 changelog.d/17952.misc

diff --git a/changelog.d/17952.misc b/changelog.d/17952.misc
new file mode 100644
index 0000000000..84fc8bfc29
--- /dev/null
+++ b/changelog.d/17952.misc
@@ -0,0 +1 @@
+Return whether the user is suspended when querying the user account in the Admin API.
\ No newline at end of file
diff --git a/docs/admin_api/user_admin_api.md b/docs/admin_api/user_admin_api.md
index 96a2994b7b..a6e2e0a153 100644
--- a/docs/admin_api/user_admin_api.md
+++ b/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
 }
 ```
 
diff --git a/synapse/handlers/admin.py b/synapse/handlers/admin.py
index d1989e9d2c..d1194545ae 100644
--- a/synapse/handlers/admin.py
+++ b/synapse/handlers/admin.py
@@ -124,6 +124,7 @@ class AdminHandler:
             "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:
diff --git a/tests/rest/admin/test_user.py b/tests/rest/admin/test_user.py
index 6d050e7784..fdb8fafa0e 100644
--- a/tests/rest/admin/test_user.py
+++ b/tests/rest/admin/test_user.py
@@ -3222,6 +3222,7 @@ class UserRestTestCase(unittest.HomeserverTestCase):
         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)