anonymousland-synapse/docs/admin_api
Will Hunt a933c2c7d8
Add an admin API to check if a username is available (#10578)
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.
2021-08-17 10:52:38 +01:00
..
account_validity.md Convert admin api docs to markdown (#10089) 2021-06-03 14:06:03 +01:00
delete_group.md Fix broken links in documentation (#10180) 2021-06-16 13:15:52 +01:00
event_reports.md Fix broken links in documentation (#10180) 2021-06-16 13:15:52 +01:00
media_admin_api.md Admin API to delete media for a specific user (#10558) 2021-08-11 19:29:59 +00:00
purge_history_api.md Fix broken links in documentation (#10180) 2021-06-16 13:15:52 +01:00
purge_room.md Deprecate Shutdown Room and Purge Room Admin API (#8829) 2020-12-10 11:42:48 +00:00
README.rst Fix broken links in documentation (#10180) 2021-06-16 13:15:52 +01:00
register_api.md Convert admin api docs to markdown (#10089) 2021-06-03 14:06:03 +01:00
room_membership.md Fix broken links in documentation (#10180) 2021-06-16 13:15:52 +01:00
rooms.md Simplify structure of room admin API docs (#10313) 2021-07-07 12:18:36 +01:00
server_notices.md Docs: Use something other than the document name to describe a page (#10399) 2021-07-15 12:47:55 +01:00
shutdown_room.md Deprecate Shutdown Room and Purge Room Admin API (#8829) 2020-12-10 11:42:48 +00:00
statistics.md Fix broken links in documentation (#10180) 2021-06-16 13:15:52 +01:00
user_admin_api.md Add an admin API to check if a username is available (#10578) 2021-08-17 10:52:38 +01:00
version_api.md Convert admin api docs to markdown (#10089) 2021-06-03 14:06:03 +01:00

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

**Note**: The latest documentation can be viewed `here <https://matrix-org.github.io/synapse>`_.
See `docs/README.md <../README.md>`_ for more information.

**Please update links to point to the website instead.** Existing files in this directory
are preserved to maintain historical links, but may be moved in the future.

This directory includes documentation for the various synapse specific admin
APIs available. Updates to the existing Admin API documentation should still
be made to these files, but any new documentation files should instead be placed under
`docs/usage/administration/admin_api <../usage/administration/admin_api>`_.