From b60efa69dad9c8b1a4e2e306a59b470f10b3f670 Mon Sep 17 00:00:00 2001
From: richvdh To use it, you will need to authenticate by providing an GET /_synapse/admin/v2/users/<user_id>
access_token
for a
-server admin: Admin API
It returns a JSON body like the following:
{
"displayname": "User",
@@ -244,7 +244,7 @@ specific user_id
.
}
To use it, you will need to authenticate by providing an access_token
for a
-server admin: Admin API
URL parameters:
user_id
: fully-qualified user id: for example, @user:server.com
.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": [
@@ -406,7 +406,7 @@ This allows user type specific behaviour. There are also types supportSee also: Client Server
API Whois.
To use it, you will need to authenticate by providing an access_token
for a
-server admin: Admin API
+server admin: Admin API
It returns a JSON body like the following:
{
"user_id": "<user_id>",
@@ -449,7 +449,7 @@ were sent, but hidden from users joining the room afterwards.
}
To use it, you will need to authenticate by providing an access_token
for a
-server admin: Admin API
+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:
@@ -483,7 +483,7 @@ is set to 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
.
logout_devices
is optional and defaults to true
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
+server admin: Admin API
A response body like the following is returned:
{
"admin": true
@@ -508,14 +508,14 @@ server admin: Admin API
}
To use it, you will need to authenticate by providing an access_token
for a
-server admin: Admin API
+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
+server admin: Admin API
A response body like the following is returned:
{
"joined_rooms": [
@@ -548,7 +548,7 @@ The newest media is on top. You can change the order with parameters
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
+server admin: Admin API
A response body like the following is returned:
{
"media": [
@@ -699,7 +699,7 @@ same.
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
+server admin: Admin API
A response body like the following is returned:
{
"devices": [
@@ -761,7 +761,7 @@ 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
+server admin: Admin API
An empty JSON dict is returned.
Parameters
The following parameters should be set in the URL:
@@ -778,7 +778,7 @@ server admin: Admin API
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
+server admin: Admin API
A response body like the following is returned:
{
"device_id": "<device_id>",
@@ -816,7 +816,7 @@ devices was last seen. (May be a few minutes out of date, for efficiency reasons
}
To use it, you will need to authenticate by providing an access_token
for a
-server admin: Admin API
+server admin: Admin API
An empty JSON dict is returned.
Parameters
The following parameters should be set in the URL:
@@ -838,7 +838,7 @@ 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
+server admin: Admin API
An empty JSON dict is returned.
Parameters
The following parameters should be set in the URL:
@@ -852,7 +852,7 @@ server admin: Admin API
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
+server admin: Admin API
A response body like the following is returned:
{
"pushers": [
@@ -949,7 +949,7 @@ A shadow-banned user will be unable to contact anyone on the server.
POST /_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
+server admin: Admin API
An empty JSON dict is returned.
Parameters
The following parameters should be set in the URL:
@@ -965,7 +965,7 @@ There are specific APIs to set, get and delete a ratelimit.
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
+server admin: Admin API
A response body like the following is returned:
{
"messages_per_second": 0,
@@ -994,7 +994,7 @@ being limited.
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
+server admin: Admin API
A response body like the following is returned:
{
"messages_per_second": 0,
@@ -1028,7 +1028,7 @@ being limited.
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
+server admin: Admin API
An empty JSON dict is returned.
{}
--
cgit 1.5.1