@postman/postman-mcp-server/dist/src/tools/removeTeamMembers.js

Postman MCP Server — connect AI agents (Claude Code, Cursor, VS Code Copilot, Gemini CLI) to your Postman collections, specifications, and environments via Model Context Protocol (MCP)

import { z } from 'zod';
import { ContentType } from '../clients/postman.js';
import { asMcpError, McpError } from './utils/toolHelpers.js';
export const method = 'removeTeamMembers';
export const title = 'Remove team members';
export const description = "Removes users, groups, or organizations from a Postman team. Returns 204 with no body on\nsuccess.\nThis is destructive and not self-reversing: removed members lose access to the team's\ncollections, environments, and workspaces, and restoring them means re-inviting them and\nrebuilding their roles. Only call it on an explicit instruction naming exactly who to\nremove. Never call it to tidy up inactive members, to act on a list you assembled\nyourself, or as a step in some larger cleanup.\n";
export const parameters = z.object({
    teamId: z.number().int().describe("The team's ID."),
    identifierType: z
        .string()
        .describe('Use SCIM user and group IDs instead of Postman user IDs.')
        .optional(),
    entities: z
        .array(z.object({
        entityType: z.enum(['user', 'group', 'team', 'organization']).describe('The entity type.'),
        entityId: z.union([z.number().int(), z.string()]).describe("The entity's ID."),
    }))
        .describe('A list of entities to remove.')
        .optional(),
});
export const annotations = {
    title: 'Remove team members',
    readOnlyHint: false,
    openWorldHint: true,
    destructiveHint: true,
    idempotentHint: true,
};
export async function handler(args, extra) {
    try {
        const endpoint = `/teams/${encodeURIComponent(String(args.teamId))}/bulk-members`;
        const query = new URLSearchParams();
        const url = query.toString() ? `${endpoint}?${query.toString()}` : endpoint;
        const bodyPayload = {};
        if (args.entities !== undefined)
            bodyPayload.entities = args.entities;
        const options = {
            body: JSON.stringify(bodyPayload),
            contentType: ContentType.Json,
            headers: extra.headers,
        };
        const result = await extra.client.delete(url, options);
        return {
            content: [
                {
                    type: 'text',
                    text: `${typeof result === 'string' ? result : JSON.stringify(result, null, 2)}`,
                },
            ],
        };
    }
    catch (e) {
        if (e instanceof McpError) {
            throw e;
        }
        throw asMcpError(e);
    }
}