Feature request: proper MSC3823 support in Admin API

[aine-etke]

Description:

Hello,

I'm working on etkecc/synapse-admin#195 to support the MSC3823 feature in Synapse Admin, and currently (at the moment of writing using the develop Synapse docker tag) the following things are missing:

• Support suspended as one of the List Accounts params and response keys
• Support suspended as one of the Query User Account response keys Done
• Support suspended as one of the Create or Modify Account body params

MSC3823 is already considered stable, but it's almost unusable in Admin API without those changes.

Thank you in advance!

PS: initially the clarifications were asked in #17255 (comment)

[aine-etke]

cc @element-hq/trust-safety

[anoadragon453]

We found out from this comment that a suspended field is already returned by the Query User Account Admin API (only visible in the develop version of the docs currently).

@aine-etke from your issue description, do I understand correctly that you'd still like a suspended field to be added to the List Accounts and Create or Modify Account Admin APIs?

It turns out that there's a currently-undocumented Admin API for suspending accounts. Though now I'm thinking that it indeed makes more sense to just fold this into Create or Modify account...

[aine-etke]

do I understand correctly that you'd still like a suspended field to be added to the List Accounts and Create or Modify Account Admin APIs?

Correct. I'd expect it to be the same way as locked and/or deactivated

It turns out that there's a currently-undocumented Admin API for suspending accounts. Though now I'm thinking that it indeed makes more sense to just fold this into Create or Modify account...

Correct. Again, I'd expect this new feature to use the same pattern as locked and/or deactivated, i.e., presented in the List Accounts, Query User Account endpoints, plus could be set/unset using the Create or Modify Account endpoint

[anoadragon453]

@aine-etke would you be upset if that undocumented suspend API went away? 😛

(replaced with the appropriate fields in the other APIs, of course.)

[aine-etke]

@anoadragon453 not really 😁
in case of Synapse Admin this is yet-another user status flag, so having a special endpoint to control this specific status is incohesive with other flags, and will require special treatment to be implemented

[turt2live]

would you be upset if that undocumented suspend API went away? 😛

Matrix.org's Trust & Safety team would be mildly upset if it disappeared. The intention is to document it rather than remove it.

edit: probably more than mildly, actually. We use the API.

[anoadragon453]

@turt2live I was curious whether it was in use by anyone. Thanks for letting us know!