Skip to content
Docs
Members
Remove

Remove group member

API Reference
Zones
Groups
Members

Remove group member

client.zones.groups.members.remove(stringuserID, MemberRemoveParams { zoneId, groupId } params, RequestOptionsoptions?): void
DELETE/zones/{zoneId}/groups/{groupId}/members/{userId}

Removes a user from a group managed in Keycard. Membership of externally synced groups is not managed manually. A member is identified by its user's ID.

ParametersExpand Collapse
userID: string
params: MemberRemoveParams { zoneId, groupId }
zoneId: string

Zone ID

groupId: string

Group ID

Remove group member

import KeycardAPI from '@keycardai/api';

const client = new KeycardAPI({
  apiKey: process.env['KEYCARD_API_API_KEY'], // This is the default and can be omitted
});

await client.zones.groups.members.remove('userId', { zoneId: 'zoneId', groupId: 'groupId' });
Returns Examples