MatrixSynapse/docs/admin_api
Dirk Klimpel 491f0dab1b
Add delete room admin endpoint (#7613)
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`.
901b1fa561/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
2020-07-14 12:36:23 +01:00
..
README.rst Clarifications to the admin api documentation (#7647) 2020-06-05 17:31:05 +01:00
account_validity.rst Move admin API to a new prefix 2019-05-01 15:44:30 +01:00
delete_group.md Clarifications to the admin api documentation (#7647) 2020-06-05 17:31:05 +01:00
media_admin_api.md Clarifications to the admin api documentation (#7647) 2020-06-05 17:31:05 +01:00
purge_history_api.rst Clarifications to the admin api documentation (#7647) 2020-06-05 17:31:05 +01:00
purge_remote_media.rst Clarifications to the admin api documentation (#7647) 2020-06-05 17:31:05 +01:00
purge_room.md Add delete room admin endpoint (#7613) 2020-07-14 12:36:23 +01:00
register_api.rst Move admin API to a new prefix 2019-05-01 15:44:30 +01:00
room_membership.md Clarifications to the admin api documentation (#7647) 2020-06-05 17:31:05 +01:00
rooms.md Add delete room admin endpoint (#7613) 2020-07-14 12:36:23 +01:00
server_notices.md Fix spelling in server notices admin API docs (#5142) 2019-05-06 22:15:02 +01:00
shutdown_room.md Add delete room admin endpoint (#7613) 2020-07-14 12:36:23 +01:00
user_admin_api.rst Clarifications to the admin api documentation (#7647) 2020-06-05 17:31:05 +01:00
version_api.rst Remove the requirement to authenticate for /admin/server_version. (#5122) 2019-05-07 09:29:30 +01:00

README.rst

Admin APIs
==========

This directory includes documentation for the various synapse specific admin
APIs available.

Authenticating as a server admin
--------------------------------

Many of the API calls in the admin api will require an `access_token` for a
server admin. (Note that a server admin is distinct from a room admin.)

A user can be marked as a server admin by updating the database directly, e.g.:

.. code-block:: sql

    UPDATE users SET admin = 1 WHERE name = '@foo:bar.com';

A new server admin user can also be created using the
``register_new_matrix_user`` script.

Finding your user's `access_token` is client-dependent, but will usually be shown in the client's settings.

Once you have your `access_token`, to include it in a request, the best option is to add the token to a request header:

``curl --header "Authorization: Bearer <access_token>" <the_rest_of_your_API_request>``

Fore more details, please refer to the complete `matrix spec documentation <https://matrix.org/docs/spec/client_server/r0.5.0#using-access-tokens>`_.