summary refs log tree commit diff
path: root/docs/administration/admin_api/room_membership.md
diff options
context:
space:
mode:
authorDavid Robertson <davidr@element.io>2022-10-24 14:05:50 +0100
committerDavid Robertson <davidr@element.io>2022-10-24 14:12:58 +0100
commit032dafe232f4e2c93b92c83b51c3c1c3dfe30bf0 (patch)
tree2e513b6fddf3f8a1b4f285d38d3fd12fa820599b /docs/administration/admin_api/room_membership.md
parentMove admin docs to admin section (excluding admin api) (diff)
downloadsynapse-032dafe232f4e2c93b92c83b51c3c1c3dfe30bf0.tar.xz
Rearrange admin API fs heirarchy to match sidebar
I've kept the RST redirect file in-place though
Diffstat (limited to 'docs/administration/admin_api/room_membership.md')
-rw-r--r--docs/administration/admin_api/room_membership.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/administration/admin_api/room_membership.md b/docs/administration/admin_api/room_membership.md
new file mode 100644

index 0000000000..310d6ae628 --- /dev/null +++ b/docs/administration/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. + +To use it, you will need to authenticate by providing an `access_token` +for a server admin: see [Admin API](../usage/administration/admin_api). + +## 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" +} +``` + +Response: + +```json +{ + "room_id": "!636q39766251:server.com" +} +```