MirrorHub/synapse
0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-12-15 07:13:49 +01:00
Code Issues Projects Releases Wiki Activity
synapse/docs/admin_api/room_membership.md
Sumner Evans ece84f2c45
Improve code formatting and fix a few typos in docs (#11221) 
* Labeled a lot more code blocks with the appropriate type
* Fixed a couple of minor typos (missing/extraneous commas)

Signed-off-by: Sumner Evans <me@sumnerevans.com>
2021-11-01 11:35:55 +00:00

831 B
Raw Blame History

Edit Room Membership API

This API allows an administrator to join an user account with a given user_id to a room with a given room_id_or_alias. You can only modify the membership of local users. The server administrator must be in the room and have permission to invite users.

Parameters

The following parameters are available:

  • user_id - Fully qualified user: for example, @user:server.com.
  • room_id_or_alias - The room identifier or alias to join: for example, !636q39766251:server.com.

Usage

POST /_synapse/admin/v1/join/<room_id_or_alias>

{
  "user_id": "@user:server.com"
}

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

Response:

{
  "room_id": "!636q39766251:server.com"
}