diff options
author | Andrew Morgan <andrew@amorgan.xyz> | 2021-05-26 18:25:35 +0100 |
---|---|---|
committer | Andrew Morgan <andrew@amorgan.xyz> | 2021-05-27 18:38:08 +0100 |
commit | d1d988f289fdd552f067a359a29f7e402311e5d0 (patch) | |
tree | 9922d7520ba4a64383a294989ab29806a47d44b6 /docs | |
parent | Update docs/README.md with information on the site and how to build it (diff) | |
download | synapse-d1d988f289fdd552f067a359a29f7e402311e5d0.tar.xz |
Update oft-linked to admin_api directory with info about the new site
I also moved the information about how to get an admin access token to the "Admin API" chapter of the docs (and lightly spruced it up + did RST -> MD).
Diffstat (limited to 'docs')
-rw-r--r-- | docs/SUMMARY.md | 2 | ||||
-rw-r--r-- | docs/admin_api/README.rst | 30 | ||||
-rw-r--r-- | docs/usage/administration/admin_api/README.md | 28 |
3 files changed, 37 insertions, 23 deletions
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 39c8879b58..e94c84ce27 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -37,7 +37,7 @@ - [Using `synctl` with Workers](synctl_workers.md) - [Systemd](systemd-with-workers/README.md) - [Administration](usage/administration/README.md) - - [Admin API](admin_api/README.rst) + - [Admin API](usage/administration/admin_api/README.md) - [Account Validity](admin_api/account_validity.rst) - [Delete Group](admin_api/delete_group.md) - [Event Reports](admin_api/event_reports.md) diff --git a/docs/admin_api/README.rst b/docs/admin_api/README.rst index 9587bee0ce..37cee87d32 100644 --- a/docs/admin_api/README.rst +++ b/docs/admin_api/README.rst @@ -1,28 +1,14 @@ 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 +**Note**: The latest documentation can be viewed `here <https://matrix-org.github.io/synapse>`_. +See `docs/README.md <../docs/README.md>`_ for more information. - UPDATE users SET admin = 1 WHERE name = '@foo:bar.com'; +**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. -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>`` +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 <../docs/usage/administration/admin_api>`_. -Fore more details, please refer to the complete `matrix spec documentation <https://matrix.org/docs/spec/client_server/r0.5.0#using-access-tokens>`_. diff --git a/docs/usage/administration/admin_api/README.md b/docs/usage/administration/admin_api/README.md new file mode 100644 index 0000000000..53829741dd --- /dev/null +++ b/docs/usage/administration/admin_api/README.md @@ -0,0 +1,28 @@ +# The Admin API + +## Authenticate 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.: + +```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](../../../../scripts/register_new_matrix_user) script. + +Finding your user's `access_token` is client-dependent, but will usually be shown in the client's settings. + +## Making an Admin API request +Once you have your `access_token`, you will need to authenticate each request to an Admin API endpoint by +providing the token as either a query parameter or a request header. To add it as a request header in cURL: + +```sh +curl --header "Authorization: Bearer <access_token>" <the_rest_of_your_API_request> +``` + +For more details on access tokens in Matrix, please refer to the complete +[matrix spec documentation](https://matrix.org/docs/spec/client_server/r0.6.1#using-access-tokens). |