summary refs log tree commit diff
path: root/docs/admin_api (follow)
Commit message (Collapse)AuthorAgeFilesLines
* Merge branch 'develop' into jaywink/admin-forward-extremitiesJason Robinson2021-01-261-0/+30
|\ | | | | | | | | # Conflicts: # synapse/rest/admin/__init__.py
| * Add an admin API for shadow-banning users. (#9209)Patrick Cloke2021-01-251-0/+30
| | | | | | | | | | | | | | | | | | | | This expands the current shadow-banning feature to be usable via the admin API and adds documentation for it. A shadow-banned users receives successful responses to their client-server API requests, but the events are not propagated into rooms. Shadow-banning a user should be used as a tool of last resort and may lead to confusing or broken behaviour for the client.
* | Merge branch 'develop' into jaywink/admin-forward-extremitiesJason Robinson2021-01-232-0/+49
|\|
| * Add an admin API endpoint to protect media. (#9086)Patrick Cloke2021-01-151-0/+24
| | | | | | | | | | | | Protecting media stops it from being quarantined when e.g. all media in a room is quarantined. This is useful for sticker packs and other media that is uploaded by server administrators, but used by many people.
| * Remove user's avatar URL and displayname when deactivated. (#8932)Dirk Klimpel2021-01-121-0/+21
| | | | | | This only applies if the user's data is to be erased.
| * Also support remote users on the joined_rooms admin API. (#8948)David Teller2021-01-111-0/+4
| | | | | | | | For remote users, only the rooms which the server knows about are returned. Local users have all of their joined rooms returned.
* | Add depth and received_ts to forward_extremities admin API responseJason Robinson2021-01-231-1/+7
| | | | | | | | | | | | Also add a warning on the admin API documentation. Signed-off-by: Jason Robinson <jasonr@matrix.org>
* | Address pr feedbackJason Robinson2021-01-111-9/+3
| | | | | | | | | | | | | | | | | | | | * docs updates * prettify SQL * add missing copyright * cursor_to_dict * update touched files copyright years Signed-off-by: Jason Robinson <jasonr@matrix.org>
* | Clarify rooms.mdJason Robinson2021-01-111-1/+1
| | | | | | Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
* | Add changelog and admin API docsJason Robinson2021-01-091-0/+53
|/ | | | Signed-off-by: Jason Robinson <jasonr@matrix.org>
* Allow server admin to get admin bit in rooms where local user is an admin ↵Erik Johnston2020-12-181-1/+19
| | | | | | | (#8756) This adds an admin API that allows a server admin to get power in a room if a local user has power in a room. Will also invite the user if they're not in the room and its a private room. Can specify another user (rather than the admin user) to be granted power. Co-authored-by: Matthew Hodgson <matthew@matrix.org>
* Make search statement in List Room and User Admin API case-insensitive (#8931)Dirk Klimpel2020-12-171-3/+6
|
* Add number of local devices to Room Details Admin API (#8886)Dirk Klimpel2020-12-111-11/+13
|
* Deprecate Shutdown Room and Purge Room Admin API (#8829)Dirk Klimpel2020-12-103-9/+47
| | | | | Deprecate both APIs in favour of the Delete Room API. Related: #8663 and #8810
* Combine related media admin API docs (#8839)Dirk Klimpel2020-12-092-50/+86
| | | | | | Related: #8810 Also a few small improvements. Signed-off-by: Dirk Klimpel dirk@klimpel.org
* Add `force_purge` option to delete-room admin api. (#8843)Richard van der Hoff2020-11-301-1/+5
|
* Remove deprecated `/_matrix/client/*/admin` endpoints (#8785)Dirk Klimpel2020-11-251-0/+7
| | | These are now only available via `/_synapse/admin/v1`.
* Clarify documentation of the admin list media API (#8795)Dirk Klimpel2020-11-241-0/+1
| | | Clarify that the list media API only shows media from unencrypted events.
* a comma too much (#8771)chagai952020-11-171-1/+1
| | | Signed-off-by: Chagai Friedlander chagai95@gmail.com
* Add admin API for logging in as a user (#8617)Erik Johnston2020-11-171-0/+35
|
* Migrate documentation `docs/admin_api/event_reports` to markdown (#8742)Dirk Klimpel2020-11-132-165/+172
| | | Related to #8714. `event_reports.rst` was introduced in Synapse 1.21.0.
* Add an admin API for users' media statistics (#8700)Dirk Klimpel2020-11-051-0/+83
| | | | | | | | Add `GET /_synapse/admin/v1/statistics/users/media` to get statisics about local media usage by users. Related to #6094 It is the first API for statistics. Goal is to avoid/reduce usage of sql queries like [Wiki analyzing Synapse](https://github.com/matrix-org/synapse/wiki/SQL-for-analyzing-Synapse-PostgreSQL-database-stats) Signed-off-by: Dirk Klimpel dirk@klimpel.org
* Add `displayname` to Shared-Secret Registration for admins (#8722)Dirk Klimpel2020-11-051-1/+3
| | | Add `displayname` to Shared-Secret Registration for admins to `POST /_synapse/admin/v1/register`
* Remove the "draft" status of the Room Details Admin API (#8702)Dirk Klimpel2020-11-031-3/+1
| | | Fixes #8550
* Add an admin APIs to allow server admins to list users' pushers (#8610)Dirk Klimpel2020-10-281-0/+79
| | | Add an admin API `GET /_synapse/admin/v1/users/<user_id>/pushers` like https://matrix.org/docs/spec/client_server/latest#get-matrix-client-r0-pushers
* Add admin API to list users' local media (#8647)Dirk Klimpel2020-10-271-0/+83
| | | Add admin API `GET /_synapse/admin/v1/users/<user_id>/media` to get information of users' uploaded files.
* Split admin API for reported events into a detail and a list view (#8539)Dirk Klimpel2020-10-261-54/+90
| | | | | | | | | | | | Split admin API for reported events in detail und list view. API was introduced with #8217 in synapse v.1.21.0. It makes the list (`GET /_synapse/admin/v1/event_reports`) less complex and provides a better overview. The details can be queried with: `GET /_synapse/admin/v1/event_reports/<report_id>`. It is similar to room and users API. It is a kind of regression in `GET /_synapse/admin/v1/event_reports`. `event_json` was removed. But the api was introduced one version before and it is an admin API (not under spec). Signed-off-by: Dirk Klimpel dirk@klimpel.org
* Add an admin api to delete local media. (#8519)Dirk Klimpel2020-10-261-0/+79
| | | | | | Related to: #6459, #3479 Add `DELETE /_synapse/admin/v1/media/<server_name>/<media_id>` to delete a single file from server.
* Add field `total` to device list in admin API (#8644)Dirk Klimpel2020-10-261-1/+4
|
* Admin API for reported events (#8217)Dirk Klimpel2020-09-221-0/+129
| | | Add an admin API to read entries of table `event_reports`. API: `GET /_synapse/admin/v1/event_reports`
* Admin API for querying rooms where a user is a member (#8306)Dirk Klimpel2020-09-181-0/+37
| | | | Add a new admin API `GET /_synapse/admin/v1/users/<user_id>/joined_rooms` to list all rooms where a user is a member.
* Add the topic and avatar to the room details admin API (#8305)Tulir Asokan2020-09-141-0/+4
|
* Explain better what GDPR-erased means (#8189)Brendan Abolivier2020-09-011-3/+5
| | | Fixes https://github.com/matrix-org/synapse/issues/8185
* Wording fixes to 'name' user admin api filter (#8163)Andrew Morgan2020-08-251-3/+4
| | | Some fixes to wording I noticed after merging #7377.
* Fix missing double-backtick in RST documentAndrew Morgan2020-08-251-1/+1
|
* Search in columns 'name' and 'displayname' in the admin users endpoint (#7377)Manuel Stahl2020-08-251-2/+4
| | | | | * Search in columns 'name' and 'displayname' in the admin users endpoint Signed-off-by: Manuel Stahl <manuel.stahl@awesome-technologies.de>
* Clarify that undoing a shutdown might not be possible (#8010)Travis Ralston2020-08-071-3/+10
|
* Add docs for undoing room shutdowns (#7998)Travis Ralston2020-07-311-1/+21
| | | These docs were tested successfully in production by a customer, so it's probably fine.
* Add an option to disable purge in delete room admin API (#7964)Dirk Klimpel2020-07-281-4/+9
| | | | | | Add option ```purge``` to ```POST /_synapse/admin/v1/rooms/<room_id>/delete``` Fixes: #3761 Signed-off-by: Dirk Klimpel dirk@klimpel.org
* Add admin endpoint to get members in a room. (#7842)Michael Albert2020-07-161-1/+33
|
* Allow accounts to be re-activated from the admin APIs. (#7847)Patrick Cloke2020-07-151-1/+5
|
* Add delete room admin endpoint (#7613)Dirk Klimpel2020-07-143-0/+98
| | | | | | | | | | | | | | | | | | The Delete Room admin API allows server admins to remove rooms from server and block these rooms. `DELETE /_synapse/admin/v1/rooms/<room_id>` It is a combination and improvement of "[Shutdown room](https://github.com/matrix-org/synapse/blob/develop/docs/admin_api/shutdown_room.md)" and "[Purge room](https://github.com/matrix-org/synapse/blob/develop/docs/admin_api/purge_room.md)" API. Fixes: #6425 It also fixes a bug in [synapse/storage/data_stores/main/room.py](synapse/storage/data_stores/main/room.py) in ` get_room_with_stats`. It should return `None` if the room is unknown. But it returns an `IndexError`. https://github.com/matrix-org/synapse/blob/901b1fa561e3cc661d78aa96d59802cf2078cb0d/synapse/storage/data_stores/main/room.py#L99-L105 Related to: - #5575 - https://github.com/Awesome-Technologies/synapse-admin/issues/17 Signed-off-by: Dirk Klimpel dirk@klimpel.org
* Clarifications to the admin api documentation (#7647)Richard van der Hoff2020-06-057-89/+125
| | | | | | * Clarify how to authenticate * path params are not the same thing as query params * Fix documentation for `/_synapse/admin/v2/users/<user_id>`
* Add device management to admin API (#7481)Dirk Klimpel2020-06-051-0/+209
| | | | | | | | | | - Admin is able to - change displaynames - delete devices - list devices - get device informations Fixes #7330
* Improve API doc readability (#7527)Paul Tötterman2020-05-191-10/+11
|
* Add room details admin endpoint (#7317)Manuel Stahl2020-05-071-0/+54
|
* Clean up admin api docs (#7361)Andrew Morgan2020-04-281-18/+42
|
* Return total number of users and profile attributes in admin users endpoint ↵Manuel Stahl2020-04-281-3/+8
| | | | | (#6881) Signed-off-by: Manuel Stahl <manuel.stahl@awesome-technologies.de>
* Extend room admin api with additional attributes (#7225)Dirk Klimpel2020-04-221-7/+100
|
* Admin API to join users to a room. (#7051)Dirk Klimpel2020-03-271-0/+34
|
* Add an option to the set password API to choose whether to logout other ↵Patrick Cloke2020-03-181-1/+5
| | | | devices. (#7085)
* Merge pull request #6891 from matrix-org/babolivier/retention-doc-amendBrendan Abolivier2020-02-121-0/+3
|\ | | | | Spell out that the last event sent to a room won't be deleted by a purge
| * RephraseBrendan Abolivier2020-02-121-2/+2
| |
| * Also spell it out in the purge history API docBrendan Abolivier2020-02-111-0/+3
| |
* | Merge branch 'master' into developBrendan Abolivier2020-02-121-1/+2
|\ \ | |/ |/|
| * Update documentation (#6859)Robin Vleij2020-02-051-1/+2
| | | | | | | | Update documentation to reflect the correct format of user_id (fully qualified).
* | Admin api to add an email address (#6789)Dirk Klimpel2020-02-071-0/+11
|/
* Update admin room docs with correct endpoints (#6770)Andrew Morgan2020-01-231-4/+4
|
* Admin API to list, filter and sort rooms (#6720)Andrew Morgan2020-01-221-0/+173
|
* Quarantine media by ID or user ID (#6681)Andrew Morgan2020-01-131-7/+69
|
* Allow admin users to create or modify users without a shared secret (#6495)Manuel Stahl2020-01-091-1/+32
| | | Signed-off-by: Manuel Stahl <manuel.stahl@awesome-technologies.de>
* Document Shutdown Room admin API (#6541)Andrew Morgan2019-12-131-0/+72
|
* Replace /admin/v1/users_paginate endpoint with /admin/v2/users (#5925)Manuel Stahl2019-12-051-0/+45
|
* write some docs for the quarantine_media api (#6458)Richard van der Hoff2019-12-031-0/+17
|
* Merge branch 'master' into developBrendan Abolivier2019-10-021-0/+12
|\
| * add explanations on how to actually include an access_token (#6031)axel simon2019-09-131-0/+12
| |
* | Document GET method for retrieving admin bit of user in admin APIOlivier Wilkinson (reivilibre)2019-08-271-0/+19
| | | | | | | | Signed-off-by: Olivier Wilkinson (reivilibre) <olivier@librepush.net>
* | Add Admin API capability to set adminship of a user (#5878)reivilibre2019-08-271-0/+20
| | | | | | Admin API: Set adminship of a user
* | Servlet to purge old rooms (#5845)Richard van der Hoff2019-08-221-0/+18
|/
* Clarify that the admin change password endpoint logs them out (#5303)Travis Ralston2019-05-311-1/+1
|
* Remove the requirement to authenticate for /admin/server_version. (#5122)Richard van der Hoff2019-05-071-2/+0
| | | | | | | | | This endpoint isn't much use for its intended purpose if you first need to get yourself an admin's auth token. I've restricted it to the `/_synapse/admin` path to make it a bit easier to lock down for those concerned about exposing this information. I don't imagine anyone is using it in anger currently.
* Fix spelling in server notices admin API docs (#5142)Travis Ralston2019-05-061-1/+1
|
* Add admin api for sending server_notices (#5121)Richard van der Hoff2019-05-021-0/+48
|
* Move admin API to a new prefixRichard van der Hoff2019-05-018-12/+12
|
* Fix whole path for admin routeBrendan Abolivier2019-05-011-1/+1
|
* Fix typo in account validity admin routeBrendan Abolivier2019-05-011-1/+1
|
* Merge branch 'develop' of github.com:matrix-org/synapse into ↵Erik Johnston2019-04-171-0/+14
|\ | | | | | | babolivier/account_expiration
| * Add admin API for group deletionErik Johnston2019-04-031-0/+14
| |
* | Add management endpoints for account validityBrendan Abolivier2019-04-171-0/+42
|/
* add API documentationJoseph Weston2019-03-021-0/+22
| | | | Signed-off-by: Joseph Weston <joseph@weston.cloud>
* create support user (#4141)Neil Johnson2018-12-141-4/+7
| | | | | | Allow for the creation of a support user. A support user can access the server, join rooms, interact with other users, but does not appear in the user directory nor does it contribute to monthly active user limits.
* Add a note saying you need to manually reclaim disk spaceAaron Raimist2018-11-181-0/+8
| | | | | | People keep asking why their database hasn't gotten smaller after using this API. Signed-off-by: Aaron Raimist <aaron@raim.ist>
* Update the admin register documentation to return a real user IDTravis Ralston2018-08-171-1/+1
| | | Presumably this is the intention anyways. I've also updated the domain part to be something more along the lines of what people might expect.
* Admin API for creating new users (#3415)Amber Brown2018-07-201-0/+63
|
* update doc for deactivate APIMatthew Hodgson2018-06-261-2/+15
|
* Update purge_history_api.rstRichard van der Hoff2018-03-151-2/+4
| | | clarify that `purge_history` will not purge state
* Add transactional API to history purgeRichard van der Hoff2018-03-121-0/+27
| | | | Make the purge request return quickly, and allow scripts to poll for updates.
* Provide a means to pass a timestamp to purge_historyRichard van der Hoff2018-03-051-2/+9
|
* Fix typos in purge api & docRichard van der Hoff2018-02-131-1/+1
| | | | | * It's supposed to be purge_local_events, not ..._history * Fix the doc to have valid json
* Merge pull request #2858 from matrix-org/rav/purge_updatesRichard van der Hoff2018-02-091-2/+12
|\ | | | | delete_local_events for purge_room_history
| * delete_local_events for purge_historyRichard van der Hoff2018-02-091-2/+12
| | | | | | | | Add a flag which makes the purger delete local events
* | Add admin api documentation for list media endpointTravis Ralston2018-01-311-0/+23
|/ | | Signed-off-by: Travis Ralston <travpc@gmail.com>
* make it absolutely clear that Purge History API does not remove all traces ↵Ander Punnar2017-10-141-0/+2
| | | | | | | of events and message contents because this topic pops up too often #890 #1621 #1730 #2260 #2315 and so on
* Document some of the admin APIs (#2143)Richard van der Hoff2017-04-211-0/+73
| | | | | | I haven't (yet) documented all of the user-list APIs introduced in https://github.com/matrix-org/synapse/pull/1784 because the API shape seems very odd, given the functionality.
* fix doc for purge_media_cacheRichard van der Hoff2017-01-201-5/+3
| | | | | purge_media_cache takes its arg from a query-param, not the POST body, for some reason.
* Use correct pathErik Johnston2016-07-281-1/+1
|
* Add some basic admin API docsErik Johnston2016-07-283-0/+46
generated by cgit-pink 1.4.1 (git 2.36.1) at 2024-11-20 06:20:01 +0000