This repository has been archived by the owner on Apr 26, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
I haven't (yet) documented all of the user-list APIs introduced in #1784 because the API shape seems very odd, given the functionality.
- Loading branch information
Showing
1 changed file
with
66 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |