Skip to content

Function: cleanUpOrganizations() ​

ts
function cleanUpOrganizations(
   client, 
   parameters, 
   options?
): Promise<number>;

Defined in: src/serviceDeskServer/api/organizations.ts:99

Deletes empty organizations, optionally delete organizations that have no active users, or are not attached to any projects.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ deleteDetachedOrganizations?: string; deleteOrganizationsWithInactiveUsers?: string; }-
parameters.deleteDetachedOrganizations?stringIf true, in addition, delete organizations that are not attached to any projects.
parameters.deleteOrganizationsWithInactiveUsers?stringIf true, in addition, delete organizations that have no active users.
options?RequestOptions-

Returns ​

Promise<number>