Users

Delete user

API Reference

Zones

Users

Delete user

client.zones.users.delete(, , ?): void

DELETE/zones/{zoneId}/users/{id}

Delete a user

ParametersExpand Collapse

id: string

params: UserDeleteParams { zoneId }

zoneId: string

Zone ID

Delete user

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.users.delete('id', { zoneId: 'zoneId' });

Delete user

Delete user

ParametersExpand Collapse

Delete user

Returns Examples