Skip to content

Function: previewCleanUpOrganizations() ​

ts
function previewCleanUpOrganizations(
   client, 
   parameters?, 
   options?
): Promise<object[]>;

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

Preview the cleanup of empty organizations, with the same support parameters.

Parameters ​

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

Returns ​

Promise<object[]>