Currently running Discourse 3.5.0.beta5-dev (eff31e0d42). Would anyone know if the API response from the /admin/users/list/all.json endpoint has changed in the last week or so? :thinking: Specifically: GET /admin/users/list/all.json?email=email@example.com :thinking: I think this endpoint used to return a flat JSON object directly representing a single user when queried with an exact email address. However, the current response structure now appears to wrap the user object inside a new users array, which has broken a few existing SSO integrations at our end. Here is an anonymised pseudo example of the response of what I think has changed “before” and “after” for reference. Old: { "id": 1, "username": "sampleuser", "name": "", "avatar_template": "/user_avatar/example.com/sampleuser/{size}/avatar.png", "active": true, "admin": false, "moderator": false, "last_seen_at": "2025-05-11T08:27:28.578Z", "created_at": "2020-01-01T12:00:00.000Z", "suspended": false, "trust_level": 1 } New: { "users": [ { "id": 1, "username": "sampleuser", "name": "", "avatar_template": "/user_avatar/example.com/sampleuser/{size}/avatar.png", "email": "someone@example.com", "active": true, "admin": false, "moderator": false, "last_seen_at": "2025-05-11T09:34:35.900Z", "created_at": "2020-01-01T12:00:00.000Z", "suspended": false, "trust_level": 1 } ], "meta": { "message_bus_last_ids": { "bulk_delete": 0 } } } Would anyone know of a recent commit that may have caused this change? :thinking:

Hi, yes sorry this shouldn’t have been merged, it was my mistake. But the good news is that I already reverted it 8 hours ago: DEV: revert admin users list change (#32723) · discourse/discourse@7558e2c · GitHub

Nooooo way… :scream: Well, that’s what I learnt today! Thanks @RGJ :clap:t2::star_struck:

I managed to find that commit somehow, but couldn’t (and still don’t) see where it changed the data structure (I was on my phone, making things a bit more difficult).

I’m guessing this was the breaking change in the API response :confused: In /app/assets/javascripts/admin/addon/controllers/admin-users-list-show.js [Screenshot 2025-05-11 at 15.36.17]

[image] pfaffman: where it changed the data structure It’s the line root: :users that was added.

We’ve now recovered from the impact of this change. Perhaps going a bit off topic here but is there a way I can track these types of updates so I can notify myself when an API response changes from “X”, after being “Y” for so many years? :thinking: Some kind of scripted local unit tests that I could run on a daily basis perhaps? Although now I’ve said that out loud, that wouldn’t notify me until after I’d updated my Discourse and it had broken the integrations. A staging environment I guess…

You could have a staging environment. You might also create a github action for your code that starts discourse and runs a test against the latest discourse each day.

[image] pfaffman: runs a test against the latest discourse each day Ah-ha! Perfect, that’d work, thanks :grin:

I think a plugin that called the endpoint and rendered it could be an easy way to test. And then change the default github action to run daily instead of only on push.

Seems the documentation needs an update as well https://docs.discourse.org/#tag/Admin/operation/adminListUsers In an ideal world, the documentation would be auto generated from the source and we could just look at the commit history for the documentation, which would only contain the changes in the interface.

[image] RGJ: Seems the documentation needs an update as well This is what caught me out too when trying to resolve the issues caused by this change :confused:

Changes to /admin/users/list/all.json API response structure?

Development

Richie (Richie Rich) May 11, 2025, 9:51pm 15

This is what caught me out too when trying to resolve the issues caused by this change

Topic		Replies	Views
Cases when admin/users.json?email=foobar or admin/users/list/all.json?email=foobar return empty array Development rest-api , user-api	5	399	April 29, 2025
Issues with the /get-users ending point Development rest-api	4	233	July 16, 2024
How do I get a list of all users from the API? Development rest-api	18	11433	December 24, 2021
Creating users through RESTFUL Users API - Users.json got wiped Development rest-api	4	1817	February 28, 2019
Group API, empty response Development rest-api	6	1003	November 9, 2020

Changes to /admin/users/list/all.json API response structure?

Related topics