Delete group
Delete group
client.zones.groups.delete(stringgroupID, GroupDeleteParams { zoneId } params, RequestOptionsoptions?): void
DELETE/zones/{zoneId}/groups/{groupId}
Deletes a group and its memberships and role assignments. Groups synced from an external directory can only be deleted by that directory (after external sync is disabled).
Parameters
groupID: string
Delete group
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.delete('groupId', { zoneId: 'zoneId' });