From 9061d49ebbefffeee2de5178461086224f178a24 Mon Sep 17 00:00:00 2001 From: babolivier Date: Tue, 8 Feb 2022 13:26:46 +0000 Subject: deploy: 0b561a0ea1384db214c274f45b160c538d2ab65d --- latest/admin_api/account_validity.html | 2 ++ latest/admin_api/delete_group.html | 4 +-- latest/admin_api/event_reports.html | 6 ++-- latest/admin_api/media_admin_api.html | 35 ++------------------ latest/admin_api/purge_history_api.html | 6 ++-- latest/admin_api/room_membership.html | 4 +-- latest/admin_api/rooms.html | 25 ++------------ latest/admin_api/statistics.html | 4 +-- latest/admin_api/user_admin_api.html | 58 +++++++-------------------------- latest/admin_api/version_api.html | 2 +- 10 files changed, 31 insertions(+), 115 deletions(-) (limited to 'latest/admin_api') diff --git a/latest/admin_api/account_validity.html b/latest/admin_api/account_validity.html index f095486380..53b5debb90 100644 --- a/latest/admin_api/account_validity.html +++ b/latest/admin_api/account_validity.html @@ -186,6 +186,8 @@

This API allows a server administrator to manage the validity of an account. To use it, you must enable the account validity feature (under account_validity) in Synapse's configuration.

+

To use it, you will need to authenticate by providing an access_token +for a server admin: see Admin API.

Renew account

This API extends the validity of an account by as much time as configured in the period parameter from the account_validity configuration.

diff --git a/latest/admin_api/delete_group.html b/latest/admin_api/delete_group.html index afb7e1f8ee..39bc09232f 100644 --- a/latest/admin_api/delete_group.html +++ b/latest/admin_api/delete_group.html @@ -186,11 +186,11 @@

This API lets a server admin delete a local group. Doing so will kick all users out of the group so that their clients will correctly handle the group being deleted.

+

To use it, you will need to authenticate by providing an access_token +for a server admin: see Admin API.

The API is:

POST /_synapse/admin/v1/delete_group/<group_id>
-

To use it, you will need to authenticate by providing an access_token for a -server admin: see Admin API.

diff --git a/latest/admin_api/event_reports.html b/latest/admin_api/event_reports.html index a90b1e8122..9e23060f0a 100644 --- a/latest/admin_api/event_reports.html +++ b/latest/admin_api/event_reports.html @@ -184,11 +184,11 @@

Show reported events

This API returns information about reported events.

+

To use it, you will need to authenticate by providing an access_token +for a server admin: see Admin API.

The api is:

GET /_synapse/admin/v1/event_reports?from=0&limit=10
-

To use it, you will need to authenticate by providing an access_token for a -server admin: see Admin API.

It returns a JSON body like the following:

{
     "event_reports": [
@@ -265,8 +265,6 @@ have a canonical alias set.
 
The api is:

 
GET /_synapse/admin/v1/event_reports/<report_id>
 

-
To use it, you will need to authenticate by providing an access_token for a
-server admin: see Admin API.

 
It returns a JSON body like the following:

 
{
     "event_id": "$bNUFCwGzWca1meCGkjp-zwslF-GfVcXukvRLI1_FaVY",
diff --git a/latest/admin_api/media_admin_api.html b/latest/admin_api/media_admin_api.html
index c3d9eb9442..910c4a491f 100644
--- a/latest/admin_api/media_admin_api.html
+++ b/latest/admin_api/media_admin_api.html
@@ -182,43 +182,16 @@
                             
                         
 
-                        
Contents

-
-
Querying media

+                        
Querying media

 
These APIs allow extracting media information from the homeserver.

+
To use it, you will need to authenticate by providing an access_token
+for a server admin: see Admin API.

 
List all media in a room

 
This API gets a list of known media in a room.
 However, it only shows media from unencrypted events or rooms.

 
The API is:

 
GET /_synapse/admin/v1/room/<room_id>/media
 

-
To use it, you will need to authenticate by providing an access_token for a
-server admin: see Admin API.

 
The API returns a JSON body like the following:

 
{
   "local": [
@@ -418,8 +391,6 @@ All cached media that was last accessed before this timestamp will be removed.
 
  • deleted: integer - The number of media items successfully deleted
    • 
 
-
    To use it, you will need to authenticate by providing an access_token for a
-server admin: see Admin API.
    
 
    If the user re-requests purged remote media, synapse will re-request the media
 from the originating server.
    
 
diff --git a/latest/admin_api/purge_history_api.html b/latest/admin_api/purge_history_api.html
index a14d06c54f..623850fae3 100644
--- a/latest/admin_api/purge_history_api.html
+++ b/latest/admin_api/purge_history_api.html
@@ -190,11 +190,11 @@ several minutes or longer. During this period users will not be able to
 paginate further back in the room from the point being purged from.
    
 
    Note that Synapse requires at least one message in each room, so it will never
 delete the last message in a room.
    
+
    To use it, you will need to authenticate by providing an access_token
+for a server admin: see Admin API.
    
 
    The API is:
    
 
    POST /_synapse/admin/v1/purge_history/<room_id>[/<event_id>]
 
    
-
    To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
    
 
    By default, events sent by local users are not deleted, as they may represent
 the only copies of this content in existence. (Events sent by remote users are
 deleted.)
    
@@ -220,8 +220,6 @@ a purge id:
    
 
    It is possible to poll for updates on recent purges with a second API;
    
 
    GET /_synapse/admin/v1/purge_history_status/<purge_id>
 
    
-
    Again, you will need to authenticate by providing an access_token for a
-server admin.
    
 
    This API returns a JSON body like the following:
    
 
    {
     "status": "active"
diff --git a/latest/admin_api/room_membership.html b/latest/admin_api/room_membership.html
index 69c7b1c368..0b7f5a2d86 100644
--- a/latest/admin_api/room_membership.html
+++ b/latest/admin_api/room_membership.html
@@ -187,6 +187,8 @@
 to a room with a given room_id_or_alias. You can only modify the membership of
 local users. The server administrator must be in the room and have permission to
 invite users.
    
+
    To use it, you will need to authenticate by providing an access_token
+for a server admin: see Admin API.
    
 
    Parameters
    
 
    The following parameters are available:
    
 
      
@@ -201,8 +203,6 @@ invite users.
      
   "user_id": "@user:server.com"
 }
 
    
-
    To use it, you will need to authenticate by providing an access_token for a
-server admin: see Admin API.
    
 
    Response:
    
 
    {
   "room_id": "!636q39766251:server.com"
diff --git a/latest/admin_api/rooms.html b/latest/admin_api/rooms.html
index ff2db80fc4..7c50e2e1a6 100644
--- a/latest/admin_api/rooms.html
+++ b/latest/admin_api/rooms.html
@@ -182,29 +182,12 @@
                             
                         
 
-                        
    Contents
    
-
-
    List Room API
    
+                        
    List Room API
    
 
    The List Room admin API allows server admins to get a list of rooms on their
 server. There are various parameters available that allow for filtering and
 sorting the returned list. This API supports pagination.
    
+
    To use it, you will need to authenticate by providing an access_token
+for a server admin: see Admin API.
    
 
    Parameters
    
 
    The following query parameters are available:
    
 
      
@@ -617,8 +600,6 @@ Depending on the amount of history being purged, a call to the API may take
 several minutes or longer.
      
 
      The local server will only have the power to move local user and room aliases to
 the new room. Users on other servers will be unaffected.
      
-
      To use it, you will need to authenticate by providing an access_token for a
-server admin: see Admin API.
      
 
      Version 1 (old version)
      
 
      This version works synchronously. That means you only get the response once the server has
 finished the action, which may take a long time. If you request the same action
diff --git a/latest/admin_api/statistics.html b/latest/admin_api/statistics.html
index f7c04b48f7..d723672b4e 100644
--- a/latest/admin_api/statistics.html
+++ b/latest/admin_api/statistics.html
@@ -185,11 +185,11 @@
                         
      Users' media usage statistics
      
 
      Returns information about all local media usage of users. Gives the
 possibility to filter them by time and user.
      
+
      To use it, you will need to authenticate by providing an access_token
+for a server admin: see Admin API.
      
 
      The API is:
      
 
      GET /_synapse/admin/v1/statistics/users/media
 
      
-
      To use it, you will need to authenticate by providing an access_token
-for a server admin: see Admin API.
      
 
      A response body like the following is returned:
      
 
      {
   "users": [
diff --git a/latest/admin_api/user_admin_api.html b/latest/admin_api/user_admin_api.html
index 5e10a62d64..bb59adca6f 100644
--- a/latest/admin_api/user_admin_api.html
+++ b/latest/admin_api/user_admin_api.html
@@ -183,13 +183,13 @@
                         
 
                         
      User Admin API
      
+
      To use it, you will need to authenticate by providing an access_token
+for a server admin: see Admin API.
      
 
      Query User Account
      
 
      This API returns information about a specific user account.
      
 
      The api is:
      
 
      GET /_synapse/admin/v2/users/<user_id>
 
      
-
      To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
      
 
      It returns a JSON body like the following:
      
 
      {
     "name": "@user:example.com",
@@ -270,8 +270,6 @@ specific user_id.
      
     "user_type": null
 }
 
      
-
      To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
      
 
      Returns HTTP status code:
      
 
        
 
      • 201 - When a new user object was created.
        • 
@@ -322,8 +320,6 @@ users do not login via single-sign-on, a new password must be provi
 By default, the response is ordered by ascending user ID.
        
 
        GET /_synapse/admin/v2/users?from=0&limit=10&guests=false
 
        
-
        To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
        
 
        A response body like the following is returned:
        
 
        {
     "users": [
@@ -447,8 +443,6 @@ This allows user type specific behaviour. There are also types support
        
 
        See also: Client Server
 API Whois.
        
-
        To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
        
 
        It returns a JSON body like the following:
        
 
        {
     "user_id": "<user_id>",
@@ -490,8 +484,6 @@ were sent, but hidden from users joining the room afterwards.
        
     "erase": true
 }
 
        
-
        To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
        
 
        The erase parameter is optional and defaults to false.
 An empty body may be passed for backwards compatibility.
        
 
        The following actions are performed when deactivating an user:
        
@@ -506,6 +498,14 @@ An empty body may be passed for backwards compatibility.
        
 
      • Remove the user from the user directory
        • 
 
      • Reject all pending invites
        • 
 
      • Remove all account validity information related to the user
        • 
+
      • Remove the arbitrary data store known as account data. For example, this includes:
+
          
+
        • list of ignored users;
          • 
+
        • push rules;
          • 
+
        • secret storage keys; and
          • 
+
        • cross-signing keys.
          • 
+
        
+
        • 
 
      
 
      The following additional actions are performed during deactivation if erase
 is set to true:
      
@@ -519,7 +519,6 @@ is set to true:
      
 
    • Remove mappings of SSO IDs
      • 
 
    • Delete media uploaded by user (included avatar images)
      • 
 
    • Delete sent and received messages
      • 
-
    • Delete E2E cross-signing keys
      • 
 
    • Remove the user's creation (registration) timestamp
      • 
 
    • Remove rate limit overrides
      • 
 
    • Remove from monthly active users
      • 
@@ -535,16 +534,12 @@ is set to true:
      
    "logout_devices": true
 }
 
      
-
      To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
      
 
      The parameter new_password is required.
 The parameter logout_devices is optional and defaults to true.
      
 
      Get whether a user is a server administrator or not
      
 
      The api is:
      
 
      GET /_synapse/admin/v1/users/<user_id>/admin
 
      
-
      To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
      
 
      A response body like the following is returned:
      
 
      {
     "admin": true
@@ -560,15 +555,11 @@ server admin: Admin API
      
     "admin": true
 }
 
      
-
      To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
      
 
      List room memberships of a user
      
 
      Gets a list of all room_id that a specific user_id is member.
      
 
      The API is:
      
 
      GET /_synapse/admin/v1/users/<user_id>/joined_rooms
 
      
-
      To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
      
 
      A response body like the following is returned:
      
 
          {
         "joined_rooms": [
@@ -670,8 +661,6 @@ The newest media is on top. You can change the order with parameters
 
      The API is:
      
 
      GET /_synapse/admin/v1/users/<user_id>/media
 
      
-
      To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
      
 
      A response body like the following is returned:
      
 
      {
   "media": [
@@ -783,8 +772,6 @@ The newest media is deleted first. You can change the order with parameters
 
      The API is:
      
 
      DELETE /_synapse/admin/v1/users/<user_id>/media
 
      
-
      To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
      
 
      A response body like the following is returned:
      
 
      {
   "deleted_media": [
@@ -833,8 +820,6 @@ same.
      
 
      The API is:
      
 
      GET /_synapse/admin/v2/users/<user_id>/devices
 
      
-
      To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
      
 
      A response body like the following is returned:
      
 
      {
   "devices": [
@@ -895,8 +880,6 @@ any access token associated with them.
      
   ],
 }
 
      
-
      To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
      
 
      An empty JSON dict is returned.
      
 
      Parameters
      
 
      The following parameters should be set in the URL:
      
@@ -912,8 +895,6 @@ server admin: Admin API
      
 
      The API is:
      
 
      GET /_synapse/admin/v2/users/<user_id>/devices/<device_id>
 
      
-
      To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
      
 
      A response body like the following is returned:
      
 
      {
   "device_id": "<device_id>",
@@ -950,8 +931,6 @@ devices was last seen. (May be a few minutes out of date, for efficiency reasons
   "display_name": "My other phone"
 }
 
      
-
      To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
      
 
      An empty JSON dict is returned.
      
 
      Parameters
      
 
      The following parameters should be set in the URL:
      
@@ -972,8 +951,6 @@ and invalidates any access token associated with it.
      
 
 {}
 
      
-
      To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
      
 
      An empty JSON dict is returned.
      
 
      Parameters
      
 
      The following parameters should be set in the URL:
      
@@ -986,8 +963,6 @@ server admin: Admin API
      
 
      The API is:
      
 
      GET /_synapse/admin/v1/users/<user_id>/pushers
 
      
-
      To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
      
 
      A response body like the following is returned:
      
 
      {
   "pushers": [
@@ -1086,8 +1061,6 @@ A shadow-banned user will be unable to contact anyone on the server.
      
 
      To un-shadow-ban a user the API is:
      
 
      DELETE /_synapse/admin/v1/users/<user_id>/shadow_ban
 
      
-
      To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
      
 
      An empty JSON dict is returned in both cases.
      
 
      Parameters
      
 
      The following parameters should be set in the URL:
      
@@ -1102,8 +1075,6 @@ There are specific APIs to set, get and delete a ratelimit.
      
 
      The API is:
      
 
      GET /_synapse/admin/v1/users/<user_id>/override_ratelimit
 
      
-
      To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
      
 
      A response body like the following is returned:
      
 
      {
   "messages_per_second": 0,
@@ -1131,8 +1102,6 @@ being limited.
 
      The API is:
      
 
      POST /_synapse/admin/v1/users/<user_id>/override_ratelimit
 
      
-
      To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
      
 
      A response body like the following is returned:
      
 
      {
   "messages_per_second": 0,
@@ -1165,8 +1134,6 @@ being limited.
 
      The API is:
      
 
      DELETE /_synapse/admin/v1/users/<user_id>/override_ratelimit
 
      
-
      To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
      
 
      An empty JSON dict is returned.
      
 
      {}
 
      
@@ -1185,9 +1152,8 @@ for more information.
      
 
      The API is:
      
 
      GET /_synapse/admin/v1/username_available?username=$localpart
 
      
-
      The request and response format is the same as the /_matrix/client/r0/register/available API.
      
-
      To use it, you will need to authenticate by providing an access_token for a
-server admin: Admin API
      
+
      The request and response format is the same as the
+/_matrix/client/r0/register/available API.
      
 
                     
 
diff --git a/latest/admin_api/version_api.html b/latest/admin_api/version_api.html
index 6a16fc1547..d297e03d33 100644
--- a/latest/admin_api/version_api.html
+++ b/latest/admin_api/version_api.html
@@ -193,7 +193,7 @@ contains Synapse version information).
      
 
      It returns a JSON body like the following:
      
 
      {
     "server_version": "0.99.2rc1 (b=develop, abcdef123)",
-    "python_version": "3.6.8"
+    "python_version": "3.7.8"
 }
 
      
 
-- 
cgit 1.4.1