diff options
| author | Jason Robinson <jasonr@element.io> | 2021-10-26 12:01:06 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-10-26 09:01:06 +0000 |
| commit | 63cbdd8af081839f245915a18ed57f1a44f1a5f4 (patch) | |
| tree | 26ee37e15ee168383fb73c25208a429d44bd2306 /docs/admin_api | |
| parent | Fix cyclic import in the module API (#11180) (diff) | |
| download | synapse-63cbdd8af081839f245915a18ed57f1a44f1a5f4.tar.xz | |
Enable changing user type via users admin API (#11174)
Users admin API can now also modify user type in addition to allowing it to be set on user creation. Signed-off-by: Jason Robinson <jasonr@matrix.org> Co-authored-by: Brendan Abolivier <babolivier@matrix.org>
Diffstat (limited to 'docs/admin_api')
| -rw-r--r-- | docs/admin_api/user_admin_api.md | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/admin_api/user_admin_api.md b/docs/admin_api/user_admin_api.md index 534f8400ba..f03539c9f0 100644 --- a/docs/admin_api/user_admin_api.md +++ b/docs/admin_api/user_admin_api.md @@ -50,7 +50,8 @@ It returns a JSON body like the following: "auth_provider": "<provider2>", "external_id": "<user_id_provider_2>" } - ] + ], + "user_type": null } ``` @@ -97,7 +98,8 @@ with a body of: ], "avatar_url": "<avatar_url>", "admin": false, - "deactivated": false + "deactivated": false, + "user_type": null } ``` @@ -135,6 +137,9 @@ Body parameters: unchanged on existing accounts and set to `false` for new accounts. A user cannot be erased by deactivating with this API. For details on deactivating users see [Deactivate Account](#deactivate-account). +- `user_type` - string or null, optional. If provided, the user type will be + adjusted. If `null` given, the user type will be cleared. Other + allowed options are: `bot` and `support`. If the user already exists then optional parameters default to the current value. |