From 032dafe232f4e2c93b92c83b51c3c1c3dfe30bf0 Mon Sep 17 00:00:00 2001 From: David Robertson Date: Mon, 24 Oct 2022 14:05:50 +0100 Subject: Rearrange admin API fs heirarchy to match sidebar I've kept the RST redirect file in-place though --- docs/administration/admin_api/room_membership.md | 35 ++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 docs/administration/admin_api/room_membership.md (limited to 'docs/administration/admin_api/room_membership.md') 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/ + +{ + "user_id": "@user:server.com" +} +``` + +Response: + +```json +{ + "room_id": "!636q39766251:server.com" +} +``` -- cgit 1.5.1