summary refs log tree commit diff
path: root/docs/admin_api (follow)
Commit message (Collapse)AuthorAgeFilesLines
* Filter added to Admin-API GET /rooms (#17276)Alexander Fechler2024-06-191-0/+4
|
* Add note about external_ids for User Admin API in documentation (#17139)Jacob Sánchez2024-05-071-2/+2
|
* Fix various typos in docs (#17114)devonh2024-04-261-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | ### Pull Request Checklist <!-- Please read https://element-hq.github.io/synapse/latest/development/contributing_guide.html before submitting your pull request --> * [X] Pull request is based on the develop branch * [X] Pull request includes a [changelog file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog). The entry should: - Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from `EventStore` to `EventWorkerStore`.". - Use markdown where necessary, mostly for `code blocks`. - End with either a period (.) or an exclamation mark (!). - Start with a capital letter. - Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry. * [X] [Code style](https://element-hq.github.io/synapse/latest/code_style.html) is correct (run the [linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters))
* deactivated flag refactored to filter deactivated users. (#16874)Alexander Fechler2024-03-111-0/+14
| | | | Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
* fix typo in admin_api/rooms.md (#16857)Rainer Zufall2024-02-201-1/+1
| | | | Co-authored-by: Andrew Morgan <andrew@amorgan.xyz>
* Enable user without password (#16770)Dirk Klimpel2024-01-021-9/+10
| | | | | | | | | | | Closes: - https://github.com/matrix-org/synapse/issues/10397 - #10397 An administrator should know whether he wants to set a password or not. There are many uses cases where a blank password is required. - Use of only some users with SSO. - Use of bots with password, users with SSO
* Update book locationErik Johnston2023-12-131-2/+1
|
* Update admin user API return types in docs. (#16654)Michael Weimann2023-11-171-4/+15
|
* Add an Admin API to temporarily grant the ability to update an existing ↵David Robertson2023-11-151-0/+37
| | | | cross-signing key without UIA (#16634)
* Improve documentation for ↵Will Hunt2023-11-141-1/+2
| | | | `/_synapse/admin/v1/rooms/<room_id>/timestamp_to_event` (#16631)
* Remove Python version from `/_synapse/admin/v1/server_version` (#16380)MomentQYC2023-10-021-4/+6
| | | | There's no reason to expose the full Python version over what is frequently a public API.
* Fix-up deactivated notes in docs. (#16355)Patrick Cloke2023-09-191-1/+1
|
* Filter locked users in the admin API (#16328)Hanadi2023-09-181-5/+12
| | | | Co-authored-by: Hanadi Tamimi <hanadi.tamimi@sdui.de>
* Add last_seen_ts to the admin users API (#16218)Mathieu Velten2023-09-041-0/+2
|
* Add warnings about MSC3861 on certain APIs. (#16168)Will Hunt2023-08-253-1/+13
|
* Allow filtering for admins in the list accounts admin API (#16114)Alexander Fechler2023-08-181-0/+2
|
* Implements admin API to lock an user (MSC3939) (#15870)Mathieu Velten2023-08-101-0/+1
|
* Document that you cannot login as yourself on ↵Will Hunt2023-07-141-1/+2
| | | | /_synapse/admin/v1/users/<user_id>/login (#15938)
* docs/admin_api: fix header level on 'Users' page (#15852)Sumner Evans2023-07-051-3/+3
| | | Signed-off-by: Sumner Evans <sumner@beeper.com>
* Add not_user_type param to the list accounts admin API (#15844)Michael Weimann2023-07-041-0/+3
| | | Signed-off-by: Michael Weimann <michaelw@element.io>
* Fix admin api documentation typo (#15805)ew-at-vier2023-06-201-1/+1
| | | | | * Fix admin api documentation typo Signed-off-by: Eric Wolf <eric.wolf@vier.ai>
* Add a new admin API to create a new device for a user. (#15611)Quentin Gliech2023-05-171-0/+27
| | | | This allows an external service (e.g. the matrix-authentication-service) to create devices for users.
* Fix documented path to largest rooms statistics endpoint. (#15560)Reto Schneider2023-05-101-1/+1
|
* Clean up and clarify "Create or modify Account" Admin API documentation (#15544)Andrew Morgan2023-05-051-38/+49
|
* Remove references to supporting per-user flag for msc2654 (#15522)Shay2023-05-021-6/+7
|
* Add an admin API endpoint to support per-user feature flags (#15344)Shay2023-04-281-0/+54
|
* Add admin endpoint to query room sizes (#15482)Erik Johnston2023-04-261-0/+49
|
* Admin API endpoint to delete a reported event (#15116)Dirk Klimpel2023-02-281-0/+14
| | | | | | | | | | | | | | | | | | | | | * Admin api to delete event report * lint + tests * newsfile * Apply suggestions from code review Co-authored-by: David Robertson <david.m.robertson1@gmail.com> * revert changes - move to WorkerStore * update unit test * Note that timestamp is in millseconds --------- Co-authored-by: David Robertson <david.m.robertson1@gmail.com>
* Respond correctly to unknown methods on known endpoints (#14605)Patrick Cloke2023-02-091-1/+9
| | | | Respond with a 405 error if a request is received on a known endpoint, but to an unknown method, per MSC3743.
* Fix broken links in the Synapse documentation. (#14744)reivilibre2023-01-058-9/+9
| | | | | | | | | | | | | | | | | * Fix stale external links * Fix some internal links * Fix URLs without trailing / where needed * Fix more links * Newsfile Signed-off-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org> * Reapply docs/openid.md fix after conflict Signed-off-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org>
* Add an Admin API endpoint for looking up users based on 3PID (#14405)Ashish Kumar2022-11-111-0/+39
|
* Show erasure status when listing users in the Admin API (#14205)Tadeusz Sośnierz2022-10-211-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Show erasure status when listing users in the Admin API * Use USING when joining erased_users * Add changelog entry * Revert "Use USING when joining erased_users" This reverts commit 30bd2bf106415caadcfdbdd1b234ef2b106cc394. * Make the erased check work on postgres * Add a testcase for showing erased user status * Appease the style linter * Explicitly convert `erased` to bool to make SQLite consistent with Postgres This also adds us an easy way in to fix the other accidentally integered columns. * Move erasure status test to UsersListTestCase * Include user erased status when fetching user info via the admin API * Document the erase status in user_admin_api * Appease the linter and mypy * Signpost comments in tests Co-authored-by: Tadeusz Sośnierz <tadeusz@sosnierz.com> Co-authored-by: David Robertson <david.m.robertson1@gmail.com>
* Fix the cross-link from register admin API to config docs. (#13870)Patrick Cloke2022-09-221-1/+1
|
* Add an admin API endpoint to find a user based on its external ID in an auth ↵Quentin Gliech2022-09-161-0/+38
| | | | provider. (#13810)
* Add timestamp to user's consent (#13741)Dirk Klimpel2022-09-081-0/+2
| | | Co-authored-by: reivilibre <olivier@librepush.net>
* Add Admin API to Fetch Messages Within a Particular Window (#13672)Connor Davis2022-09-071-0/+145
| | | This adds two new admin APIs that allow us to fetch messages from a room within a particular time.
* Improve documentation around user registration (#13640)Richard van der Hoff2022-08-261-3/+3
| | | | | Update a bunch of the documentation for user registration, add some cross links, etc.
* Describe changes to admin API in 1.66David Robertson2022-08-231-0/+2
| | | | Cross-ref #13525
* Implement MSC3852: Expose `last_seen_user_agent` to users for their own ↵Andrew Morgan2022-08-191-0/+7
| | | | devices; also expose to Admin API (#13549)
* Add forgotten status to Room Details API (#13503)Dirk Klimpel2022-08-171-1/+4
|
* Add `openssl` example for registration HMAC (#13472)James Barton2022-08-111-2/+19
| | | Signed-off-by: James Barton <james@neodon.com>
* Inline URL preview documentation. (#13261)Patrick Cloke2022-07-121-1/+1
| | | Inline URL preview documentation near the implementation.
* expose whether a room is a space in the Admin API (#13208)andrew do2022-07-121-8/+21
|
* Cleanup references to sample config in the docs and redirect users to ↵Shay2022-06-301-3/+2
| | | | configuration manual (#13077)
* Remove docs for Delete Group Admin API (#13112)Aaron Raimist2022-06-271-14/+0
| | | | | | This API no longer exists. Signed-off-by: Aaron Raimist <aaron@raim.ist>
* Allow updating passwords using the admin api without logging out devices ↵Jan Christian Grünhage2022-06-061-1/+3
| | | | (#12952)
* Fix reference to the wrong symbol in the media admin api docs (#12715)Andrew Morgan2022-05-121-1/+1
|
* Correct typo in user_admin_api.md device deletion JSON (#12533)Sami Olmari2022-04-251-1/+1
| | | | Signed-off-by: Sami Olmari <sami@olmari.fi>
* Document why auth providers aren't validated in the admin API. (#12004)Patrick Cloke2022-02-181-1/+2
| | | | Since it is reasonable to give a future or past auth provider, which might not be in the current configuration.
* Clarify that users' media are also preview images (#11862)Dirk Klimpel2022-02-042-1/+11
|
* Fix typo: unpind -> unbind (#11859)Christian Paul2022-02-031-1/+1
| | | Co-authored-by: reivilibre <olivier@librepush.net>
* Consolidate the `access_token` information in the admin api (#11861)Dirk Klimpel2022-01-319-95/+29
| | | Co-authored-by: reivilibre <olivier@librepush.net>
* Remove not needed old table of contents in documentation (#11860)Dirk Klimpel2022-01-312-32/+0
|
* Remove account data (including client config, push rules and ignored users) ↵reivilibre2022-01-241-1/+5
| | | | | upon user deactivation. (#11621) Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
* Drop support for and remove references to EOL Python 3.6 (#11683)Shay2022-01-211-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * remove reference in comments to python3.6 * upgrade tox python env in script * bump python version in example for completeness * upgrade python version requirement in setup doc * upgrade necessary python version in __init__.py * upgrade python version in setup.py * newsfragment * drops refs to bionic and replace with focal * bump refs to postgres 9.6 to 10 * fix hanging ci * try installing tzdata first * revert change made in b979f336 * ignore new random mypy error while debugging other error * fix lint error for temporary workaround * revert change to install list * try passing env var * export debian frontend var? * move line and add comment * bump pillow dependency * bump lxml depenency * install libjpeg-dev for pillow * bump automat version to one compatible with py3.8 * add libwebp for pillow * bump twisted trunk python version * change suffix of newsfragment * remove redundant python 3.7 checks * lint
* Remove the 'password_hash' from the Users Admin API endpoint response ↵Andrew Morgan2022-01-141-4/+5
| | | | dictionary (#11576)
* Add admin API to get users' account data (#11664)Dirk Klimpel2022-01-051-0/+75
| | | Co-authored-by: reivilibre <olivier@librepush.net>
* Add dedicated admin API for blocking a room (#11324)Dirk Klimpel2021-11-181-0/+78
|
* Add ability to un-shadow-ban via the admin API. (#11347)Patrick Cloke2021-11-161-3/+9
|
* Convert delete room admin API to async endpoint (#11223)Dirk Klimpel2021-11-122-16/+175
| | | Signed-off-by: Dirk Klimpel dirk@klimpel.org
* Fix typos in the `username_available` admin API documentation. (#11286)Stanislav Motylkov2021-11-091-1/+1
|
* Allow admins to proactively block rooms (#11228)David Robertson2021-11-091-5/+11
| | | | Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
* fix a small typo in the delete room api docsAndrew Morgan2021-11-031-1/+1
|
* Add search by room ID and room alias to List Room admin API (#11099)Dirk Klimpel2021-11-021-3/+8
| | | | Fixes: #10874 Signed-off-by: Dirk Klimpel dirk@klimpel.org
* Remove deprecated delete room admin API (#11213)Dirk Klimpel2021-11-011-10/+0
| | | | | Remove deprecated delete room admin API, `POST /_synapse/admin/v1/rooms/<room_id>/delete`
* Improve code formatting and fix a few typos in docs (#11221)Sumner Evans2021-11-014-8/+8
| | | | | | * Labeled a lot more code blocks with the appropriate type * Fixed a couple of minor typos (missing/extraneous commas) Signed-off-by: Sumner Evans <me@sumnerevans.com>
* Enable changing user type via users admin API (#11174)Jason Robinson2021-10-261-2/+7
| | | | | | | | 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>
* Add more information what happens when a user is deactivated (#11083)Dirk Klimpel2021-10-221-0/+10
|
* Show error when timestamp in seconds is provided to the /purge_media_cache ↵Aaron R2021-10-201-3/+3
| | | | API (#11101)
* Doc: Clarifying undoing room shutdowns (#10480)David Teller2021-09-061-15/+27
|
* Remove not needed database updates in modify user admin API (#10627)Dirk Klimpel2021-08-191-2/+6
|
* Remove deprecated Shutdown Room and Purge Room Admin API (#8830)Dirk Klimpel2021-08-172-123/+0
|
* Allow to edit `external_ids` by Edit User admin API (#10598)Dirk Klimpel2021-08-171-11/+29
| | | Signed-off-by: Dirk Klimpel dirk@klimpel.org
* Add an admin API to check if a username is available (#10578)Will Hunt2021-08-171-0/+20
| | | This adds a new API GET /_synapse/admin/v1/username_available?username=foo to check if a username is available. It is the counterpart to https://matrix.org/docs/spec/client_server/r0.6.0#get-matrix-client-r0-register-available, except that it works even if registration is disabled.
* Admin API to delete media for a specific user (#10558)Dirk Klimpel2021-08-112-6/+57
|
* Add `creation_ts` to list users admin API (#10448)Dirk Klimpel2021-07-221-3/+7
| | | Signed-off-by: Dirk Klimpel dirk@klimpel.org
* Docs: Use something other than the document name to describe a page (#10399)Andrew Morgan2021-07-151-1/+1
| | | | | Our documentation has a history of using a document's name as a way to link to it, such as "See [workers.md]() for details". This makes sense when you're traversing a directory of files, but less sense when the files are abstracted away - as they are on the documentation website. This PR changes the links to various documentation pages to something that fits better into the surrounding sentence, as you would when making any hyperlink on the web.
* Fix a broken link in the admin api docs (#10322)Richard van der Hoff2021-07-071-2/+2
| | | | | | | * Fix a broken link in the admin api docs * Rename 10321.doc to 10321.docs * Rename 10321.docs to 10322.doc
* Simplify structure of room admin API docs (#10313)Dirk Klimpel2021-07-071-45/+24
|
* Add SSO `external_ids` to Query User Account admin API (#10261)Dirk Klimpel2021-07-011-1/+11
| | | Related to #10251
* Fix broken links in documentation (#10180)Dirk Klimpel2021-06-169-31/+31
| | | | | * Fix broken links in documentation * newsfile
* Compile and render Synapse's docs into a browsable, mobile-friendly and ↵Andrew Morgan2021-06-039-51/+37
| | | | searchable website (#10086)
* Convert admin api docs to markdown (#10089)Andrew Morgan2021-06-038-1132/+1159
| | | So that they render nicely in mdbook (see #10086), and so that we no longer have a mix of structured text languages in our documentation (excluding files outside of `docs/`).
* Add new admin APIs to remove media by media ID from quarantine. (#10044)Dirk Klimpel2021-06-021-0/+22
| | | | | Related to: #6681, #5956, #10040 Signed-off-by: Dirk Klimpel dirk@klimpel.org
* Make reason and score optional for report_event (#10077)Callum Brown2021-05-271-2/+2
| | | | | | Implements MSC2414: https://github.com/matrix-org/matrix-doc/pull/2414 See #8551 Signed-off-by: Callum Brown <callum@calcuode.com>
* Add an admin API for unprotecting local media from quarantine (#10040)Dirk Klimpel2021-05-261-0/+21
| | | Signed-off-by: Dirk Klimpel dirk@klimpel.org
* Add missing entry to the table of contents of room admin API (#10043)Dirk Klimpel2021-05-241-0/+1
|
* Delete room endpoint (#9889)ThibF2021-04-291-1/+10
| | | | | | Support the delete of a room through DELETE request and mark previous request as deprecated through documentation. Signed-off-by: Thibault Ferrante <thibault.ferrante@pm.me>
* Add an admin API to manage ratelimit for a specific user (#9648)Dirk Klimpel2021-04-131-1/+116
|
* Add `order_by` to list user admin API (#9691)Dirk Klimpel2021-04-011-22/+63
|
* Link to the List user's media admin API from media Admin API docs (#9571)Andrew Morgan2021-03-091-2/+14
| | | | | Earlier [I was convinced](https://github.com/matrix-org/synapse/issues/9565) that we didn't have an Admin API for listing media uploaded by a user. Foolishly I was looking under the Media Admin API documentation, instead of the User Admin API documentation. I thought it'd be helpful to link to the latter so others don't hit the same dead end :)
* Add an `order_by` field to list users' media admin API. (#8978)Dirk Klimpel2021-02-221-4/+34
|
* Add the shadow-banning status to the display user admin API. (#9400)Dirk Klimpel2021-02-171-3/+6
|
* Merge pull request #9150 from Yoric/develop-contextDavid Teller2021-02-081-0/+119
|\ | | | | New API /_synapse/admin/rooms/{roomId}/context/{eventId}
| * FIXUP: Documenting /_synapse/admin/v1/rooms/<room_id>/context/<event_id>David Teller2021-01-281-0/+119
| |
* | Add an admin API to get the current room state (#9168)Travis Ralston2021-02-021-0/+30
|/ | | | | This could arguably replace the existing admin API for `/members`, however that is out of scope of this change. This sort of endpoint is ideal for moderation use cases as well as other applications, such as needing to retrieve various bits of information about a room to perform a task (like syncing power levels between two places). This endpoint exposes nothing more than an admin would be able to access with a `select *` query on their database.
* 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-14 19:19:00 +0000