From c14582101be8646429d3c4d5c69d13d4df3e4e16 Mon Sep 17 00:00:00 2001 From: erikjohnston Date: Tue, 24 Aug 2021 16:08:09 +0000 Subject: deploy: f03cafb50c49a1569f1f99485f9cc42abfdc7b21 --- latest/admin_api/account_validity.html | 2 +- latest/admin_api/delete_group.html | 2 +- latest/admin_api/event_reports.html | 2 +- latest/admin_api/media_admin_api.html | 9 +- latest/admin_api/purge_history_api.html | 2 +- latest/admin_api/purge_room.html | 2 +- latest/admin_api/register_api.html | 2 +- latest/admin_api/room_membership.html | 2 +- latest/admin_api/rooms.html | 2 +- latest/admin_api/server_notices.html | 2 +- latest/admin_api/shutdown_room.html | 2 +- latest/admin_api/statistics.html | 2 +- latest/admin_api/user_admin_api.html | 155 ++++++++++++++++++++------------ latest/admin_api/version_api.html | 2 +- 14 files changed, 118 insertions(+), 70 deletions(-) (limited to 'latest/admin_api') diff --git a/latest/admin_api/account_validity.html b/latest/admin_api/account_validity.html index 1d5533378e..67108afea3 100644 --- a/latest/admin_api/account_validity.html +++ b/latest/admin_api/account_validity.html @@ -99,7 +99,7 @@ diff --git a/latest/admin_api/delete_group.html b/latest/admin_api/delete_group.html index a1615dbe94..8a8f0bf142 100644 --- a/latest/admin_api/delete_group.html +++ b/latest/admin_api/delete_group.html @@ -99,7 +99,7 @@ diff --git a/latest/admin_api/event_reports.html b/latest/admin_api/event_reports.html index 2dc76afb57..eb90e54d22 100644 --- a/latest/admin_api/event_reports.html +++ b/latest/admin_api/event_reports.html @@ -99,7 +99,7 @@ diff --git a/latest/admin_api/media_admin_api.html b/latest/admin_api/media_admin_api.html index 63b8a840f2..18a927d5e1 100644 --- a/latest/admin_api/media_admin_api.html +++ b/latest/admin_api/media_admin_api.html @@ -99,7 +99,7 @@ @@ -204,6 +204,7 @@
  • Purge Remote Media API
    • @@ -232,7 +233,8 @@ server admin: see Admin API.

    List all media uploaded by a user

    Listing all media that has been uploaded by a local user can be achieved through -the use of the List media of a user +the use of the +List media uploaded by a user Admin API.

    Quarantine media

    Quarantining media means that it is marked as inaccessible by users. It applies @@ -392,6 +394,9 @@ If false these files will be deleted. Defaults to true

  • deleted_media: an array of strings - List of deleted media_id
  • total: integer - Total number of deleted media_id
    • +

    Delete media uploaded by a user

    +

    You can find details of how to delete multiple media uploaded by a user in +User Admin API.

    Purge Remote Media API

    The purge remote media API allows server admins to purge old cached remote media.

    The API is:

    diff --git a/latest/admin_api/purge_history_api.html b/latest/admin_api/purge_history_api.html index e08aeb3b58..fb4df8bf81 100644 --- a/latest/admin_api/purge_history_api.html +++ b/latest/admin_api/purge_history_api.html @@ -99,7 +99,7 @@ diff --git a/latest/admin_api/purge_room.html b/latest/admin_api/purge_room.html index 7e0845be69..63a345e6e5 100644 --- a/latest/admin_api/purge_room.html +++ b/latest/admin_api/purge_room.html @@ -99,7 +99,7 @@ diff --git a/latest/admin_api/register_api.html b/latest/admin_api/register_api.html index b2ef27e92e..1d639570e6 100644 --- a/latest/admin_api/register_api.html +++ b/latest/admin_api/register_api.html @@ -99,7 +99,7 @@ diff --git a/latest/admin_api/room_membership.html b/latest/admin_api/room_membership.html index 7d2f1469fa..7aef12c725 100644 --- a/latest/admin_api/room_membership.html +++ b/latest/admin_api/room_membership.html @@ -99,7 +99,7 @@ diff --git a/latest/admin_api/rooms.html b/latest/admin_api/rooms.html index 4910d54678..8ed6df0a85 100644 --- a/latest/admin_api/rooms.html +++ b/latest/admin_api/rooms.html @@ -99,7 +99,7 @@ diff --git a/latest/admin_api/server_notices.html b/latest/admin_api/server_notices.html index d6b2573357..0c4e15b3d3 100644 --- a/latest/admin_api/server_notices.html +++ b/latest/admin_api/server_notices.html @@ -99,7 +99,7 @@ diff --git a/latest/admin_api/shutdown_room.html b/latest/admin_api/shutdown_room.html index c6e3557923..0014828f41 100644 --- a/latest/admin_api/shutdown_room.html +++ b/latest/admin_api/shutdown_room.html @@ -99,7 +99,7 @@ diff --git a/latest/admin_api/statistics.html b/latest/admin_api/statistics.html index 0eeb9ad49c..e38be1a229 100644 --- a/latest/admin_api/statistics.html +++ b/latest/admin_api/statistics.html @@ -99,7 +99,7 @@ diff --git a/latest/admin_api/user_admin_api.html b/latest/admin_api/user_admin_api.html index a6a1be7f97..33e351185d 100644 --- a/latest/admin_api/user_admin_api.html +++ b/latest/admin_api/user_admin_api.html @@ -99,7 +99,7 @@ @@ -248,6 +248,16 @@ specific user_id.

    "address": "<user_mail_2>" } ], + "external_ids": [ + { + "auth_provider": "<provider1>", + "external_id": "<user_id_provider_1>" + }, + { + "auth_provider": "<provider2>", + "external_id": "<user_id_provider_2>" + } + ], "avatar_url": "<avatar_url>", "admin": false, "deactivated": false @@ -255,36 +265,44 @@ specific user_id.

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

    +

    Returns HTTP status code:

    +

    URL parameters:

    Body parameters:

    If the user already exists then optional parameters default to the current value.

    In order to re-activate an account deactivated must be set to false. If @@ -553,7 +571,8 @@ member are returned.

  • joined_rooms - An array of room_id.
  • total - Number of rooms.
    • -

    List media of a user

    +

    User media

    +

    List media uploaded by a user

    Gets a list of all local media that a specific user_id has created. By default, the response is ordered by descending creation date and ascending media ID. The newest media is on top. You can change the order with parameters @@ -646,44 +665,56 @@ database, especially for large environments.

    Response

    The following fields are returned in the JSON response body:

    +

    Delete media uploaded by a user

    +

    This API deletes the local media from the disk of your own server +that a specific user_id has created. This includes any local thumbnails.

    +

    This API will not affect media that has been uploaded to external +media repositories (e.g https://github.com/turt2live/matrix-media-repo/).

    +

    By default, the API deletes media ordered by descending creation date and ascending media ID. +The newest media is deleted first. You can change the order with parameters +order_by and dir. If no limit is set the API deletes 100 files per request.

    +

    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": [
+    "abcdefghijklmnopqrstuvwx"
+  ],
+  "total": 1
+}
+
    +

    The following fields are returned in the JSON response body:

    + +

    Note: There is no next_token. This is not useful for deleting media, because +after deleting media the remaining media have a new order.

    +

    Parameters

    +

    This API has the same parameters as +List media uploaded by a user. +With the parameters you can for example limit the number of files to delete at once or +delete largest/smallest or newest/oldest files first.

    Login as a user

    Get an access token that can be used to authenticate as that user. Useful for when admins wish to do actions on behalf of a user.

    @@ -1052,6 +1083,18 @@ server admin: Admin API

  • user_id - The fully qualified MXID: for example, @user:server.com. The user must be local.
    • +

    Check username availability

    +

    Checks to see if a username is available, and valid, for the server. See the client-server +API +for more information.

    +

    This endpoint will work even if registration is disabled on the server, unlike +/_matrix/client/r0/register/available.

    +

    The API is:

    +
    POST /_synapse/admin/v1/username_availabile?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

    diff --git a/latest/admin_api/version_api.html b/latest/admin_api/version_api.html index 47d885359d..9ae899456d 100644 --- a/latest/admin_api/version_api.html +++ b/latest/admin_api/version_api.html @@ -99,7 +99,7 @@ -- cgit 1.5.1