From 3e9f830a1f3368f5210862317e608a528735a38b Mon Sep 17 00:00:00 2001 From: babolivier Date: Tue, 12 Oct 2021 09:56:14 +0000 Subject: deploy: 60af28c5dd803ac4ad1aa216574cac33b6daed6a --- v1.45/usage/administration/admin_api/index.html | 273 ++++++++++++++++++++++++ 1 file changed, 273 insertions(+) create mode 100644 v1.45/usage/administration/admin_api/index.html (limited to 'v1.45/usage/administration/admin_api/index.html') diff --git a/v1.45/usage/administration/admin_api/index.html b/v1.45/usage/administration/admin_api/index.html new file mode 100644 index 0000000000..9b0d0535f2 --- /dev/null +++ b/v1.45/usage/administration/admin_api/index.html @@ -0,0 +1,273 @@ + + + + + + Admin API - Synapse + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + + + + + + +
+
+ +
+ +
+ +

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.:

+
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 +command. This is a script that is located in the scripts/ directory, or possibly +already on your $PATH depending on how Synapse was installed.

+

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:

+
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.

+ +
+ + +
+
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file -- cgit 1.5.1