Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Remove old admin API GET /_synapse/admin/v1/users/<user_id> (#9401)
Browse files Browse the repository at this point in the history
Related: #8334
Deprecated in: #9429 - Synapse 1.28.0 (2021-02-25)

`GET /_synapse/admin/v1/users/<user_id>` has no
- unit tests
- documentation

API in v2 is available (#5925 - 12/2019, v1.7.0).
API is misleading. It expects `user_id` and returns a list of all users.

Signed-off-by: Dirk Klimpel dirk@klimpel.org
  • Loading branch information
dklimpel committed Apr 9, 2021
1 parent 2ca4e34 commit 48a1f4d
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 27 deletions.
13 changes: 13 additions & 0 deletions UPGRADE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,19 @@ for example:
wget https://packages.matrix.org/debian/pool/main/m/matrix-synapse-py3/matrix-synapse-py3_1.3.0+stretch1_amd64.deb
dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb
Upgrading to v1.32.0
====================

Removal of old List Accounts Admin API
--------------------------------------

The deprecated v1 "list accounts" admin API (``GET /_synapse/admin/v1/users/<user_id>``) has been removed in this version.

The `v2 list accounts API <https://github.com/matrix-org/synapse/blob/master/docs/admin_api/user_admin_api.rst#list-accounts>`_
has been available since Synapse 1.7.0 (2019-12-13), and is accessible under ``GET /_synapse/admin/v2/users``.

The deprecation of the old endpoint was announced with Synapse 1.28.0 (released on 2021-02-25).

Upgrading to v1.29.0
====================

Expand Down
1 change: 1 addition & 0 deletions changelog.d/9401.removal
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Remove old admin API `GET /_synapse/admin/v1/users/<user_id>`.
2 changes: 0 additions & 2 deletions synapse/rest/admin/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@
UserMembershipRestServlet,
UserRegisterServlet,
UserRestServletV2,
UsersRestServlet,
UsersRestServletV2,
UserTokenRestServlet,
WhoisRestServlet,
Expand Down Expand Up @@ -248,7 +247,6 @@ def register_servlets_for_client_rest_resource(hs, http_server):
PurgeHistoryStatusRestServlet(hs).register(http_server)
DeactivateAccountRestServlet(hs).register(http_server)
PurgeHistoryRestServlet(hs).register(http_server)
UsersRestServlet(hs).register(http_server)
ResetPasswordRestServlet(hs).register(http_server)
SearchUsersRestServlet(hs).register(http_server)
ShutdownRoomRestServlet(hs).register(http_server)
Expand Down
23 changes: 0 additions & 23 deletions synapse/rest/admin/users.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,29 +45,6 @@
logger = logging.getLogger(__name__)


class UsersRestServlet(RestServlet):
PATTERNS = admin_patterns("/users/(?P<user_id>[^/]*)$")

def __init__(self, hs: "HomeServer"):
self.hs = hs
self.store = hs.get_datastore()
self.auth = hs.get_auth()
self.admin_handler = hs.get_admin_handler()

async def on_GET(
self, request: SynapseRequest, user_id: str
) -> Tuple[int, List[JsonDict]]:
target_user = UserID.from_string(user_id)
await assert_requester_is_admin(self.auth, request)

if not self.hs.is_mine(target_user):
raise SynapseError(400, "Can only users a local user")

ret = await self.store.get_users()

return 200, ret


class UsersRestServletV2(RestServlet):
PATTERNS = admin_patterns("/users$", "v2")

Expand Down
4 changes: 2 additions & 2 deletions tests/storage/test_client_ips.py
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,7 @@ def test_old_user_ips_pruned(self):
class ClientIpAuthTestCase(unittest.HomeserverTestCase):

servlets = [
synapse.rest.admin.register_servlets_for_client_rest_resource,
synapse.rest.admin.register_servlets,
login.register_servlets,
]

Expand Down Expand Up @@ -434,7 +434,7 @@ def _runtest(self, headers, expected_ip, make_request_args):
self.reactor,
self.site,
"GET",
"/_synapse/admin/v1/users/" + self.user_id,
"/_synapse/admin/v2/users/" + self.user_id,
access_token=access_token,
custom_headers=headers1.items(),
**make_request_args,
Expand Down

0 comments on commit 48a1f4d

Please sign in to comment.