--- title: "GET /api/v1/preferences" method: GET path: "/api/v1/preferences" tags: ["Preferences"] --- # GET /api/v1/preferences `GET /api/v1/preferences` ## Request - Base URL: `https://api.immy.bot` (the document declares no server; this is the origin it was published from) - URL: `https://api.immy.bot/api/v1/preferences` - Auth: none declared ## Response `200` OK - GetPreferencesResponse - `applicationPreferences` ApplicationPreferences - `id` integer - `enableOnboarding` boolean - `enableAzureUserSync` boolean - `defaultEmailBccList` DefaultEmailBccList - `emails` string[], nullable - `enableNiniteIntegration` boolean - `defaultBrandingId` integer, nullable - `enableUserAffinitySync` boolean - `enableSessionEmails` boolean - `defaultBranding` Branding - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `tenantId` integer, nullable - `fromAddress` string, nullable - `startDate` string, date-time, nullable - `endDate` string, date-time, nullable - `ignoreYear` boolean, nullable - `timeFormat` string, nullable - `mascotImgUri` string, nullable - `mascotName` string, nullable - `logoUri` string, nullable - `logoAltText` string, nullable - `backgroundColor` string, nullable - `foregroundColor` string, nullable - `tableHeaderColor` string, nullable - `tableHeaderTextColor` string, nullable - `textColor` string, nullable - `description` string, nullable - `ownerTenant` Tenant - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `name` string, nullable, required - `slug` string, nullable - `parentTenantId` integer, nullable - `parentTenant` Tenant (recursive) - `childTenants` Tenant[], nullable - `tenantId` integer, nullable - `active` boolean - `isMsp` boolean - `azureTenantLink` AzureTenantLink - `immyTenantId` integer, required - `azTenantId` string, nullable, required - `shouldLimitDomains` boolean, required - `azureTenant` AzureTenant - `principalId` string, nullable, required - `consentDetails` AzureTenantConsentDetails, required - … - `azureTenantType` 'Partner' | 'Customer' | 'Standalone', required: The string or integer value may be used. Partner = 1, Customer = 2, Standalone = 3 - `partnerPrincipalId` string, nullable - `infoSyncedFromAzure` AzureTenantInfo - … - `lastGetTenantInfoSyncResult` AzureSyncResult - … - `lastGetUsersSyncResult` AzureSyncResult - … - `parentPartner` AzureTenant (recursive) - `azureTenantLinks` AzureTenantLink[], nullable - `tenant` Tenant (recursive) - `limitToDomains` AzureTenantLinkDomainFilter[], nullable - `immyTenantId` integer, required - `azTenantId` string, nullable, required - `domainName` string, nullable, required - `ownerTenant` Tenant (recursive) - `smtpConfig` SmtpConfig - `tenantId` integer - `port` integer - `host` string, nullable - `enableSSL` boolean - `timeout` integer - `username` string, nullable - `passwordHash` string, nullable - `enabled` boolean - `useAuthentication` boolean - `ownerTenant` Tenant (recursive) - `tenantPreferences` TenantPreferences - `id` integer - `tenantId` integer - `enableOnboarding` boolean - `enableSessionEmails` boolean - `enableOnboardingPatching` boolean - `ownerTenant` Tenant (recursive) - `defaultEmailBccList` DefaultEmailBccList - `emails` string[], nullable - `overwriteExistingDeviceIfOSIsNew` boolean - `requireConsentForExternalSessionProviders` boolean, nullable - `businessHoursStart` string, nullable - `businessHoursEnd` string, nullable - `timeZoneInfoId` string, nullable - `excludeFromCrossTenantDeploymentsAndSchedules` boolean - `enableUserAffinitySync` boolean - `enableImmyBotRemoteControl` boolean, nullable - `enableImmyBotRemoteControlRecording` boolean, nullable - `ownedTenants` Tenant[], nullable - `users` User[], nullable - `id` integer - `userName` string, nullable - `normalizedUserName` string, nullable - `normalizedEmail` string, nullable - `emailConfirmed` boolean - `passwordHash` string, nullable - `securityStamp` string, nullable - `concurrencyStamp` string, nullable - `phoneNumber` string, nullable - `phoneNumberConfirmed` boolean - `twoFactorEnabled` boolean - `lockoutEnd` string, date-time, nullable - `lockoutEnabled` boolean - `accessFailedCount` integer - `expirationDateUTC` string, date-time, nullable - `isAdmin` boolean - `canManageCrossTenantDeployments` boolean - `servicePrincipalId` string, nullable - `personId` integer, nullable - `tenantId` integer - `person` Person - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `tenantId` integer - `azurePrincipalId` string, nullable - `firstName` string, nullable - `lastName` string, nullable - `emailAddress` string, nullable, required - `displayName` string, nullable - `primaryComputers` Computer[], nullable - … - `additionalComputers` ComputerPerson[], nullable - … - `detectedComputerSoftware` DetectedComputerSoftware[], nullable - … - `personSessions` MaintenanceSession[], nullable - … - `user` User (recursive) - `ownerTenant` Tenant (recursive) - `userAffinities` UserAffinity[], nullable - … - `tags` Tag[], nullable - … - `personTags` PersonTag[], nullable - … - `onPremisesSecurityIdentifier` string, nullable - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `accessRequests` AccessRequest[], nullable - … - `ownerTenant` Tenant (recursive) - `isSupportTechnician` boolean - `isMigrated` boolean - `displayName` string, nullable - `email` string, nullable - `azurePrincipalId` string, nullable - `hasManagementAccess` boolean - `createdDeployments` TargetAssignment[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `databaseType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `isCore` boolean - `autoApprove` boolean - `integrationTypeId` string, nullable - `integrationPrompt` string, nullable - `excluded` boolean - `sortOrder` integer - `maintenanceIdentifier` string, nullable, required - `maintenanceType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'ChocolateySoftware' | 'NiniteSoftware' | 'LocalMaintenanceTask' | 'GlobalMaintenanceTask' | 'AgentUpdate': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, ChocolateySoftware = 3, NiniteSoftware = 4, LocalMaintenanceTask = 5, GlobalMaintenanceTask = 6, AgentUpdate = 7 - `onboardingOnly` boolean - `targetEnforcement` 'Required' | 'Optional' | 'Adhoc' | 'Onboarding': The string or integer value may be used. Required = 1, Optional = 2, Adhoc = 3, Onboarding = 4 - `targetType` 'All' | 'Computer' | 'Metascript' | 'Person' | 'AzureGroup' | 'TenantMetascript' | 'AllForTenant' | 'ProviderDeviceGroup' | 'ProviderClientGroup' | 'TenantFilterScript' | 'FilterScript' | 'AllTenants' | 'SpecificTenant' | 'Tag' | 'TenantTag' | 'CloudTag' | 'CloudProviderClientGroup': The string or integer value may be used. All = 1, Computer = 2, Metascript = 5, Person = 7, AzureGroup = 8, TenantMetascript = 20, AllForTenant = 21, ProviderDeviceGroup = 22, ProviderClientGroup = 23, TenantFilterScript = 24, FilterScript = 25, AllTenants = 28, SpecificTenant = 29, Tag = 30, TenantTag = 31, CloudTag = 40, CloudProviderClientGroup = 42 - `targetCategory` 'Computer' | 'Tenant' | 'Person': The string or integer value may be used. Computer = 0, Tenant = 1, Person = 2 - `targetGroupFilter` 'All' | 'Servers' | 'Workstations' | 'PortableDevices' | 'WorkstationsAndPortableDevices' | 'DomainControllers' | 'PrimaryDomainControllers': The string or integer value may be used. All = 0, Servers = 1, Workstations = 2, PortableDevices = 3, WorkstationsAndPortableDevices = 4, DomainControllers = 5, PrimaryDomainControllers = 6 - `target` string, nullable - `tenantId` integer, nullable - `ownerTenant` Tenant (recursive) - `propagateToChildTenants` boolean - `allowAccessToParentTenant` boolean - `providerLinkId` integer, nullable - `providerDeviceGroupType` string, uuid, nullable - `providerClientGroupType` string, uuid, nullable - `providerLinkIdForMaintenanceItem` integer, nullable - `targetName` string, nullable - `providerLink` ProviderLink - … - `notes` TargetAssignmentNotes - … - `visibility` TargetAssignmentVisibility - … - `softwareSemanticVersion` SemanticVersion - … - `softwareSemanticVersionString` string, nullable - `desiredSoftwareState` 'NewerOrEqualVersion' | 'NotPresent' | 'AnyVersion' | 'ThisVersion' | 'OlderOrEqualVersion' | 'LatestVersion' | 'NoAction' | 'UpdateIfFound': The string or integer value may be used. NewerOrEqualVersion = 0, NotPresent = 1, AnyVersion = 2, ThisVersion = 3, OlderOrEqualVersion = 4, LatestVersion = 5, NoAction = 6, UpdateIfFound = 7 - `softwareProviderType` 'Ninite' | 'Chocolatey' | 'Inherent': The string or integer value may be used. Ninite = 1, Chocolatey = 2, Inherent = 3 - `taskParameterValues` object, nullable - `licenseId` integer, nullable - `license` License - … - `maintenanceTaskMode` 'Enforce' | 'Audit' | 'Monitor' | 'NoAction': The string or integer value may be used. Enforce = 0, Audit = 1, Monitor = 2, NoAction = 3 - `maintenanceTaskParameterValues` MaintenanceTaskParameterValue[], nullable - … - `changeRequests` ChangeRequest[], nullable - … - `parameterValueMigrationErrors` string, nullable - `softwareSpecifier` SoftwareSpecifier - … - `maintenanceSpecifier` MaintenanceSpecifier - … - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `softwareId` integer, nullable - `softwareVersionId` integer - `updatedDeployments` TargetAssignment[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `databaseType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `isCore` boolean - `autoApprove` boolean - `integrationTypeId` string, nullable - `integrationPrompt` string, nullable - `excluded` boolean - `sortOrder` integer - `maintenanceIdentifier` string, nullable, required - `maintenanceType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'ChocolateySoftware' | 'NiniteSoftware' | 'LocalMaintenanceTask' | 'GlobalMaintenanceTask' | 'AgentUpdate': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, ChocolateySoftware = 3, NiniteSoftware = 4, LocalMaintenanceTask = 5, GlobalMaintenanceTask = 6, AgentUpdate = 7 - `onboardingOnly` boolean - `targetEnforcement` 'Required' | 'Optional' | 'Adhoc' | 'Onboarding': The string or integer value may be used. Required = 1, Optional = 2, Adhoc = 3, Onboarding = 4 - `targetType` 'All' | 'Computer' | 'Metascript' | 'Person' | 'AzureGroup' | 'TenantMetascript' | 'AllForTenant' | 'ProviderDeviceGroup' | 'ProviderClientGroup' | 'TenantFilterScript' | 'FilterScript' | 'AllTenants' | 'SpecificTenant' | 'Tag' | 'TenantTag' | 'CloudTag' | 'CloudProviderClientGroup': The string or integer value may be used. All = 1, Computer = 2, Metascript = 5, Person = 7, AzureGroup = 8, TenantMetascript = 20, AllForTenant = 21, ProviderDeviceGroup = 22, ProviderClientGroup = 23, TenantFilterScript = 24, FilterScript = 25, AllTenants = 28, SpecificTenant = 29, Tag = 30, TenantTag = 31, CloudTag = 40, CloudProviderClientGroup = 42 - `targetCategory` 'Computer' | 'Tenant' | 'Person': The string or integer value may be used. Computer = 0, Tenant = 1, Person = 2 - `targetGroupFilter` 'All' | 'Servers' | 'Workstations' | 'PortableDevices' | 'WorkstationsAndPortableDevices' | 'DomainControllers' | 'PrimaryDomainControllers': The string or integer value may be used. All = 0, Servers = 1, Workstations = 2, PortableDevices = 3, WorkstationsAndPortableDevices = 4, DomainControllers = 5, PrimaryDomainControllers = 6 - `target` string, nullable - `tenantId` integer, nullable - `ownerTenant` Tenant (recursive) - `propagateToChildTenants` boolean - `allowAccessToParentTenant` boolean - `providerLinkId` integer, nullable - `providerDeviceGroupType` string, uuid, nullable - `providerClientGroupType` string, uuid, nullable - `providerLinkIdForMaintenanceItem` integer, nullable - `targetName` string, nullable - `providerLink` ProviderLink - … - `notes` TargetAssignmentNotes - … - `visibility` TargetAssignmentVisibility - … - `softwareSemanticVersion` SemanticVersion - … - `softwareSemanticVersionString` string, nullable - `desiredSoftwareState` 'NewerOrEqualVersion' | 'NotPresent' | 'AnyVersion' | 'ThisVersion' | 'OlderOrEqualVersion' | 'LatestVersion' | 'NoAction' | 'UpdateIfFound': The string or integer value may be used. NewerOrEqualVersion = 0, NotPresent = 1, AnyVersion = 2, ThisVersion = 3, OlderOrEqualVersion = 4, LatestVersion = 5, NoAction = 6, UpdateIfFound = 7 - `softwareProviderType` 'Ninite' | 'Chocolatey' | 'Inherent': The string or integer value may be used. Ninite = 1, Chocolatey = 2, Inherent = 3 - `taskParameterValues` object, nullable - `licenseId` integer, nullable - `license` License - … - `maintenanceTaskMode` 'Enforce' | 'Audit' | 'Monitor' | 'NoAction': The string or integer value may be used. Enforce = 0, Audit = 1, Monitor = 2, NoAction = 3 - `maintenanceTaskParameterValues` MaintenanceTaskParameterValue[], nullable - … - `changeRequests` ChangeRequest[], nullable - … - `parameterValueMigrationErrors` string, nullable - `softwareSpecifier` SoftwareSpecifier - … - `maintenanceSpecifier` MaintenanceSpecifier - … - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `softwareId` integer, nullable - `softwareVersionId` integer - `createdScripts` Script[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `name` string, nullable, required - `id` integer - `action` string, nullable - `scriptLanguage` 'CommandLine' | 'PowerShell': The string or integer value may be used. CommandLine = 1, PowerShell = 2 - `timeout` integer, nullable - `scriptExecutionContext` 'System' | 'CurrentUser' | 'Metascript' | 'CloudScript': The string or integer value may be used. System = 0, CurrentUser = 1, Metascript = 2, CloudScript = 4 - `scriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `readOnly` boolean - `identifier` string, nullable - `scriptCategory` 'SoftwareDetection' | 'SoftwareVersionAction' | 'MaintenanceTaskSetter' | 'MetascriptDeploymentTarget' | 'FilterScriptDeploymentTarget' | 'DeviceInventory' | 'Function' | 'ImmySystem' | 'DynamicVersions' | 'DownloadInstaller' | 'Module' | 'Preflight' | 'Integration': The string or integer value may be used. SoftwareDetection = 0, SoftwareVersionAction = 2, MaintenanceTaskSetter = 3, MetascriptDeploymentTarget = 4, FilterScriptDeploymentTarget = 5, DeviceInventory = 6, Function = 7, ImmySystem = 8, DynamicVersions = 9, DownloadInstaller = 10, Module = 11, Preflight = 12, Integration = 13 - `outputType` 'Object' | 'Table': The string or integer value may be used. Object = 0, Table = 1 - `publicStorageDownloadUrl` string, nullable - `scriptHash` string, nullable - `scriptCacheName` string, nullable - `variables` object, nullable - `parameters` object, nullable - `parameterOverrides` object, nullable - `dynamicProviderStoreId` string, nullable - `dynamicIntegrationTypeProperties` DynamicIntegrationTypeProperties - … - `providerLinkIdForMaintenanceItem` integer, nullable - `tenantRelationships` TenantScript[], nullable - … - `changeRequests` ChangeRequest[], nullable - … - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `hidden` boolean - `errorActionPreference` 'SilentlyContinue' | 'Stop' | 'Continue' | 'Inquire' | 'Ignore' | 'Suspend' | 'Break': The string or integer value may be used. SilentlyContinue = 0, Stop = 1, Continue = 2, Inquire = 3, Ignore = 4, Suspend = 5, Break = 6 - `skipPreflight` boolean - `skipBusinessHoursCheck` boolean - `filterScriptMode` 'Legacy' | 'Optimized': The string or integer value may be used. Legacy = 0, Optimized = 1 - `dynamicIntegrationType` DynamicIntegrationType - … - `inventoryTaskScript` InventoryTaskScript - … - `authorizedViewers` ScriptViewer[], nullable - … - `visibleToAllTenants` boolean - `tenantId` integer - `ownerTenant` Tenant (recursive) - `updatedScripts` Script[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `name` string, nullable, required - `id` integer - `action` string, nullable - `scriptLanguage` 'CommandLine' | 'PowerShell': The string or integer value may be used. CommandLine = 1, PowerShell = 2 - `timeout` integer, nullable - `scriptExecutionContext` 'System' | 'CurrentUser' | 'Metascript' | 'CloudScript': The string or integer value may be used. System = 0, CurrentUser = 1, Metascript = 2, CloudScript = 4 - `scriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `readOnly` boolean - `identifier` string, nullable - `scriptCategory` 'SoftwareDetection' | 'SoftwareVersionAction' | 'MaintenanceTaskSetter' | 'MetascriptDeploymentTarget' | 'FilterScriptDeploymentTarget' | 'DeviceInventory' | 'Function' | 'ImmySystem' | 'DynamicVersions' | 'DownloadInstaller' | 'Module' | 'Preflight' | 'Integration': The string or integer value may be used. SoftwareDetection = 0, SoftwareVersionAction = 2, MaintenanceTaskSetter = 3, MetascriptDeploymentTarget = 4, FilterScriptDeploymentTarget = 5, DeviceInventory = 6, Function = 7, ImmySystem = 8, DynamicVersions = 9, DownloadInstaller = 10, Module = 11, Preflight = 12, Integration = 13 - `outputType` 'Object' | 'Table': The string or integer value may be used. Object = 0, Table = 1 - `publicStorageDownloadUrl` string, nullable - `scriptHash` string, nullable - `scriptCacheName` string, nullable - `variables` object, nullable - `parameters` object, nullable - `parameterOverrides` object, nullable - `dynamicProviderStoreId` string, nullable - `dynamicIntegrationTypeProperties` DynamicIntegrationTypeProperties - … - `providerLinkIdForMaintenanceItem` integer, nullable - `tenantRelationships` TenantScript[], nullable - … - `changeRequests` ChangeRequest[], nullable - … - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `hidden` boolean - `errorActionPreference` 'SilentlyContinue' | 'Stop' | 'Continue' | 'Inquire' | 'Ignore' | 'Suspend' | 'Break': The string or integer value may be used. SilentlyContinue = 0, Stop = 1, Continue = 2, Inquire = 3, Ignore = 4, Suspend = 5, Break = 6 - `skipPreflight` boolean - `skipBusinessHoursCheck` boolean - `filterScriptMode` 'Legacy' | 'Optimized': The string or integer value may be used. Legacy = 0, Optimized = 1 - `dynamicIntegrationType` DynamicIntegrationType - … - `inventoryTaskScript` InventoryTaskScript - … - `authorizedViewers` ScriptViewer[], nullable - … - `visibleToAllTenants` boolean - `tenantId` integer - `ownerTenant` Tenant (recursive) - `createdPersons` Person[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `tenantId` integer - `azurePrincipalId` string, nullable - `firstName` string, nullable - `lastName` string, nullable - `emailAddress` string, nullable, required - `displayName` string, nullable - `primaryComputers` Computer[], nullable - … - `additionalComputers` ComputerPerson[], nullable - … - `detectedComputerSoftware` DetectedComputerSoftware[], nullable - … - `personSessions` MaintenanceSession[], nullable - … - `user` User (recursive) - `ownerTenant` Tenant (recursive) - `userAffinities` UserAffinity[], nullable - … - `tags` Tag[], nullable - … - `personTags` PersonTag[], nullable - … - `onPremisesSecurityIdentifier` string, nullable - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `accessRequests` AccessRequest[], nullable - … - `updatedPersons` Person[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `tenantId` integer - `azurePrincipalId` string, nullable - `firstName` string, nullable - `lastName` string, nullable - `emailAddress` string, nullable, required - `displayName` string, nullable - `primaryComputers` Computer[], nullable - … - `additionalComputers` ComputerPerson[], nullable - … - `detectedComputerSoftware` DetectedComputerSoftware[], nullable - … - `personSessions` MaintenanceSession[], nullable - … - `user` User (recursive) - `ownerTenant` Tenant (recursive) - `userAffinities` UserAffinity[], nullable - … - `tags` Tag[], nullable - … - `personTags` PersonTag[], nullable - … - `onPremisesSecurityIdentifier` string, nullable - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `accessRequests` AccessRequest[], nullable - … - `createdSoftware` LocalSoftware[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `name` string, nullable - `licenseRequirement` 'None' | 'Required' | 'Optional': The string or integer value may be used. None = 0, Required = 1, Optional = 2 - `installOrder` integer - `hidden` boolean - `softwareTableName` string, nullable - `detectionMethod` 'SoftwareTable' | 'CustomDetectionScript' | 'UpgradeCode' | 'ProductCode': The string or integer value may be used. SoftwareTable = 0, CustomDetectionScript = 1, UpgradeCode = 2, ProductCode = 3 - `softwareTableNameSearchMode` 'Contains' | 'Regex' | 'Traditional': The string or integer value may be used. Contains = 0, Regex = 1, Traditional = 2 - `agentIntegrationTypeId` string, uuid, nullable - `detectionScript` Script - … - `detectionScriptId` integer, nullable - `detectionScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `downloadInstallerScript` Script - … - `downloadInstallerScriptId` integer, nullable - `downloadInstallerScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `upgradeCode` string, nullable - `maintenanceTask` MaintenanceTask - … - `maintenanceTaskId` integer, nullable - `maintenanceTaskType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `notes` string, nullable - `rebootNeeded` boolean - `repairType` 'None' | 'UninstallInstall' | 'InstallOver' | 'CustomScript': The string or integer value may be used. None = 0, UninstallInstall = 1, InstallOver = 2, CustomScript = 3 - `repairScript` Script - … - `repairScriptId` integer, nullable - `repairScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `softwareIconMediaId` integer, nullable - `recommended` boolean - `chocoProviderSoftwareId` string, nullable - `niniteProviderSoftwareId` string, nullable - `maintenanceType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'ChocolateySoftware' | 'NiniteSoftware' | 'LocalMaintenanceTask' | 'GlobalMaintenanceTask' | 'AgentUpdate': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, ChocolateySoftware = 3, NiniteSoftware = 4, LocalMaintenanceTask = 5, GlobalMaintenanceTask = 6, AgentUpdate = 7 - `useSoftwareTableDetection` boolean - `installScriptId` integer, nullable - `installScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `installScript` Script - … - `testScriptId` integer, nullable - `testScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `testScript` Script - … - `upgradeScriptId` integer, nullable - `upgradeScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `upgradeScript` Script - … - `uninstallScriptId` integer, nullable - `uninstallScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `uninstallScript` Script - … - `postInstallScriptId` integer, nullable - `postInstallScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `postInstallScript` Script - … - `postUninstallScriptId` integer, nullable - `postUninstallScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `postUninstallScript` Script - … - `testRequired` boolean - `testFailedError` string, nullable - `upgradeStrategy` 'None' | 'UninstallInstall' | 'InstallOver' | 'UpgradeScript': The string or integer value may be used. None = 0, UninstallInstall = 1, InstallOver = 2, UpgradeScript = 3 - `licenseType` 'None' | 'LicenseFile' | 'Key': The string or integer value may be used. None = 0, LicenseFile = 1, Key = 2 - `licenseDescription` string, nullable - `useDynamicVersions` boolean - `dynamicVersionsScriptId` integer, nullable - `dynamicVersionsScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `dynamicVersionsScript` Script - … - `relativeCacheSourcePath` string, uuid - `maintenanceSpecifier` MaintenanceSpecifier - … - `id` integer - `ownerTenantId` integer, nullable - `tenantId` integer - `ownerTenant` Tenant (recursive) - `authorizedViewers` LocalSoftwareViewer[], nullable - … - `visibleToAllTenants` boolean - `softwareType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'Chocolatey' | 'Ninite': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, Chocolatey = 3, Ninite = 4 - `identifier` string, nullable - `tenantSoftware` TenantSoftware[], nullable - … - `softwareVersions` LocalSoftwareVersion[], nullable - … - `softwarePrerequisites` SoftwarePrerequisite[], nullable - … - `softwareIcon` Media - … - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `customAuditProperties` AuditPropertyChange[], nullable - … - `updatedSoftware` LocalSoftware[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `name` string, nullable - `licenseRequirement` 'None' | 'Required' | 'Optional': The string or integer value may be used. None = 0, Required = 1, Optional = 2 - `installOrder` integer - `hidden` boolean - `softwareTableName` string, nullable - `detectionMethod` 'SoftwareTable' | 'CustomDetectionScript' | 'UpgradeCode' | 'ProductCode': The string or integer value may be used. SoftwareTable = 0, CustomDetectionScript = 1, UpgradeCode = 2, ProductCode = 3 - `softwareTableNameSearchMode` 'Contains' | 'Regex' | 'Traditional': The string or integer value may be used. Contains = 0, Regex = 1, Traditional = 2 - `agentIntegrationTypeId` string, uuid, nullable - `detectionScript` Script - … - `detectionScriptId` integer, nullable - `detectionScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `downloadInstallerScript` Script - … - `downloadInstallerScriptId` integer, nullable - `downloadInstallerScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `upgradeCode` string, nullable - `maintenanceTask` MaintenanceTask - … - `maintenanceTaskId` integer, nullable - `maintenanceTaskType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `notes` string, nullable - `rebootNeeded` boolean - `repairType` 'None' | 'UninstallInstall' | 'InstallOver' | 'CustomScript': The string or integer value may be used. None = 0, UninstallInstall = 1, InstallOver = 2, CustomScript = 3 - `repairScript` Script - … - `repairScriptId` integer, nullable - `repairScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `softwareIconMediaId` integer, nullable - `recommended` boolean - `chocoProviderSoftwareId` string, nullable - `niniteProviderSoftwareId` string, nullable - `maintenanceType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'ChocolateySoftware' | 'NiniteSoftware' | 'LocalMaintenanceTask' | 'GlobalMaintenanceTask' | 'AgentUpdate': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, ChocolateySoftware = 3, NiniteSoftware = 4, LocalMaintenanceTask = 5, GlobalMaintenanceTask = 6, AgentUpdate = 7 - `useSoftwareTableDetection` boolean - `installScriptId` integer, nullable - `installScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `installScript` Script - … - `testScriptId` integer, nullable - `testScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `testScript` Script - … - `upgradeScriptId` integer, nullable - `upgradeScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `upgradeScript` Script - … - `uninstallScriptId` integer, nullable - `uninstallScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `uninstallScript` Script - … - `postInstallScriptId` integer, nullable - `postInstallScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `postInstallScript` Script - … - `postUninstallScriptId` integer, nullable - `postUninstallScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `postUninstallScript` Script - … - `testRequired` boolean - `testFailedError` string, nullable - `upgradeStrategy` 'None' | 'UninstallInstall' | 'InstallOver' | 'UpgradeScript': The string or integer value may be used. None = 0, UninstallInstall = 1, InstallOver = 2, UpgradeScript = 3 - `licenseType` 'None' | 'LicenseFile' | 'Key': The string or integer value may be used. None = 0, LicenseFile = 1, Key = 2 - `licenseDescription` string, nullable - `useDynamicVersions` boolean - `dynamicVersionsScriptId` integer, nullable - `dynamicVersionsScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `dynamicVersionsScript` Script - … - `relativeCacheSourcePath` string, uuid - `maintenanceSpecifier` MaintenanceSpecifier - … - `id` integer - `ownerTenantId` integer, nullable - `tenantId` integer - `ownerTenant` Tenant (recursive) - `authorizedViewers` LocalSoftwareViewer[], nullable - … - `visibleToAllTenants` boolean - `softwareType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'Chocolatey' | 'Ninite': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, Chocolatey = 3, Ninite = 4 - `identifier` string, nullable - `tenantSoftware` TenantSoftware[], nullable - … - `softwareVersions` LocalSoftwareVersion[], nullable - … - `softwarePrerequisites` SoftwarePrerequisite[], nullable - … - `softwareIcon` Media - … - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `customAuditProperties` AuditPropertyChange[], nullable - … - `createdSoftwareVersions` LocalSoftwareVersion[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `displayName` string, nullable - `displayVersion` string, nullable - `semanticVersion` SemanticVersion, required - … - `semanticVersionString` string, nullable - `testRequired` boolean - `url` string, nullable - `blobName` string, nullable - `relativeCacheSourcePath` string, nullable - `installerFile` string, nullable - `testFailedError` string, nullable - `packageHash` string, nullable - `productCode` string, nullable - `upgradeStrategy` 'None' | 'UninstallInstall' | 'InstallOver' | 'UpgradeScript': The string or integer value may be used. None = 0, UninstallInstall = 1, InstallOver = 2, UpgradeScript = 3 - `packageType` 'None' | 'EntireFolder' | 'InstallerFile': The string or integer value may be used. None = 0, EntireFolder = 1, InstallerFile = 2 - `installerType` 'None' | 'File' | 'Url': The string or integer value may be used. None = 0, File = 1, Url = 2 - `maintenanceType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'ChocolateySoftware' | 'NiniteSoftware' | 'LocalMaintenanceTask' | 'GlobalMaintenanceTask' | 'AgentUpdate': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, ChocolateySoftware = 3, NiniteSoftware = 4, LocalMaintenanceTask = 5, GlobalMaintenanceTask = 6, AgentUpdate = 7 - `numActionSuccesses` integer - `numActionFailures` integer - `lastResult` 'Pending' | 'Success' | 'Failed' | 'Cancelled' | 'Indeterminable' | 'Resolved': The string or integer value may be used. Pending = 0, Success = 1, Failed = 2, Cancelled = 3, Indeterminable = 4, Resolved = 5 - `notes` string, nullable - `installScriptId` integer, nullable - `installScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `installScript` Script - … - `testScriptId` integer, nullable - `testScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `testScript` Script - … - `upgradeScriptId` integer, nullable - `upgradeScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `upgradeScript` Script - … - `uninstallScriptId` integer, nullable - `uninstallScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `uninstallScript` Script - … - `postInstallScriptId` integer, nullable - `postInstallScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `postInstallScript` Script - … - `postUninstallScriptId` integer, nullable - `postUninstallScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `postUninstallScript` Script - … - `licenseType` 'None' | 'LicenseFile' | 'Key': The string or integer value may be used. None = 0, LicenseFile = 1, Key = 2 - `architecture` 'X86' | 'X64' | 'Arm' | 'Arm64' | 'Wasm' | 'S390x' | 'LoongArch64' | 'Armv6' | 'Ppc64le' | 'RiscV64': The string or integer value may be used. X86 = 0, X64 = 1, Arm = 2, Arm64 = 3, Wasm = 4, S390x = 5, LoongArch64 = 6, Armv6 = 7, Ppc64le = 8, RiscV64 = 9 - `dependsOnSemanticVersion` SemanticVersion - … - `deprecatedIdField` integer, nullable - `softwareId` integer - `software` LocalSoftware - … - `softwareType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'Chocolatey' | 'Ninite': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, Chocolatey = 3, Ninite = 4 - `softwareIdentifier` string, nullable - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `updatedSoftwareVersions` LocalSoftwareVersion[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `displayName` string, nullable - `displayVersion` string, nullable - `semanticVersion` SemanticVersion, required - … - `semanticVersionString` string, nullable - `testRequired` boolean - `url` string, nullable - `blobName` string, nullable - `relativeCacheSourcePath` string, nullable - `installerFile` string, nullable - `testFailedError` string, nullable - `packageHash` string, nullable - `productCode` string, nullable - `upgradeStrategy` 'None' | 'UninstallInstall' | 'InstallOver' | 'UpgradeScript': The string or integer value may be used. None = 0, UninstallInstall = 1, InstallOver = 2, UpgradeScript = 3 - `packageType` 'None' | 'EntireFolder' | 'InstallerFile': The string or integer value may be used. None = 0, EntireFolder = 1, InstallerFile = 2 - `installerType` 'None' | 'File' | 'Url': The string or integer value may be used. None = 0, File = 1, Url = 2 - `maintenanceType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'ChocolateySoftware' | 'NiniteSoftware' | 'LocalMaintenanceTask' | 'GlobalMaintenanceTask' | 'AgentUpdate': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, ChocolateySoftware = 3, NiniteSoftware = 4, LocalMaintenanceTask = 5, GlobalMaintenanceTask = 6, AgentUpdate = 7 - `numActionSuccesses` integer - `numActionFailures` integer - `lastResult` 'Pending' | 'Success' | 'Failed' | 'Cancelled' | 'Indeterminable' | 'Resolved': The string or integer value may be used. Pending = 0, Success = 1, Failed = 2, Cancelled = 3, Indeterminable = 4, Resolved = 5 - `notes` string, nullable - `installScriptId` integer, nullable - `installScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `installScript` Script - … - `testScriptId` integer, nullable - `testScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `testScript` Script - … - `upgradeScriptId` integer, nullable - `upgradeScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `upgradeScript` Script - … - `uninstallScriptId` integer, nullable - `uninstallScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `uninstallScript` Script - … - `postInstallScriptId` integer, nullable - `postInstallScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `postInstallScript` Script - … - `postUninstallScriptId` integer, nullable - `postUninstallScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `postUninstallScript` Script - … - `licenseType` 'None' | 'LicenseFile' | 'Key': The string or integer value may be used. None = 0, LicenseFile = 1, Key = 2 - `architecture` 'X86' | 'X64' | 'Arm' | 'Arm64' | 'Wasm' | 'S390x' | 'LoongArch64' | 'Armv6' | 'Ppc64le' | 'RiscV64': The string or integer value may be used. X86 = 0, X64 = 1, Arm = 2, Arm64 = 3, Wasm = 4, S390x = 5, LoongArch64 = 6, Armv6 = 7, Ppc64le = 8, RiscV64 = 9 - `dependsOnSemanticVersion` SemanticVersion - … - `deprecatedIdField` integer, nullable - `softwareId` integer - `software` LocalSoftware - … - `softwareType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'Chocolatey' | 'Ninite': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, Chocolatey = 3, Ninite = 4 - `softwareIdentifier` string, nullable - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `createdLicenses` License[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `name` string, nullable, required - `licenseValue` string, nullable - `softwareType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'Chocolatey' | 'Ninite': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, Chocolatey = 3, Ninite = 4 - `softwareIdentifier` string, nullable, required - `softwareName` string, nullable, required - `semanticVersion` SemanticVersion - … - `restrictToMajorVersion` boolean - `tenantId` integer, nullable - `ownerTenant` Tenant (recursive) - `targetAssignments` TargetAssignment[], nullable - … - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `updatedLicenses` License[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `name` string, nullable, required - `licenseValue` string, nullable - `softwareType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'Chocolatey' | 'Ninite': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, Chocolatey = 3, Ninite = 4 - `softwareIdentifier` string, nullable, required - `softwareName` string, nullable, required - `semanticVersion` SemanticVersion - … - `restrictToMajorVersion` boolean - `tenantId` integer, nullable - `ownerTenant` Tenant (recursive) - `targetAssignments` TargetAssignment[], nullable - … - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `createdMaintenanceTasks` MaintenanceTask[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `name` string, nullable, required - `onboardingOnly` boolean - `ignoreDuringAutomaticOnboarding` boolean - `maintenanceTaskCategory` 'Computer' | 'Tenant' | 'Person': The string or integer value may be used. Computer = 0, Tenant = 1, Person = 2 - `databaseType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `executeSerially` boolean - `testEnabled` boolean - `testScriptId` integer, nullable - `testScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `getEnabled` boolean - `getScriptId` integer, nullable - `getScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `setEnabled` boolean - `setScriptId` integer, nullable - `setScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `recommended` boolean - `isConfigurationTask` boolean - `iconMediaId` integer, nullable - `notes` string, nullable - `useScriptParamBlock` boolean - `supersededByTaskId` integer, nullable - `supersededByTaskType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `supersededByTaskMigrationScriptId` integer, nullable - `supersededByTaskMigrationScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `integrationTypeId` string, uuid, nullable - `parameters` MaintenanceTaskParameter[], nullable - … - `tenantRelationships` TenantMaintenanceTask[], nullable - … - `setScript` Script - … - `getScript` Script - … - `testScript` Script - … - `icon` Media - … - `maintenanceType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'ChocolateySoftware' | 'NiniteSoftware' | 'LocalMaintenanceTask' | 'GlobalMaintenanceTask' | 'AgentUpdate': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, ChocolateySoftware = 3, NiniteSoftware = 4, LocalMaintenanceTask = 5, GlobalMaintenanceTask = 6, AgentUpdate = 7 - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `tenantId` integer - `ownerTenant` Tenant (recursive) - `authorizedViewers` MaintenanceTaskViewer[], nullable - … - `visibleToAllTenants` boolean - `updatedMaintenanceTasks` MaintenanceTask[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `name` string, nullable, required - `onboardingOnly` boolean - `ignoreDuringAutomaticOnboarding` boolean - `maintenanceTaskCategory` 'Computer' | 'Tenant' | 'Person': The string or integer value may be used. Computer = 0, Tenant = 1, Person = 2 - `databaseType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `executeSerially` boolean - `testEnabled` boolean - `testScriptId` integer, nullable - `testScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `getEnabled` boolean - `getScriptId` integer, nullable - `getScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `setEnabled` boolean - `setScriptId` integer, nullable - `setScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `recommended` boolean - `isConfigurationTask` boolean - `iconMediaId` integer, nullable - `notes` string, nullable - `useScriptParamBlock` boolean - `supersededByTaskId` integer, nullable - `supersededByTaskType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `supersededByTaskMigrationScriptId` integer, nullable - `supersededByTaskMigrationScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `integrationTypeId` string, uuid, nullable - `parameters` MaintenanceTaskParameter[], nullable - … - `tenantRelationships` TenantMaintenanceTask[], nullable - … - `setScript` Script - … - `getScript` Script - … - `testScript` Script - … - `icon` Media - … - `maintenanceType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'ChocolateySoftware' | 'NiniteSoftware' | 'LocalMaintenanceTask' | 'GlobalMaintenanceTask' | 'AgentUpdate': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, ChocolateySoftware = 3, NiniteSoftware = 4, LocalMaintenanceTask = 5, GlobalMaintenanceTask = 6, AgentUpdate = 7 - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `tenantId` integer - `ownerTenant` Tenant (recursive) - `authorizedViewers` MaintenanceTaskViewer[], nullable - … - `visibleToAllTenants` boolean - `createdSchedules` Schedule[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `name` string, nullable - `target` string, nullable - `targetName` string, nullable - `targetType` 'All' | 'Computer' | 'Metascript' | 'Person' | 'AzureGroup' | 'TenantMetascript' | 'AllForTenant' | 'ProviderDeviceGroup' | 'ProviderClientGroup' | 'TenantFilterScript' | 'FilterScript' | 'AllTenants' | 'SpecificTenant' | 'Tag' | 'TenantTag' | 'CloudTag' | 'CloudProviderClientGroup': The string or integer value may be used. All = 1, Computer = 2, Metascript = 5, Person = 7, AzureGroup = 8, TenantMetascript = 20, AllForTenant = 21, ProviderDeviceGroup = 22, ProviderClientGroup = 23, TenantFilterScript = 24, FilterScript = 25, AllTenants = 28, SpecificTenant = 29, Tag = 30, TenantTag = 31, CloudTag = 40, CloudProviderClientGroup = 42 - `targetGroupFilter` 'All' | 'Servers' | 'Workstations' | 'PortableDevices' | 'WorkstationsAndPortableDevices' | 'DomainControllers' | 'PrimaryDomainControllers': The string or integer value may be used. All = 0, Servers = 1, Workstations = 2, PortableDevices = 3, WorkstationsAndPortableDevices = 4, DomainControllers = 5, PrimaryDomainControllers = 6 - `providerDeviceGroupType` string, uuid, nullable - `providerClientGroupType` string, uuid, nullable - `providerLinkId` integer, nullable - `tenantId` integer, nullable - `propagateToChildTenants` boolean - `allowAccessToParentTenant` boolean - `targetCategory` 'Computer' | 'Tenant' | 'Person': The string or integer value may be used. Computer = 0, Tenant = 1, Person = 2 - `maintenanceType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'ChocolateySoftware' | 'NiniteSoftware' | 'LocalMaintenanceTask' | 'GlobalMaintenanceTask' | 'AgentUpdate': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, ChocolateySoftware = 3, NiniteSoftware = 4, LocalMaintenanceTask = 5, GlobalMaintenanceTask = 6, AgentUpdate = 7 - `maintenanceIdentifier` string, nullable - `disabled` boolean - `day` integer, nullable - `sendDetectionEmail` boolean - `sendDetectionEmailWhenAllActionsAreCompliant` boolean - `sendFollowUpEmail` boolean - `sendFollowUpOnlyIfActionNeeded` boolean - `showRunNowButton` boolean - `showPostponeButton` boolean - `rebootPreference` 'Normal' | 'Suppress' | 'Prompt' | 'Force': The string or integer value may be used. Normal = 0, Suppress = 1, Prompt = 2, Force = -1 - `promptTimeoutAction` 'Reboot' | 'Suppress' | 'FailSession': The string or integer value may be used. Reboot = 0, Suppress = 1, FailSession = 2 - `autoConsentToReboots` boolean - `promptTimeoutMinutes` integer - `applyWindowsUpdates` boolean - `showMaintenanceActions` boolean - `allowAccessToMSPResources` boolean - `timeZoneInfoId` string, nullable - `time` string, nullable - `maintenanceTime` string, nullable - `customCronExpression` string, nullable - `offlineBehavior` 'Skip' | 'ApplyOnConnect': The string or integer value may be used. Skip = 1, ApplyOnConnect = 2 - `suppressRebootsDuringBusinessHours` boolean - `useComputersTimezoneForExecution` boolean - `scheduleExecutionAfterActiveHours` boolean - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `ownerTenant` Tenant (recursive) - `providerLink` ProviderLink - … - `updatedSchedules` Schedule[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `name` string, nullable - `target` string, nullable - `targetName` string, nullable - `targetType` 'All' | 'Computer' | 'Metascript' | 'Person' | 'AzureGroup' | 'TenantMetascript' | 'AllForTenant' | 'ProviderDeviceGroup' | 'ProviderClientGroup' | 'TenantFilterScript' | 'FilterScript' | 'AllTenants' | 'SpecificTenant' | 'Tag' | 'TenantTag' | 'CloudTag' | 'CloudProviderClientGroup': The string or integer value may be used. All = 1, Computer = 2, Metascript = 5, Person = 7, AzureGroup = 8, TenantMetascript = 20, AllForTenant = 21, ProviderDeviceGroup = 22, ProviderClientGroup = 23, TenantFilterScript = 24, FilterScript = 25, AllTenants = 28, SpecificTenant = 29, Tag = 30, TenantTag = 31, CloudTag = 40, CloudProviderClientGroup = 42 - `targetGroupFilter` 'All' | 'Servers' | 'Workstations' | 'PortableDevices' | 'WorkstationsAndPortableDevices' | 'DomainControllers' | 'PrimaryDomainControllers': The string or integer value may be used. All = 0, Servers = 1, Workstations = 2, PortableDevices = 3, WorkstationsAndPortableDevices = 4, DomainControllers = 5, PrimaryDomainControllers = 6 - `providerDeviceGroupType` string, uuid, nullable - `providerClientGroupType` string, uuid, nullable - `providerLinkId` integer, nullable - `tenantId` integer, nullable - `propagateToChildTenants` boolean - `allowAccessToParentTenant` boolean - `targetCategory` 'Computer' | 'Tenant' | 'Person': The string or integer value may be used. Computer = 0, Tenant = 1, Person = 2 - `maintenanceType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'ChocolateySoftware' | 'NiniteSoftware' | 'LocalMaintenanceTask' | 'GlobalMaintenanceTask' | 'AgentUpdate': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, ChocolateySoftware = 3, NiniteSoftware = 4, LocalMaintenanceTask = 5, GlobalMaintenanceTask = 6, AgentUpdate = 7 - `maintenanceIdentifier` string, nullable - `disabled` boolean - `day` integer, nullable - `sendDetectionEmail` boolean - `sendDetectionEmailWhenAllActionsAreCompliant` boolean - `sendFollowUpEmail` boolean - `sendFollowUpOnlyIfActionNeeded` boolean - `showRunNowButton` boolean - `showPostponeButton` boolean - `rebootPreference` 'Normal' | 'Suppress' | 'Prompt' | 'Force': The string or integer value may be used. Normal = 0, Suppress = 1, Prompt = 2, Force = -1 - `promptTimeoutAction` 'Reboot' | 'Suppress' | 'FailSession': The string or integer value may be used. Reboot = 0, Suppress = 1, FailSession = 2 - `autoConsentToReboots` boolean - `promptTimeoutMinutes` integer - `applyWindowsUpdates` boolean - `showMaintenanceActions` boolean - `allowAccessToMSPResources` boolean - `timeZoneInfoId` string, nullable - `time` string, nullable - `maintenanceTime` string, nullable - `customCronExpression` string, nullable - `offlineBehavior` 'Skip' | 'ApplyOnConnect': The string or integer value may be used. Skip = 1, ApplyOnConnect = 2 - `suppressRebootsDuringBusinessHours` boolean - `useComputersTimezoneForExecution` boolean - `scheduleExecutionAfterActiveHours` boolean - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `ownerTenant` Tenant (recursive) - `providerLink` ProviderLink - … - `createdProviderLinks` ProviderLink[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `disabled` boolean - `disabledOrUnhealthy` boolean - `healthStatus` 'Unhealthy' | 'Degraded' | 'Healthy': The string or integer value may be used. Unhealthy = 0, Degraded = 1, Healthy = 2 - `healthStatusMessage` string, nullable - `unhealthyCount` integer - `tenantId` integer - `name` string, nullable, required - `runScriptPriority` integer - `providerTypeFormData` unknown - `providerTypeId` string, uuid - `ownerTenant` Tenant (recursive) - `providerClients` ProviderClient[], nullable - … - `schedules` Schedule[], nullable - … - `targetAssignments` TargetAssignment[], nullable - … - `agents` ProviderAgent[], nullable - … - `providersLinkedFromThisProvider` ProviderLinkCrossReference[], nullable - … - `linkedFromProviders` ProviderLinkCrossReference[], nullable - … - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `excludedCapabilities` string[], nullable - `providerInternalData` ProviderLinkInternalData - … - `updatedProviderLinks` ProviderLink[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `disabled` boolean - `disabledOrUnhealthy` boolean - `healthStatus` 'Unhealthy' | 'Degraded' | 'Healthy': The string or integer value may be used. Unhealthy = 0, Degraded = 1, Healthy = 2 - `healthStatusMessage` string, nullable - `unhealthyCount` integer - `tenantId` integer - `name` string, nullable, required - `runScriptPriority` integer - `providerTypeFormData` unknown - `providerTypeId` string, uuid - `ownerTenant` Tenant (recursive) - `providerClients` ProviderClient[], nullable - … - `schedules` Schedule[], nullable - … - `targetAssignments` TargetAssignment[], nullable - … - `agents` ProviderAgent[], nullable - … - `providersLinkedFromThisProvider` ProviderLinkCrossReference[], nullable - … - `linkedFromProviders` ProviderLinkCrossReference[], nullable - … - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `excludedCapabilities` string[], nullable - `providerInternalData` ProviderLinkInternalData - … - `createdBrandings` Branding[], nullable - `updatedBrandings` Branding[], nullable - `createdMedia` Media[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `databaseType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `name` string, nullable - `fileName` string, nullable - `mimeType` string, nullable - `packageHash` string, nullable - `blobReference` string, nullable - `relativeCacheSourcePath` string, nullable - `category` 'None' | 'SoftwareIcon': The string or integer value may be used. None = 0, SoftwareIcon = 1 - `localSoftware` LocalSoftware[], nullable - … - `globalSoftware` GlobalSoftware[], nullable - … - `iconForMaintenanceTasks` MaintenanceTask[], nullable - … - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `dynamicIntegrationTypes` DynamicIntegrationType[], nullable - … - `tenantRelationships` TenantMedia[], nullable - … - `authorizedViewers` MediaViewer[], nullable - … - `visibleToAllTenants` boolean - `tenantId` integer - `ownerTenant` Tenant (recursive) - `updatedMedia` Media[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `databaseType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `name` string, nullable - `fileName` string, nullable - `mimeType` string, nullable - `packageHash` string, nullable - `blobReference` string, nullable - `relativeCacheSourcePath` string, nullable - `category` 'None' | 'SoftwareIcon': The string or integer value may be used. None = 0, SoftwareIcon = 1 - `localSoftware` LocalSoftware[], nullable - … - `globalSoftware` GlobalSoftware[], nullable - … - `iconForMaintenanceTasks` MaintenanceTask[], nullable - … - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `dynamicIntegrationTypes` DynamicIntegrationType[], nullable - … - `tenantRelationships` TenantMedia[], nullable - … - `authorizedViewers` MediaViewer[], nullable - … - `visibleToAllTenants` boolean - `tenantId` integer - `ownerTenant` Tenant (recursive) - `createdTags` Tag[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `name` string, nullable - `description` string, nullable - `color` string, nullable - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `computers` Computer[], nullable - … - `computerTags` ComputerTag[], nullable - … - `tenantTags` TenantTag[], nullable - … - `tenants` Tenant[], nullable - `persons` Person[], nullable - … - `personTags` PersonTag[], nullable - … - `tenantRelationships` TenantTagAuthorization[], nullable - … - `tenantId` integer - `ownerTenant` Tenant (recursive) - `authorizedViewers` TagViewer[], nullable - … - `visibleToAllTenants` boolean - `updatedTags` Tag[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `name` string, nullable - `description` string, nullable - `color` string, nullable - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `computers` Computer[], nullable - … - `computerTags` ComputerTag[], nullable - … - `tenantTags` TenantTag[], nullable - … - `tenants` Tenant[], nullable - `persons` Person[], nullable - … - `personTags` PersonTag[], nullable - … - `tenantRelationships` TenantTagAuthorization[], nullable - … - `tenantId` integer - `ownerTenant` Tenant (recursive) - `authorizedViewers` TagViewer[], nullable - … - `visibleToAllTenants` boolean - `createdRecommendedTargetAssignmentApprovals` RecommendedTargetAssignmentApproval[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `globalTargetAssignmentId` integer - `approved` boolean - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `updatedRecommendedTargetAssignmentApprovals` RecommendedTargetAssignmentApproval[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `globalTargetAssignmentId` integer - `approved` boolean - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `createdMaintenanceSessions` MaintenanceSession[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `jobId` string, nullable - `computerId` integer, nullable - `tenantId` integer, nullable - `personId` integer, nullable - `scheduledId` integer, nullable - `sessionStatus` 'Passed' | 'Running' | 'Failed' | 'Created' | 'Cancelled' | 'Postponed' | 'Pending' | 'PartialPassed' | 'PendingConnectivity' | 'Missed' | 'MaxTrackedDevicesPerMonthExceeded' | 'PendingPreflight' | 'PendingEphemeralAgentConnection' | 'MaintenanceForTrackableDevicesNotAllowed': The string or integer value may be used. Passed = 0, Running = 1, Failed = 2, Created = 3, Cancelled = 4, Postponed = 5, Pending = 6, PartialPassed = 7, PendingConnectivity = 8, Missed = 9, MaxTrackedDevicesPerMonthExceeded = 10, PendingPreflight = 11, PendingEphemeralAgentConnection = 12, MaintenanceForTrackableDevicesNotAllowed = 13 - `onboarding` boolean - `scheduledExecutionDate` string, date-time, nullable - `duration` string, date-span, nullable - `usingActiveHours` boolean - `fullMaintenance` boolean - `jobArgs` SessionJobArgs - … - `activeSession` ActiveSession - … - `maintenanceActions` MaintenanceAction[], nullable - … - `stages` MaintenanceSessionStage[], nullable - … - `logs` SessionLog[], nullable - … - `phases` SessionPhase[], nullable - … - `activities` MaintenanceActionActivity[], nullable - … - `computer` Computer - … - `person` Person - … - `ownerTenant` Tenant (recursive) - `createdByUser` User (recursive) - `accessRequestAcknowledgements` AccessRequest[], nullable - `id` integer - `personId` integer - `dateRequestedUTC` string, date-time - `dateAcknowledgedUTC` string, date-time, nullable - `acknowledgedByUserId` integer, nullable - `granted` boolean - `isAdmin` boolean, nullable - `expirationTime` 'OneHour' | 'OneDay' | 'Indefinite' | 'ThreeDays': The string or integer value may be used. OneHour = 1, OneDay = 2, Indefinite = 3, ThreeDays = 4 - `message` string, nullable - `person` Person - … - `acknowledgedByUser` User (recursive) - `userRoles` UserRole[], nullable - `userId` integer - `roleId` integer - `user` User (recursive) - `role` Role - … - `createdBy` integer, nullable - `updatedBy` integer, nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `auditObjectName` string, nullable - `userRoleAssignments` UserRoleAssignment[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `userId` integer, nullable - `groupId` integer, nullable - `roleId` integer - `isAllow` boolean - `assignmentType` 'Owner' | 'Msp' | 'TenantTag' | 'SpecificTenant' | 'UserTenant' | 'TagResource' | 'SpecificResource' | 'CategoryResource': The string or integer value may be used. Owner = 1, Msp = 2, TenantTag = 3, SpecificTenant = 4, UserTenant = 5, TagResource = 6, SpecificResource = 7, CategoryResource = 8 - `user` User (recursive) - `group` Group - … - `role` Role - … - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `auditObjectName` string, nullable - `auditObjectType` string, nullable - `userGroups` UserGroup[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `userId` integer - `groupId` integer - `user` User (recursive) - `group` Group - … - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `auditObjectName` string, nullable - `silencedNotifications` UserSilencedNotification[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `id` integer - `userId` integer - `notificationType` 'ProviderHealth' | 'AccessRequested' | 'LargeScriptOutput' | 'UnacknowledgedDeployments' | 'UpdateInstance' | 'ProviderAgentsRequiringManualDecision' | 'AzureTenantProblems' | 'AzureCustomerPreconsentFailed' | 'AzureMultiCustomerPreconsentFailed' | 'ChangeRequestCreatedOrUpdated' | 'ChangeRequestAcknowledged' | 'ProviderRecommendation' | 'FeatureUsageExceeded' | 'TenantDeletion' | 'ScheduleFailed': The string or integer value may be used. ProviderHealth = 1, AccessRequested = 2, LargeScriptOutput = 3, UnacknowledgedDeployments = 4, UpdateInstance = 5, ProviderAgentsRequiringManualDecision = 6, AzureTenantProblems = 7, AzureCustomerPreconsentFailed = 8, AzureMultiCustomerPreconsentFailed = 9, ChangeRequestCreatedOrUpdated = 10, ChangeRequestAcknowledged = 11, ProviderRecommendation = 12, FeatureUsageExceeded = 13, TenantDeletion = 14, ScheduleFailed = 15 - `notificationObjectId` string, nullable - `user` User (recursive) - `createdChangeRequests` ChangeRequest[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `objectType` 'TargetAssignment' | 'Script': The string or integer value may be used. TargetAssignment = 1, Script = 2 - `targetAssignmentId` integer, nullable - `scriptId` integer, nullable - `newValuesJson` unknown - `state` 'WaitingForApproval' | 'Denied' | 'ApprovedAndApplied' | 'NeedsAttention': The string or integer value may be used. WaitingForApproval = 1, Denied = 2, ApprovedAndApplied = 3, NeedsAttention = 4 - `acknowledgedByUserId` integer, nullable - `acknowledgedByUserName` string, nullable - `comments` ChangeRequestComment[], nullable - … - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `targetAssignment` TargetAssignment - … - `script` Script - … - `ownerTenant` Tenant (recursive) - `tenantId` integer - `updatedChangeRequests` ChangeRequest[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `objectType` 'TargetAssignment' | 'Script': The string or integer value may be used. TargetAssignment = 1, Script = 2 - `targetAssignmentId` integer, nullable - `scriptId` integer, nullable - `newValuesJson` unknown - `state` 'WaitingForApproval' | 'Denied' | 'ApprovedAndApplied' | 'NeedsAttention': The string or integer value may be used. WaitingForApproval = 1, Denied = 2, ApprovedAndApplied = 3, NeedsAttention = 4 - `acknowledgedByUserId` integer, nullable - `acknowledgedByUserName` string, nullable - `comments` ChangeRequestComment[], nullable - … - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `targetAssignment` TargetAssignment - … - `script` Script - … - `ownerTenant` Tenant (recursive) - `tenantId` integer - `createdChangeRequestComments` ChangeRequestComment[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `comment` string, nullable - `commentedByUsername` string, nullable - `changeRequestId` integer - `changeRequest` ChangeRequest - … - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `updatedChangeRequestComments` ChangeRequestComment[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `comment` string, nullable - `commentedByUsername` string, nullable - `changeRequestId` integer - `changeRequest` ChangeRequest - … - `createdByUser` User (recursive) - `updatedByUser` User (recursive) - `userImpersonations` UserImpersonation[], nullable - `id` integer - `impersonatorUserId` integer - `impersonatingUserId` integer - `expiresAtUtc` string, date-time - `impersonatorUser` User (recursive) - `impersonatingUser` User (recursive) - `impersonatedByUsers` UserImpersonation[], nullable - `id` integer - `impersonatorUserId` integer - `impersonatingUserId` integer - `expiresAtUtc` string, date-time - `impersonatorUser` User (recursive) - `impersonatingUser` User (recursive) - `impersonatorUser` User (recursive) - `createdBy` integer, nullable - `createdByUser` User (recursive) - `updatedBy` integer, nullable - `updatedByUser` User (recursive) - `createdDate` string, date-time - `updatedDate` string, date-time - `customAuditProperties` AuditPropertyChange[], nullable - `property` string, nullable - `oldValue` unknown - `newValue` unknown - `providerClients` ProviderClient[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `providerLinkId` integer - `externalClientId` string, nullable, required - `externalClientName` string, nullable, required - `status` string, nullable - `internalData` unknown - `tenantId` integer, nullable - `ownerTenant` Tenant (recursive) - `providerLink` ProviderLink - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `disabled` boolean - `disabledOrUnhealthy` boolean - `healthStatus` 'Unhealthy' | 'Degraded' | 'Healthy': The string or integer value may be used. Unhealthy = 0, Degraded = 1, Healthy = 2 - `healthStatusMessage` string, nullable - `unhealthyCount` integer - `tenantId` integer - `name` string, nullable, required - `runScriptPriority` integer - `providerTypeFormData` unknown - `providerTypeId` string, uuid - `ownerTenant` Tenant (recursive) - `providerClients` ProviderClient[], nullable - `schedules` Schedule[], nullable - … - `targetAssignments` TargetAssignment[], nullable - … - `agents` ProviderAgent[], nullable - … - `providersLinkedFromThisProvider` ProviderLinkCrossReference[], nullable - … - `linkedFromProviders` ProviderLinkCrossReference[], nullable - … - `createdByUser` User - … - `updatedByUser` User - … - `excludedCapabilities` string[], nullable - `providerInternalData` ProviderLinkInternalData - … - `hasCompletedInitialAgentSync` boolean - `types` string[], nullable - `providerAgents` ProviderAgent[], nullable - `id` integer - `providerLinkId` integer - `externalClientId` string, nullable, required - `externalAgentId` ExternalAgentId, required - … - `computerId` integer, nullable - `isOnline` boolean - `supportsOnlineStatus` boolean - `supportsRunningScripts` boolean - `agentVersion` SemanticVersion - … - `dateAddedUTC` string, date-time - `lastUpdatedUTC` string, date-time - `internalData` unknown - `deviceDetails` DeviceDetails - … - `onboardingOptions` AgentOnboardingOptions - … - `requireManualIdentification` boolean - `providerLink` ProviderLink - … - `computer` Computer - … - `providerClient` ProviderClient (recursive) - `identificationFailures` AgentIdentificationFailure[], nullable - … - `identificationLogs` AgentIdentificationLog[], nullable - … - `isMemberOfInitialDeviceSync` boolean - `deletedAt` string, date-time, nullable - `deletedReason` string, nullable - `compositeKey` ProviderAgentCompositeKey - … - `ownedProviderLinks` ProviderLink[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `disabled` boolean - `disabledOrUnhealthy` boolean - `healthStatus` 'Unhealthy' | 'Degraded' | 'Healthy': The string or integer value may be used. Unhealthy = 0, Degraded = 1, Healthy = 2 - `healthStatusMessage` string, nullable - `unhealthyCount` integer - `tenantId` integer - `name` string, nullable, required - `runScriptPriority` integer - `providerTypeFormData` unknown - `providerTypeId` string, uuid - `ownerTenant` Tenant (recursive) - `providerClients` ProviderClient[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `providerLinkId` integer - `externalClientId` string, nullable, required - `externalClientName` string, nullable, required - `status` string, nullable - `internalData` unknown - `tenantId` integer, nullable - `ownerTenant` Tenant (recursive) - `providerLink` ProviderLink (recursive) - `hasCompletedInitialAgentSync` boolean - `types` string[], nullable - `providerAgents` ProviderAgent[], nullable - … - `schedules` Schedule[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `name` string, nullable - `target` string, nullable - `targetName` string, nullable - `targetType` 'All' | 'Computer' | 'Metascript' | 'Person' | 'AzureGroup' | 'TenantMetascript' | 'AllForTenant' | 'ProviderDeviceGroup' | 'ProviderClientGroup' | 'TenantFilterScript' | 'FilterScript' | 'AllTenants' | 'SpecificTenant' | 'Tag' | 'TenantTag' | 'CloudTag' | 'CloudProviderClientGroup': The string or integer value may be used. All = 1, Computer = 2, Metascript = 5, Person = 7, AzureGroup = 8, TenantMetascript = 20, AllForTenant = 21, ProviderDeviceGroup = 22, ProviderClientGroup = 23, TenantFilterScript = 24, FilterScript = 25, AllTenants = 28, SpecificTenant = 29, Tag = 30, TenantTag = 31, CloudTag = 40, CloudProviderClientGroup = 42 - `targetGroupFilter` 'All' | 'Servers' | 'Workstations' | 'PortableDevices' | 'WorkstationsAndPortableDevices' | 'DomainControllers' | 'PrimaryDomainControllers': The string or integer value may be used. All = 0, Servers = 1, Workstations = 2, PortableDevices = 3, WorkstationsAndPortableDevices = 4, DomainControllers = 5, PrimaryDomainControllers = 6 - `providerDeviceGroupType` string, uuid, nullable - `providerClientGroupType` string, uuid, nullable - `providerLinkId` integer, nullable - `tenantId` integer, nullable - `propagateToChildTenants` boolean - `allowAccessToParentTenant` boolean - `targetCategory` 'Computer' | 'Tenant' | 'Person': The string or integer value may be used. Computer = 0, Tenant = 1, Person = 2 - `maintenanceType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'ChocolateySoftware' | 'NiniteSoftware' | 'LocalMaintenanceTask' | 'GlobalMaintenanceTask' | 'AgentUpdate': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, ChocolateySoftware = 3, NiniteSoftware = 4, LocalMaintenanceTask = 5, GlobalMaintenanceTask = 6, AgentUpdate = 7 - `maintenanceIdentifier` string, nullable - `disabled` boolean - `day` integer, nullable - `sendDetectionEmail` boolean - `sendDetectionEmailWhenAllActionsAreCompliant` boolean - `sendFollowUpEmail` boolean - `sendFollowUpOnlyIfActionNeeded` boolean - `showRunNowButton` boolean - `showPostponeButton` boolean - `rebootPreference` 'Normal' | 'Suppress' | 'Prompt' | 'Force': The string or integer value may be used. Normal = 0, Suppress = 1, Prompt = 2, Force = -1 - `promptTimeoutAction` 'Reboot' | 'Suppress' | 'FailSession': The string or integer value may be used. Reboot = 0, Suppress = 1, FailSession = 2 - `autoConsentToReboots` boolean - `promptTimeoutMinutes` integer - `applyWindowsUpdates` boolean - `showMaintenanceActions` boolean - `allowAccessToMSPResources` boolean - `timeZoneInfoId` string, nullable - `time` string, nullable - `maintenanceTime` string, nullable - `customCronExpression` string, nullable - `offlineBehavior` 'Skip' | 'ApplyOnConnect': The string or integer value may be used. Skip = 1, ApplyOnConnect = 2 - `suppressRebootsDuringBusinessHours` boolean - `useComputersTimezoneForExecution` boolean - `scheduleExecutionAfterActiveHours` boolean - `createdByUser` User - … - `updatedByUser` User - … - `ownerTenant` Tenant (recursive) - `providerLink` ProviderLink (recursive) - `targetAssignments` TargetAssignment[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `id` integer - `databaseType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `isCore` boolean - `autoApprove` boolean - `integrationTypeId` string, nullable - `integrationPrompt` string, nullable - `excluded` boolean - `sortOrder` integer - `maintenanceIdentifier` string, nullable, required - `maintenanceType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'ChocolateySoftware' | 'NiniteSoftware' | 'LocalMaintenanceTask' | 'GlobalMaintenanceTask' | 'AgentUpdate': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, ChocolateySoftware = 3, NiniteSoftware = 4, LocalMaintenanceTask = 5, GlobalMaintenanceTask = 6, AgentUpdate = 7 - `onboardingOnly` boolean - `targetEnforcement` 'Required' | 'Optional' | 'Adhoc' | 'Onboarding': The string or integer value may be used. Required = 1, Optional = 2, Adhoc = 3, Onboarding = 4 - `targetType` 'All' | 'Computer' | 'Metascript' | 'Person' | 'AzureGroup' | 'TenantMetascript' | 'AllForTenant' | 'ProviderDeviceGroup' | 'ProviderClientGroup' | 'TenantFilterScript' | 'FilterScript' | 'AllTenants' | 'SpecificTenant' | 'Tag' | 'TenantTag' | 'CloudTag' | 'CloudProviderClientGroup': The string or integer value may be used. All = 1, Computer = 2, Metascript = 5, Person = 7, AzureGroup = 8, TenantMetascript = 20, AllForTenant = 21, ProviderDeviceGroup = 22, ProviderClientGroup = 23, TenantFilterScript = 24, FilterScript = 25, AllTenants = 28, SpecificTenant = 29, Tag = 30, TenantTag = 31, CloudTag = 40, CloudProviderClientGroup = 42 - `targetCategory` 'Computer' | 'Tenant' | 'Person': The string or integer value may be used. Computer = 0, Tenant = 1, Person = 2 - `targetGroupFilter` 'All' | 'Servers' | 'Workstations' | 'PortableDevices' | 'WorkstationsAndPortableDevices' | 'DomainControllers' | 'PrimaryDomainControllers': The string or integer value may be used. All = 0, Servers = 1, Workstations = 2, PortableDevices = 3, WorkstationsAndPortableDevices = 4, DomainControllers = 5, PrimaryDomainControllers = 6 - `target` string, nullable - `tenantId` integer, nullable - `ownerTenant` Tenant (recursive) - `propagateToChildTenants` boolean - `allowAccessToParentTenant` boolean - `providerLinkId` integer, nullable - `providerDeviceGroupType` string, uuid, nullable - `providerClientGroupType` string, uuid, nullable - `providerLinkIdForMaintenanceItem` integer, nullable - `targetName` string, nullable - `providerLink` ProviderLink (recursive) - `notes` TargetAssignmentNotes - … - `visibility` TargetAssignmentVisibility - … - `softwareSemanticVersion` SemanticVersion - … - `softwareSemanticVersionString` string, nullable - `desiredSoftwareState` 'NewerOrEqualVersion' | 'NotPresent' | 'AnyVersion' | 'ThisVersion' | 'OlderOrEqualVersion' | 'LatestVersion' | 'NoAction' | 'UpdateIfFound': The string or integer value may be used. NewerOrEqualVersion = 0, NotPresent = 1, AnyVersion = 2, ThisVersion = 3, OlderOrEqualVersion = 4, LatestVersion = 5, NoAction = 6, UpdateIfFound = 7 - `softwareProviderType` 'Ninite' | 'Chocolatey' | 'Inherent': The string or integer value may be used. Ninite = 1, Chocolatey = 2, Inherent = 3 - `taskParameterValues` object, nullable - `licenseId` integer, nullable - `license` License - … - `maintenanceTaskMode` 'Enforce' | 'Audit' | 'Monitor' | 'NoAction': The string or integer value may be used. Enforce = 0, Audit = 1, Monitor = 2, NoAction = 3 - `maintenanceTaskParameterValues` MaintenanceTaskParameterValue[], nullable - … - `changeRequests` ChangeRequest[], nullable - … - `parameterValueMigrationErrors` string, nullable - `softwareSpecifier` SoftwareSpecifier - … - `maintenanceSpecifier` MaintenanceSpecifier - … - `createdByUser` User - … - `updatedByUser` User - … - `softwareId` integer, nullable - `softwareVersionId` integer - `agents` ProviderAgent[], nullable - `id` integer - `providerLinkId` integer - `externalClientId` string, nullable, required - `externalAgentId` ExternalAgentId, required - … - `computerId` integer, nullable - `isOnline` boolean - `supportsOnlineStatus` boolean - `supportsRunningScripts` boolean - `agentVersion` SemanticVersion - … - `dateAddedUTC` string, date-time - `lastUpdatedUTC` string, date-time - `internalData` unknown - `deviceDetails` DeviceDetails - … - `onboardingOptions` AgentOnboardingOptions - … - `requireManualIdentification` boolean - `providerLink` ProviderLink (recursive) - `computer` Computer - … - `providerClient` ProviderClient - … - `identificationFailures` AgentIdentificationFailure[], nullable - … - `identificationLogs` AgentIdentificationLog[], nullable - … - `isMemberOfInitialDeviceSync` boolean - `deletedAt` string, date-time, nullable - `deletedReason` string, nullable - `compositeKey` ProviderAgentCompositeKey - … - `providersLinkedFromThisProvider` ProviderLinkCrossReference[], nullable - `isExternalClientLinkingEnabled` boolean - `isProviderLink2InitializedFromProviderLink1` boolean - `providerLink1Id` integer - `providerLink2Id` integer - `providerLink1` ProviderLink (recursive) - `providerLink2` ProviderLink (recursive) - `linkedFromProviders` ProviderLinkCrossReference[], nullable - `isExternalClientLinkingEnabled` boolean - `isProviderLink2InitializedFromProviderLink1` boolean - `providerLink1Id` integer - `providerLink2Id` integer - `providerLink1` ProviderLink (recursive) - `providerLink2` ProviderLink (recursive) - `createdByUser` User - `id` integer - `userName` string, nullable - `normalizedUserName` string, nullable - `normalizedEmail` string, nullable - `emailConfirmed` boolean - `passwordHash` string, nullable - `securityStamp` string, nullable - `concurrencyStamp` string, nullable - `phoneNumber` string, nullable - `phoneNumberConfirmed` boolean - `twoFactorEnabled` boolean - `lockoutEnd` string, date-time, nullable - `lockoutEnabled` boolean - `accessFailedCount` integer - `expirationDateUTC` string, date-time, nullable - `isAdmin` boolean - `canManageCrossTenantDeployments` boolean - `servicePrincipalId` string, nullable - `personId` integer, nullable - `tenantId` integer - `person` Person - … - `ownerTenant` Tenant (recursive) - `isSupportTechnician` boolean - `isMigrated` boolean - `displayName` string, nullable - `email` string, nullable - `azurePrincipalId` string, nullable - `hasManagementAccess` boolean - `createdDeployments` TargetAssignment[], nullable - … - `updatedDeployments` TargetAssignment[], nullable - … - `createdScripts` Script[], nullable - … - `updatedScripts` Script[], nullable - … - `createdPersons` Person[], nullable - … - `updatedPersons` Person[], nullable - … - `createdSoftware` LocalSoftware[], nullable - … - `updatedSoftware` LocalSoftware[], nullable - … - `createdSoftwareVersions` LocalSoftwareVersion[], nullable - … - `updatedSoftwareVersions` LocalSoftwareVersion[], nullable - … - `createdLicenses` License[], nullable - … - `updatedLicenses` License[], nullable - … - `createdMaintenanceTasks` MaintenanceTask[], nullable - … - `updatedMaintenanceTasks` MaintenanceTask[], nullable - … - `createdSchedules` Schedule[], nullable - … - `updatedSchedules` Schedule[], nullable - … - `createdProviderLinks` ProviderLink[], nullable - `updatedProviderLinks` ProviderLink[], nullable - `createdBrandings` Branding[], nullable - `updatedBrandings` Branding[], nullable - `createdMedia` Media[], nullable - … - `updatedMedia` Media[], nullable - … - `createdTags` Tag[], nullable - … - `updatedTags` Tag[], nullable - … - `createdRecommendedTargetAssignmentApprovals` RecommendedTargetAssignmentApproval[], nullable - … - `updatedRecommendedTargetAssignmentApprovals` RecommendedTargetAssignmentApproval[], nullable - … - `createdMaintenanceSessions` MaintenanceSession[], nullable - … - `accessRequestAcknowledgements` AccessRequest[], nullable - … - `userRoles` UserRole[], nullable - … - `userRoleAssignments` UserRoleAssignment[], nullable - … - `userGroups` UserGroup[], nullable - … - `silencedNotifications` UserSilencedNotification[], nullable - … - `createdChangeRequests` ChangeRequest[], nullable - … - `updatedChangeRequests` ChangeRequest[], nullable - … - `createdChangeRequestComments` ChangeRequestComment[], nullable - … - `updatedChangeRequestComments` ChangeRequestComment[], nullable - … - `userImpersonations` UserImpersonation[], nullable - … - `impersonatedByUsers` UserImpersonation[], nullable - … - `impersonatorUser` User (recursive) - `createdBy` integer, nullable - `createdByUser` User (recursive) - `updatedBy` integer, nullable - `updatedByUser` User (recursive) - `createdDate` string, date-time - `updatedDate` string, date-time - `customAuditProperties` AuditPropertyChange[], nullable - … - `updatedByUser` User - `id` integer - `userName` string, nullable - `normalizedUserName` string, nullable - `normalizedEmail` string, nullable - `emailConfirmed` boolean - `passwordHash` string, nullable - `securityStamp` string, nullable - `concurrencyStamp` string, nullable - `phoneNumber` string, nullable - `phoneNumberConfirmed` boolean - `twoFactorEnabled` boolean - `lockoutEnd` string, date-time, nullable - `lockoutEnabled` boolean - `accessFailedCount` integer - `expirationDateUTC` string, date-time, nullable - `isAdmin` boolean - `canManageCrossTenantDeployments` boolean - `servicePrincipalId` string, nullable - `personId` integer, nullable - `tenantId` integer - `person` Person - … - `ownerTenant` Tenant (recursive) - `isSupportTechnician` boolean - `isMigrated` boolean - `displayName` string, nullable - `email` string, nullable - `azurePrincipalId` string, nullable - `hasManagementAccess` boolean - `createdDeployments` TargetAssignment[], nullable - … - `updatedDeployments` TargetAssignment[], nullable - … - `createdScripts` Script[], nullable - … - `updatedScripts` Script[], nullable - … - `createdPersons` Person[], nullable - … - `updatedPersons` Person[], nullable - … - `createdSoftware` LocalSoftware[], nullable - … - `updatedSoftware` LocalSoftware[], nullable - … - `createdSoftwareVersions` LocalSoftwareVersion[], nullable - … - `updatedSoftwareVersions` LocalSoftwareVersion[], nullable - … - `createdLicenses` License[], nullable - … - `updatedLicenses` License[], nullable - … - `createdMaintenanceTasks` MaintenanceTask[], nullable - … - `updatedMaintenanceTasks` MaintenanceTask[], nullable - … - `createdSchedules` Schedule[], nullable - … - `updatedSchedules` Schedule[], nullable - … - `createdProviderLinks` ProviderLink[], nullable - `updatedProviderLinks` ProviderLink[], nullable - `createdBrandings` Branding[], nullable - `updatedBrandings` Branding[], nullable - `createdMedia` Media[], nullable - … - `updatedMedia` Media[], nullable - … - `createdTags` Tag[], nullable - … - `updatedTags` Tag[], nullable - … - `createdRecommendedTargetAssignmentApprovals` RecommendedTargetAssignmentApproval[], nullable - … - `updatedRecommendedTargetAssignmentApprovals` RecommendedTargetAssignmentApproval[], nullable - … - `createdMaintenanceSessions` MaintenanceSession[], nullable - … - `accessRequestAcknowledgements` AccessRequest[], nullable - … - `userRoles` UserRole[], nullable - … - `userRoleAssignments` UserRoleAssignment[], nullable - … - `userGroups` UserGroup[], nullable - … - `silencedNotifications` UserSilencedNotification[], nullable - … - `createdChangeRequests` ChangeRequest[], nullable - … - `updatedChangeRequests` ChangeRequest[], nullable - … - `createdChangeRequestComments` ChangeRequestComment[], nullable - … - `updatedChangeRequestComments` ChangeRequestComment[], nullable - … - `userImpersonations` UserImpersonation[], nullable - … - `impersonatedByUsers` UserImpersonation[], nullable - … - `impersonatorUser` User (recursive) - `createdBy` integer, nullable - `createdByUser` User (recursive) - `updatedBy` integer, nullable - `updatedByUser` User (recursive) - `createdDate` string, date-time - `updatedDate` string, date-time - `customAuditProperties` AuditPropertyChange[], nullable - … - `excludedCapabilities` string[], nullable - `providerInternalData` ProviderLinkInternalData - `providerLinkId` integer - `internalData` unknown - `providerLink` ProviderLink (recursive) - `tenantSoftware` TenantSoftware[], nullable - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `tenantId` integer - `softwareId` integer - `tenant` Tenant (recursive) - `software` LocalSoftware - `createdDate` string, date-time - `updatedDate` string, date-time - `createdBy` integer, nullable - `updatedBy` integer, nullable - `name` string, nullable - `licenseRequirement` 'None' | 'Required' | 'Optional': The string or integer value may be used. None = 0, Required = 1, Optional = 2 - `installOrder` integer - `hidden` boolean - `softwareTableName` string, nullable - `detectionMethod` 'SoftwareTable' | 'CustomDetectionScript' | 'UpgradeCode' | 'ProductCode': The string or integer value may be used. SoftwareTable = 0, CustomDetectionScript = 1, UpgradeCode = 2, ProductCode = 3 - `softwareTableNameSearchMode` 'Contains' | 'Regex' | 'Traditional': The string or integer value may be used. Contains = 0, Regex = 1, Traditional = 2 - `agentIntegrationTypeId` string, uuid, nullable - `detectionScript` Script - … - `detectionScriptId` integer, nullable - `detectionScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `downloadInstallerScript` Script - … - `downloadInstallerScriptId` integer, nullable - `downloadInstallerScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `upgradeCode` string, nullable - `maintenanceTask` MaintenanceTask - … - `maintenanceTaskId` integer, nullable - `maintenanceTaskType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `notes` string, nullable - `rebootNeeded` boolean - `repairType` 'None' | 'UninstallInstall' | 'InstallOver' | 'CustomScript': The string or integer value may be used. None = 0, UninstallInstall = 1, InstallOver = 2, CustomScript = 3 - `repairScript` Script - … - `repairScriptId` integer, nullable - `repairScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `softwareIconMediaId` integer, nullable - `recommended` boolean - `chocoProviderSoftwareId` string, nullable - `niniteProviderSoftwareId` string, nullable - `maintenanceType` 'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'ChocolateySoftware' | 'NiniteSoftware' | 'LocalMaintenanceTask' | 'GlobalMaintenanceTask' | 'AgentUpdate': The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, ChocolateySoftware = 3, NiniteSoftware = 4, LocalMaintenanceTask = 5, GlobalMaintenanceTask = 6, AgentUpdate = 7 - `useSoftwareTableDetection` boolean - `installScriptId` integer, nullable - `installScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `installScript` Script - … - `testScriptId` integer, nullable - `testScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `testScript` Script - … - `upgradeScriptId` integer, nullable - `upgradeScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `upgradeScript` Script - … - `uninstallScriptId` integer, nullable - `uninstallScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `uninstallScript` Script - … - `postInstallScriptId` integer, nullable - `postInstallScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `postInstallScript` Script - … - `postUninstallScriptId` integer, nullable - `postUninstallScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - `postUninstallScript` Script - … - `testRequired` boolean - `testFailedError` string, nullable - `upgradeStrategy` 'None' | 'UninstallInstall' | 'InstallOver' | 'UpgradeScript': The string or integer value may be used. None = 0, UninstallInstall = 1, InstallOver = 2, UpgradeScript = 3 - `licenseType` 'None' | 'LicenseFile' | 'Key': The string or integer value may be used. None = 0, LicenseFile = 1, Key = 2 - `licenseDescription` string, nullable - `useDynamicVersions` boolean - `dynamicVersionsScriptId` integer, nullable - `dynamicVersionsScriptType` 'Global' | 'Local': The string or integer value may be used. Global = 0, Local = 1 - … truncated; see the full OpenAPI document linked below --- [API](https://skmtc.dev/immy/apis/immy-bot-api-2.md) · [All operations](https://skmtc.dev/immy/apis/immy-bot-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/immy/apis/immy-bot-api-2/revisions/75b50268fa51?raw)