From 8bbf1547e69841c3d229a0d064644095d7820c38 Mon Sep 17 00:00:00 2001
From: Richard van der Hoff <richard@matrix.org>
Date: Thu, 20 Apr 2017 21:00:02 +0100
Subject: [PATCH 1/2] Document some of the admin APIs

I haven't (yet) documented all of the user-list APIs introduced in
https://github.com/matrix-org/synapse/pull/1784 because the API shape seems
very odd, given the functionality.
---
 docs/admin_api/user_admin_api.rst | 66 +++++++++++++++++++++++++++++++
 1 file changed, 66 insertions(+)
 create mode 100644 docs/admin_api/user_admin_api.rst

diff --git a/docs/admin_api/user_admin_api.rst b/docs/admin_api/user_admin_api.rst
new file mode 100644
index 000000000000..97ac1854ad60
--- /dev/null
+++ b/docs/admin_api/user_admin_api.rst
@@ -0,0 +1,66 @@
+Query Account
+=============
+
+This API returns information about a specific user account.
+
+The api is::
+
+    GET /_matrix/client/r0/admin/whois/<user_id>
+
+including an ``access_token`` of a server admin.
+
+It returns a JSON body liek the following:
+
+.. code:: json
+
+    {
+        "user_id": "<user_id>",
+        "devices": {
+            "": {
+                "sessions": [
+                    {
+                        "connections": [
+                            {
+                                "ip": "1.2.3.4",
+                                "last_seen": 1417222374433, # ms since 1970
+                                "user_agent": "Mozilla/5.0 ..."
+                            },
+                            # ...
+                        ]
+                    }
+                ]
+            }
+        }
+    }
+
+
+Deactivate Account
+==================
+
+This API deactivates an account. It removes active access tokens, resets the
+password, and deletes third-party IDs (to prevent the user requesting a
+password reset).
+
+The api is::
+
+    POST /_matrix/client/r0/admin/deactivate/<user_id>
+
+including an ``access_token`` of a server admin, and an empty request body.
+
+
+Reset password
+==============
+
+Changes the password of another user.
+
+The api is::
+
+    POST /_matrix/client/r0/admin/reset_password/<user_id>
+
+with a body of::
+
+   {
+       "new_password": "<secret>"
+   }
+
+including an ``access_token`` of a server admin.

From e3c3a8afe819bd03dbc6201e1b187c38567291ae Mon Sep 17 00:00:00 2001
From: Richard van der Hoff <github@rvanderhoff.org.uk>
Date: Thu, 20 Apr 2017 21:10:06 +0100
Subject: [PATCH 2/2] Update user_admin_api.rst

fix some typos and formatting
---
 docs/admin_api/user_admin_api.rst | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/docs/admin_api/user_admin_api.rst b/docs/admin_api/user_admin_api.rst
index 97ac1854ad60..1c9c5a6bde36 100644
--- a/docs/admin_api/user_admin_api.rst
+++ b/docs/admin_api/user_admin_api.rst
@@ -9,7 +9,7 @@ The api is::
 
 including an ``access_token`` of a server admin.
 
-It returns a JSON body liek the following:
+It returns a JSON body like the following:
 
 .. code:: json
 
@@ -22,10 +22,14 @@ It returns a JSON body liek the following:
                         "connections": [
                             {
                                 "ip": "1.2.3.4",
-                                "last_seen": 1417222374433, # ms since 1970
+                                "last_seen": 1417222374433,
                                 "user_agent": "Mozilla/5.0 ..."
                             },
-                            # ...
+                            {
+                                "ip": "1.2.3.10",
+                                "last_seen": 1417222374500,
+                                "user_agent": "Dalvik/2.1.0 ..."
+                            }
                         ]
                     }
                 ]
@@ -33,6 +37,7 @@ It returns a JSON body liek the following:
         }
     }
 
+``last_seen`` is measured in milliseconds since the Unix epoch.
 
 Deactivate Account
 ==================
@@ -57,7 +62,9 @@ The api is::
 
     POST /_matrix/client/r0/admin/reset_password/<user_id>
 
-with a body of::
+with a body of:
+
+.. code:: json
 
    {
        "new_password": "<secret>"