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/user_admin_api.html | 58 ++++++++---------------------------- 1 file changed, 12 insertions(+), 46 deletions(-) (limited to 'latest/admin_api/user_admin_api.html') 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:

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.
    
 
                     
 
-- 
cgit 1.5.1