delete-user
Remove a user from your n8n instance by specifying the client ID and user ID or email, ensuring effective user management and access control.
Instructions
Delete a user from your instance.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| clientId | Yes | ||
| idOrEmail | Yes |
Implementation Reference
- src/index.ts:1361-1391 (handler)Handler for the 'delete-user' tool in the CallToolRequestSchema switch statement. Retrieves the N8nClient instance and calls deleteUser on it.case "delete-user": { const { clientId, idOrEmail } = args as { clientId: string; idOrEmail: string }; const client = clients.get(clientId); if (!client) { return { content: [{ type: "text", text: "Client not initialized. Please run init-n8n first.", }], isError: true }; } try { await client.deleteUser(idOrEmail); return { content: [{ type: "text", text: `Successfully deleted user: ${idOrEmail}`, }] }; } catch (error) { return { content: [{ type: "text", text: error instanceof Error ? error.message : "Unknown error occurred", }], isError: true }; } }
- src/index.ts:603-613 (schema)Tool schema and registration for 'delete-user' in the ListToolsRequestSchema handler, defining name, description, and input schema.{ name: "delete-user", description: "Delete a user from your instance.", inputSchema: { type: "object", properties: { clientId: { type: "string" }, idOrEmail: { type: "string" } }, required: ["clientId", "idOrEmail"] }
- src/index.ts:245-249 (helper)N8nClient helper method that performs the actual DELETE request to /users/{idOrEmail} via makeRequest.async deleteUser(idOrEmail: string): Promise<void> { return this.makeRequest<void>(`/users/${idOrEmail}`, { method: 'DELETE', }); }