diff options
Diffstat (limited to 'docs/admin_api/room_membership.md')
-rw-r--r-- | docs/admin_api/room_membership.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/admin_api/room_membership.md b/docs/admin_api/room_membership.md new file mode 100644 index 0000000000..b6746ff5e4 --- /dev/null +++ b/docs/admin_api/room_membership.md @@ -0,0 +1,35 @@ +# 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 [README.rst](README.rst). + +Response: + +``` +{ + "room_id": "!636q39766251:server.com" +} +``` |