Element ACTION
Kick User
Remove a user from a room without banning them. A kicked user can be invited back with Invite User, and can rejoin on their own if the room's join rules allow it — use Ban User instead to also block their return. The connected account must be in the room with a power level high enough to kick, otherwise the API returns
M_FORBIDDEN; the same error is returned if the target user is not currently in the room. Use List Rooms to find the room ID. See the documentation- Action
- Writes data
- Destructive
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Element account once, then configure and run Kick User from your backend or agent.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "element-kick-user",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
element: { authProvisionId: "apn_xxxxxxx" },
roomId: "Room ID",
userId: "User ID",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "element-kick-user",
"configured_props": {
"element": { "authProvisionId": "apn_xxxxxxx" },
"roomId": "Room ID",
"userId": "User ID"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "element",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "element-kick-user",
arguments: {
roomId: "Room ID",
userId: "User ID",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
roomId Room ID | string | The Matrix room ID to kick the user from, e.g. !OGEhHVWSdvArJzumhm:matrix.org. Must be an ID, not a room alias — use Resolve Room Alias to convert one. Use List Rooms to find the ID of a room you've already joined. Required |
userId User ID | string | The full Matrix ID of the user to kick, e.g. @alice:matrix.org. Required |
reason Reason | string | Optional reason recorded on the kicked user's membership event, e.g. Telling unfunny jokes. Optional |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- element-kick-user
- Version
- 0.0.2
- App
- Element
- Authentication
- API key
- Read-only
- No
- Destructive
- Yes
- Open world
- Yes
- Source
- View on GitHub ↗