$DeviceLinksBlock
$($DeviceOverviewBlock)$($DeviceHardwareBlock)$($DeviceEnrollmentBlock)$($DevicePolicyBlock)$($DeviceAppsBlock)$($DeviceGroupsBlock)
"
+
+ $DeviceAssetFields = @{
+ microsoft_365 = $DeviceIntuneDetailshtml
+ }
+ $NewHash = Get-StringHash -String $DeviceIntuneDetailshtml
+
+ if ($DeviceLayoutId) {
+ if ($HuduDevice) {
+ if (($HuduDevice | Measure-Object).count -eq 1) {
+ $ExistingAsset = Get-CIPPAzDataTableEntity @HuduAssetCache -Filter "PartitionKey eq 'HuduDevice' and CompanyId eq '$company_id' and RowKey eq '$($HuduDevice.id)'"
+ $ExistingHash = $ExistingAsset.Hash
+
+ if (!$ExistingAsset -or $ExistingAsset.Hash -ne $NewHash) {
+ $null = Set-HuduAsset -asset_id $HuduDevice.id -Name $HuduDevice.name -company_id $company_id -asset_layout_id $HuduDevice.asset_layout_id -Fields $DeviceAssetFields -PrimarySerial $Device.serialNumber
+ $AssetCache = [PSCustomObject]@{
+ PartitionKey = 'HuduDevice'
+ RowKey = [string]$HuduDevice.id
+ CompanyId = [string]$company_id
+ Hash = [string]$NewHash
+ }
+ Add-CIPPAzDataTableEntity @HuduAssetCache -Entity $AssetCache -Force
+
+ $HuduUser = $People | Where-Object { $_.primary_mail -eq $Device.userPrincipalName -or ($_.cards.integrator_name -eq 'cw_manage' -and $_.cards.data.communicationItems.communicationType -eq 'Email' -and $_.cards.data.communicationItems.value -eq $Device.userPrincipalName) }
+
+ if ($HuduUser) {
+ $Relation = $HuduRelations | Where-Object { $_.fromable_type -eq 'Asset' -and $_.fromable_id -eq $HuduUser.id -and $_.toable_type -eq 'Asset' -and $_toable_id -eq $HuduDevice.id }
+ if (-not $Relation) {
+ try {
+ $null = New-HuduRelation -FromableType 'Asset' -FromableID $HuduUser.id -ToableType 'Asset' -ToableID $HuduDevice.id -ea stop
+ } catch {}
+ }
+ }
+ }
+ } else {
+ $CompanyResult.Errors.add("Device $($HuduDevice.name): Multiple devices matched on name or serial ($($device.serialNumber -join ', '))")
+ }
+ } else {
+ if ($device.deviceType -in $IntuneDesktopDeviceTypes) {
+ $DeviceLayoutID = $DesktopsLayout.id
+ $DeviceCreation = $CreateDevices
+ } else {
+ $DeviceLayoutID = $MobilesLayout.id
+ $DeviceCreation = $CreateMobileDevices
+ }
+ if ($DeviceCreation -eq $true) {
+ $HuduDevice = (New-HuduAsset -Name $device.deviceName -company_id $company_id -asset_layout_id $DeviceLayoutID -Fields $DeviceAssetFields -PrimarySerial $Device.serialNumber).asset
+
+ $AssetCache = [PSCustomObject]@{
+ PartitionKey = 'HuduDevice'
+ RowKey = [string]$HuduDevice.id
+ CompanyId = [string]$company_id
+ Hash = [string]$NewHash
+ }
+ Add-CIPPAzDataTableEntity @HuduAssetCache -Entity $AssetCache -Force
+
+ $HuduUser = $People | Where-Object { $_.primary_mail -eq $Device.userPrincipalName -or ($_.cards.integrator_name -eq 'cw_manage' -and $_.cards.data.communicationItems.communicationType -eq 'Email' -and $_.cards.data.communicationItems.value -eq $Device.userPrincipalName) }
+ if ($HuduUser) {
+ try {
+ $null = New-HuduRelation -FromableType 'Asset' -FromableID $HuduUser.id -ToableType 'Asset' -ToableID $HuduDevice.id -ea stop
+ } catch {
+ # No need to do anything here as its will be when relations already exist.
+ }
+ }
+ }
+ }
+ }
+ } catch {
+ $CompanyResult.Errors.add("Device $($device.deviceName): A Fatal Error occured while processing the device $_")
+ }
+
+ }
+
+
+ $body = "
+
+
+ $detailstable
+ $licenseHTML
+
+
+
+ $RolesHtml
+
+
+
+ $licensedUserHTML
+
"
+
+ try {
+ $null = Set-HuduMagicDash -Title "Microsoft 365 - $($Tenant.displayName)" -company_name $TenantMap.IntegrationName -Message "$($licensedUsers.count) Licensed Users" -Icon 'fab fa-microsoft' -Content $body -Shade 'success'
+ } catch {
+ $CompanyResult.Errors.add("Company: Failed to add Magic Dash to Company: $_")
+ }
+
+ try {
+ if ($importDomains) {
+ $domainstoimport = $RawDomains
+ foreach ($imp in $domainstoimport) {
+ $impdomain = $imp.id
+ $huduimpdomain = Get-HuduWebsites -Name "https://$impdomain"
+ if ($($huduimpdomain.id.count) -eq 0) {
+ if ($monitorDomains) {
+ $null = New-HuduWebsite -Name "https://$impdomain" -Notes $HuduNotes -Paused 'false' -CompanyId $company_id -DisableDNS 'false' -DisableSSL 'false' -DisableWhois 'false'
+ } else {
+ $null = New-HuduWebsite -Name "https://$impdomain" -Notes $HuduNotes -Paused 'true' -CompanyId $company_id -DisableDNS 'true' -DisableSSL 'true' -DisableWhois 'true'
+ }
+
+ }
+ }
+
+ }
+ } catch {
+ $CompanyResult.Errors.add("Company: Failed to import domain: $_")
+ Write-LogMessage -tenant $Tenant.defaultDomainName -tenantid $Tenant.customerId -API 'Hudu Sync' -message "Company: Failed to import domain: $_" -level 'Error'
+ }
+ Write-LogMessage -tenant $Tenant.defaultDomainName -tenantid $Tenant.customerId -API 'Hudu Sync' -message 'Company: Completed Sync' -level 'Information'
+ } catch {
+ $CompanyResult.Errors.add("Company: A fatal error occured: $_")
+ Write-LogMessage -tenant $Tenant.defaultDomainName -tenantid $Tenant.customerId -API 'Hudu Sync' -message "Company: A fatal error occured: $_" -level 'Error'
+ }
+ return $CompanyResult
+}
diff --git a/Modules/CippExtensions/Public/Hudu/Set-HuduMapping.ps1 b/Modules/CippExtensions/Public/Hudu/Set-HuduMapping.ps1
new file mode 100644
index 000000000000..03c6dddb8fb3
--- /dev/null
+++ b/Modules/CippExtensions/Public/Hudu/Set-HuduMapping.ps1
@@ -0,0 +1,26 @@
+function Set-HuduMapping {
+ [CmdletBinding()]
+ param (
+ $CIPPMapping,
+ $APIName,
+ $Request
+ )
+ Get-CIPPAzDataTableEntity @CIPPMapping -Filter "PartitionKey eq 'HuduMapping'" | ForEach-Object {
+ Remove-AzDataTableEntity @CIPPMapping -Entity $_
+ }
+ foreach ($Mapping in ([pscustomobject]$Request.body.mappings).psobject.properties) {
+ $AddObject = @{
+ PartitionKey = 'HuduMapping'
+ RowKey = "$($mapping.name)"
+ IntegrationId = "$($mapping.value.value)"
+ IntegrationName = "$($mapping.value.label)"
+ }
+
+ Add-CIPPAzDataTableEntity @CIPPMapping -Entity $AddObject -Force
+
+ Write-LogMessage -API $APINAME -user $request.headers.'x-ms-client-principal' -message "Added mapping for $($mapping.name)." -Sev 'Info'
+ }
+ $Result = [pscustomobject]@{'Results' = 'Successfully edited mapping table.' }
+
+ Return $Result
+}
\ No newline at end of file
diff --git a/Modules/CippExtensions/Public/New-CippExtAlert.ps1 b/Modules/CippExtensions/Public/New-CippExtAlert.ps1
index 827347a613d2..54f9faf81258 100644
--- a/Modules/CippExtensions/Public/New-CippExtAlert.ps1
+++ b/Modules/CippExtensions/Public/New-CippExtAlert.ps1
@@ -8,21 +8,22 @@ function New-CippExtAlert {
$Table = Get-CIPPTable -TableName Extensionsconfig
$Configuration = (Get-CIPPAzDataTableEntity @Table).config | ConvertFrom-Json -Depth 10
$MappingTable = Get-CIPPTable -TableName CippMapping
- $MappingFile = (Get-CIPPAzDataTableEntity @MappingTable)
+
foreach ($ConfigItem in $Configuration.psobject.properties.name) {
switch ($ConfigItem) {
- "HaloPSA" {
+ 'HaloPSA' {
If ($Configuration.HaloPSA.enabled) {
+ $MappingFile = Get-CIPPAzDataTableEntity @MappingTable -Filter 'PartitionKey eq HaloMapping'
$TenantId = (Get-Tenants | Where-Object defaultDomainName -EQ $Alert.TenantId).customerId
Write-Host "TenantId: $TenantId"
- $MappedId = ($MappingFile | Where-Object RowKey -EQ $TenantId).HaloPSA
+ $MappedId = ($MappingFile | Where-Object { $_.RowKey -eq $TenantId }).IntegrationId
Write-Host "MappedId: $MappedId"
if (!$mappedId) { $MappedId = 1 }
Write-Host "MappedId: $MappedId"
- New-HaloPSATicket -Title $Alert.AlertTitle -Description $Alert.AlertText -Client $mappedId
+ New-HaloPSATicket -Title $Alert.AlertTitle -Description $Alert.AlertText -Client $mappedId
}
}
- "Gradient" {
+ 'Gradient' {
If ($Configuration.Gradient.enabled) {
New-GradientAlert -Title $Alert.AlertTitle -Description $Alert.AlertText -Client $Alert.TenantId
}
@@ -30,4 +31,4 @@ function New-CippExtAlert {
}
}
-}
\ No newline at end of file
+}
diff --git a/Modules/CippExtensions/Public/NinjaOne/Get-NinjaOneFieldMapping.ps1 b/Modules/CippExtensions/Public/NinjaOne/Get-NinjaOneFieldMapping.ps1
new file mode 100644
index 000000000000..e88f53ceba9c
--- /dev/null
+++ b/Modules/CippExtensions/Public/NinjaOne/Get-NinjaOneFieldMapping.ps1
@@ -0,0 +1,117 @@
+function Get-NinjaOneFieldMapping {
+ [CmdletBinding()]
+ param (
+ $CIPPMapping
+ )
+ try {
+ #Get available mappings
+ $Mappings = [pscustomobject]@{}
+
+ [System.Collections.Generic.List[object]]$CIPPFieldHeaders = @(
+ [PSCustomObject]@{
+ Title = 'NinjaOne Organization Global Custom Field Mapping'
+ FieldType = 'Organization'
+ Description = 'Use the table below to map your Organization Field to the correct NinjaOne Field'
+ }
+ [PSCustomObject]@{
+ Title = 'NinjaOne Device Custom Field Mapping'
+ FieldType = 'Device'
+ Description = 'Use the table below to map your Device Field to the correct NinjaOne Field'
+ }
+ )
+
+ [System.Collections.Generic.List[object]]$CIPPFields = @(
+ [PSCustomObject]@{
+ FieldName = 'TenantLinks'
+ FieldLabel = 'Microsoft 365 Tenant Links - Field Used to Display Links to Microsoft 365 Portals and CIPP'
+ FieldType = 'Organization'
+ Type = 'WYSIWYG'
+ },
+ [PSCustomObject]@{
+ FieldName = 'TenantSummary'
+ FieldLabel = 'Microsoft 365 Tenant Summary - Field Used to Display Tenant Summary Information'
+ FieldType = 'Organization'
+ Type = 'WYSIWYG'
+ },
+ [PSCustomObject]@{
+ FieldName = 'UsersSummary'
+ FieldLabel = 'Microsoft 365 Users Summary - Field Used to Display User Summary Information'
+ FieldType = 'Organization'
+ Type = 'WYSIWYG'
+ },
+ [PSCustomObject]@{
+ FieldName = 'DeviceLinks'
+ FieldLabel = 'Microsoft 365 Device Links - Field Used to Display Links to Microsoft 365 Portals and CIPP'
+ FieldType = 'Device'
+ Type = 'WYSIWYG'
+ },
+ [PSCustomObject]@{
+ FieldName = 'DeviceSummary'
+ FieldLabel = 'Microsoft 365 Device Summary - Field Used to Display Device Summary Information'
+ FieldType = 'Device'
+ Type = 'WYSIWYG'
+ },
+ [PSCustomObject]@{
+ FieldName = 'DeviceCompliance'
+ FieldLabel = 'Intune Device Compliance Status - Field Used to Monitor Device Compliance'
+ FieldType = 'Device'
+ Type = 'TEXT'
+ }
+ )
+
+ $MappingFieldMigrate = Get-CIPPAzDataTableEntity @CIPPMapping -Filter "PartitionKey eq 'NinjaFieldMapping'" | ForEach-Object {
+ [PSCustomObject]@{
+ PartitionKey = 'NinjaOneFieldMapping'
+ RowKey = $_.RowKey
+ IntegrationId = $_.NinjaOne
+ IntegrationName = $_.NinjaOneName
+ }
+ Remove-AzDataTableEntity @CIPPMapping -Entity $_
+ }
+ if (($MappingFieldMigrate | Measure-Object).count -gt 0) {
+ Add-CIPPAzDataTableEntity @CIPPMapping -Entity $MappingFieldMigrate -Force
+ }
+
+ $Mappings = Get-ExtensionMapping -Extension 'NinjaOneField'
+
+ $Table = Get-CIPPTable -TableName Extensionsconfig
+ $Configuration = ((Get-AzDataTableEntity @Table).config | ConvertFrom-Json -ea stop).NinjaOne
+
+ $Token = Get-NinjaOneToken -configuration $Configuration
+
+ $NinjaCustomFieldsNodeRaw = (Invoke-WebRequest -Uri "https://$($Configuration.Instance)/api/v2/device-custom-fields?scopes=node" -Method GET -Headers @{Authorization = "Bearer $($token.access_token)" } -ContentType 'application/json').content | ConvertFrom-Json -Depth 100
+
+ [System.Collections.Generic.List[object]]$NinjaCustomFieldsNode = $NinjaCustomFieldsNodeRaw | Where-Object { $_.apiPermission -eq 'READ_WRITE' -and $_.type -in $CIPPFields.Type } | Select-Object @{n = 'name'; e = { $_.label } }, @{n = 'value'; e = { $_.name } }, type, @{n = 'FieldType'; e = { 'Device' } }
+
+ $NinjaCustomFieldsOrgRaw = (Invoke-WebRequest -Uri "https://$($Configuration.Instance)/api/v2/device-custom-fields?scopes=organization" -Method GET -Headers @{Authorization = "Bearer $($token.access_token)" } -ContentType 'application/json').content | ConvertFrom-Json -Depth 100
+
+ [System.Collections.Generic.List[object]]$NinjaCustomFieldsOrg = $NinjaCustomFieldsOrgRaw | Where-Object { $_.apiPermission -eq 'READ_WRITE' -and $_.type -in $CIPPFields.Type } | Select-Object @{n = 'name'; e = { $_.label } }, @{n = 'value'; e = { $_.name } }, type, @{n = 'FieldType'; e = { 'Organization' } }
+
+ if ($Null -eq $NinjaCustomFieldsNode) {
+ [System.Collections.Generic.List[object]]$NinjaCustomFieldsNode = @()
+ }
+
+ if ($Null -eq $NinjaCustomFieldsOrg) {
+ [System.Collections.Generic.List[object]]$NinjaCustomFieldsOrg = @()
+ }
+ $Unset = [PSCustomObject]@{
+ name = '--- Do not synchronize ---'
+ value = $null
+ type = 'unset'
+ }
+
+ } catch {
+ [System.Collections.Generic.List[object]]$NinjaCustomFieldsNode = @()
+ [System.Collections.Generic.List[objecgt]]$NinjaCustomFieldsOrg = @()
+ }
+
+ $MappingObj = [PSCustomObject]@{
+ CIPPFields = $CIPPFields
+ CIPPFieldHeaders = $CIPPFieldHeaders
+ IntegrationFields = @($Unset) + @($NinjaCustomFieldsOrg) + @($NinjaCustomFieldsNode)
+ Mappings = $Mappings
+ }
+
+ return $MappingObj
+
+}
\ No newline at end of file
diff --git a/Modules/CippExtensions/NinjaOne/Get-NinjaOneOrgMapping.ps1 b/Modules/CippExtensions/Public/NinjaOne/Get-NinjaOneOrgMapping.ps1
similarity index 64%
rename from Modules/CippExtensions/NinjaOne/Get-NinjaOneOrgMapping.ps1
rename to Modules/CippExtensions/Public/NinjaOne/Get-NinjaOneOrgMapping.ps1
index a0274cb0d16f..24c7e6405560 100644
--- a/Modules/CippExtensions/NinjaOne/Get-NinjaOneOrgMapping.ps1
+++ b/Modules/CippExtensions/Public/NinjaOne/Get-NinjaOneOrgMapping.ps1
@@ -4,14 +4,25 @@ function Get-NinjaOneOrgMapping {
$CIPPMapping
)
try {
- #Get available mappings
- $Mappings = [pscustomobject]@{}
- $Tenants = Get-Tenants
+ $Tenants = Get-Tenants -IncludeErrors
$Filter = "PartitionKey eq 'NinjaOrgsMapping'"
- Get-AzDataTableEntity @CIPPMapping -Filter $Filter | ForEach-Object {
- $Mappings | Add-Member -NotePropertyName $_.RowKey -NotePropertyValue @{ label = "$($_.NinjaOneName)"; value = "$($_.NinjaOne)" }
+ $MigrateRows = Get-AzDataTableEntity @CIPPMapping -Filter $Filter | ForEach-Object {
+ #$Mappings | Add-Member -NotePropertyName $_.RowKey -NotePropertyValue @{ label = "$($_.NinjaOneName)"; value = "$($_.NinjaOne)" }
+ [PSCustomObject]@{
+ RowKey = $_.RowKey
+ IntegrationName = $_.NinjaOneName
+ IntegrationId = $_.NinjaOne
+ PartitionKey = 'NinjaOneMapping'
+ }
+ Remove-AzDataTableEntity @CIPPMapping -Entity $_
}
+
+ if (($MigrateRows | Measure-Object).Count -gt 0) {
+ Add-AzDataTableEntity @CIPPMapping -Entity $MigrateRows -Force
+ }
+
+ $Mappings = Get-ExtensionMapping -Extension 'NinjaOne'
#Get Available Tenants
#Get available Ninja clients
@@ -43,7 +54,7 @@ function Get-NinjaOneOrgMapping {
$MappingObj = [PSCustomObject]@{
Tenants = @($Tenants)
- NinjaOrgs = @($NinjaOrgs | Sort-Object name)
+ Companies = @($NinjaOrgs | Sort-Object name)
Mappings = $Mappings
}
diff --git a/Modules/CippExtensions/NinjaOne/Get-NinjaOneToken.ps1 b/Modules/CippExtensions/Public/NinjaOne/Get-NinjaOneToken.ps1
similarity index 99%
rename from Modules/CippExtensions/NinjaOne/Get-NinjaOneToken.ps1
rename to Modules/CippExtensions/Public/NinjaOne/Get-NinjaOneToken.ps1
index d4cb86838ed5..ba293404b5bd 100644
--- a/Modules/CippExtensions/NinjaOne/Get-NinjaOneToken.ps1
+++ b/Modules/CippExtensions/Public/NinjaOne/Get-NinjaOneToken.ps1
@@ -17,7 +17,6 @@ function Get-NinjaOneToken {
$ClientSecret = $ENV:NinjaClientSecret
}
-
$body = @{
grant_type = 'client_credentials'
client_id = $Configuration.ClientId
diff --git a/Modules/CippExtensions/NinjaOne/Invoke-NinjaOneDeviceWebhook.ps1 b/Modules/CippExtensions/Public/NinjaOne/Invoke-NinjaOneDeviceWebhook.ps1
similarity index 90%
rename from Modules/CippExtensions/NinjaOne/Invoke-NinjaOneDeviceWebhook.ps1
rename to Modules/CippExtensions/Public/NinjaOne/Invoke-NinjaOneDeviceWebhook.ps1
index a8363917efcc..9213a7015b1a 100644
--- a/Modules/CippExtensions/NinjaOne/Invoke-NinjaOneDeviceWebhook.ps1
+++ b/Modules/CippExtensions/Public/NinjaOne/Invoke-NinjaOneDeviceWebhook.ps1
@@ -8,9 +8,9 @@ function Invoke-NinjaOneDeviceWebhook {
Write-LogMessage -user $ExecutingUser -API $APIName -message "Webhook Recieved - Updating NinjaOne Device compliance for $($Data.resourceData.id) in $($Data.tenantId)" -Sev 'Info' -tenant $TenantFilter
$MappedFields = [pscustomobject]@{}
$CIPPMapping = Get-CIPPTable -TableName CippMapping
- $Filter = "PartitionKey eq 'NinjaFieldMapping'"
- Get-AzDataTableEntity @CIPPMapping -Filter $Filter | Where-Object { $Null -ne $_.NinjaOne -and $_.NinjaOne -ne '' } | ForEach-Object {
- $MappedFields | Add-Member -NotePropertyName $_.RowKey -NotePropertyValue $($_.NinjaOne)
+ $Filter = "PartitionKey eq 'NinjaOneFieldMapping'"
+ Get-AzDataTableEntity @CIPPMapping -Filter $Filter | Where-Object { $Null -ne $_.IntegrationId -and $_.IntegrationId -ne '' } | ForEach-Object {
+ $MappedFields | Add-Member -NotePropertyName $_.RowKey -NotePropertyValue $($_.IntegrationId)
}
if ($MappedFields.DeviceCompliance) {
@@ -18,14 +18,14 @@ function Invoke-NinjaOneDeviceWebhook {
$M365DeviceID = $Data.resourceData.id
$DeviceM365 = New-GraphGetRequest -uri "https://graph.microsoft.com/beta/devices/$($M365DeviceID)" -Tenantid $tenantfilter
-
+
$DeviceFilter = "PartitionKey eq '$($tenantfilter)' and RowKey eq '$($DeviceM365.deviceID)'"
$DeviceMapTable = Get-CippTable -tablename 'NinjaOneDeviceMap'
$Device = Get-CIPPAzDataTableEntity @DeviceMapTable -Filter $DeviceFilter
-
+
if (($Device | Measure-Object).count -eq 1) {
- $Token = Get-NinjaOneToken -configuration $Configuration
-
+ $Token = Get-NinjaOneToken -configuration $Configuration
+
if ($DeviceM365.isCompliant -eq $True) {
$Compliant = 'Compliant'
} else {
@@ -37,16 +37,16 @@ function Invoke-NinjaOneDeviceWebhook {
} | ConvertTo-Json
$Null = Invoke-WebRequest -Uri "https://$($Configuration.Instance)/api/v2/device/$($Device.NinjaOneID)/custom-fields" -Method PATCH -Body $ComplianceBody -Headers @{Authorization = "Bearer $($token.access_token)" } -ContentType 'application/json'
-
+
Write-Host 'Updated NinjaOne Device Compliance'
-
+
} else {
Write-LogMessage -API 'NinjaOneSync' -user 'CIPP' -message "$($DeviceM365.displayName) ($($M365DeviceID)) was not matched in Ninja for $($tenantfilter)" -Sev 'Info'
}
}
-
+
} catch {
$Message = if ($_.ErrorDetails.Message) {
Get-NormalizedError -Message $_.ErrorDetails.Message
@@ -56,7 +56,7 @@ function Invoke-NinjaOneDeviceWebhook {
Write-Error "Failed NinjaOne Device Webhook for: $($Data | ConvertTo-Json -Depth 100) Linenumber: $($_.InvocationInfo.ScriptLineNumber) Error: $Message"
Write-LogMessage -API 'NinjaOneSync' -user 'CIPP' -message "Failed NinjaOne Device Webhook Linenumber: $($_.InvocationInfo.ScriptLineNumber) Error: $Message" -Sev 'Error'
}
-
-
+
+
}
\ No newline at end of file
diff --git a/Modules/CippExtensions/NinjaOne/Invoke-NinjaOneDocumentTemplate.ps1 b/Modules/CippExtensions/Public/NinjaOne/Invoke-NinjaOneDocumentTemplate.ps1
similarity index 100%
rename from Modules/CippExtensions/NinjaOne/Invoke-NinjaOneDocumentTemplate.ps1
rename to Modules/CippExtensions/Public/NinjaOne/Invoke-NinjaOneDocumentTemplate.ps1
diff --git a/Modules/CippExtensions/NinjaOne/Invoke-NinjaOneExtensionScheduler.ps1 b/Modules/CippExtensions/Public/NinjaOne/Invoke-NinjaOneExtensionScheduler.ps1
similarity index 97%
rename from Modules/CippExtensions/NinjaOne/Invoke-NinjaOneExtensionScheduler.ps1
rename to Modules/CippExtensions/Public/NinjaOne/Invoke-NinjaOneExtensionScheduler.ps1
index 1faf7d92c833..ca69e5b10935 100644
--- a/Modules/CippExtensions/NinjaOne/Invoke-NinjaOneExtensionScheduler.ps1
+++ b/Modules/CippExtensions/Public/NinjaOne/Invoke-NinjaOneExtensionScheduler.ps1
@@ -26,8 +26,8 @@ function Invoke-NinjaOneExtensionScheduler {
Write-Host "Current Interval: $CurrentInterval"
$CIPPMapping = Get-CIPPTable -TableName CippMapping
- $Filter = "PartitionKey eq 'NinjaOrgsMapping'"
- $TenantsToProcess = Get-AzDataTableEntity @CIPPMapping -Filter $Filter | Where-Object { $Null -ne $_.NinjaOne -and $_.NinjaOne -ne '' }
+ $Filter = "PartitionKey eq 'NinjaOneMapping'"
+ $TenantsToProcess = Get-AzDataTableEntity @CIPPMapping -Filter $Filter | Where-Object { $Null -ne $_.IntegrationId -and $_.IntegrationId -ne '' }
if ($Null -eq $LastRunTime -or $LastRunTime -le (Get-Date).addhours(-25) -or $TimeSetting -eq $CurrentInterval) {
Write-Host 'Executing'
diff --git a/Modules/CippExtensions/NinjaOne/Invoke-NinjaOneOrgMapping.ps1 b/Modules/CippExtensions/Public/NinjaOne/Invoke-NinjaOneOrgMapping.ps1
similarity index 93%
rename from Modules/CippExtensions/NinjaOne/Invoke-NinjaOneOrgMapping.ps1
rename to Modules/CippExtensions/Public/NinjaOne/Invoke-NinjaOneOrgMapping.ps1
index 6ea239b73e36..6b5687d6059f 100644
--- a/Modules/CippExtensions/NinjaOne/Invoke-NinjaOneOrgMapping.ps1
+++ b/Modules/CippExtensions/Public/NinjaOne/Invoke-NinjaOneOrgMapping.ps1
@@ -9,9 +9,9 @@ function Invoke-NinjaOneOrgMapping {
#Get available mappings
$Mappings = [pscustomobject]@{}
- $Filter = "PartitionKey eq 'NinjaOrgsMapping'"
+ $Filter = "PartitionKey eq 'NinjaOneMapping'"
Get-AzDataTableEntity @CIPPMapping -Filter $Filter | ForEach-Object {
- $Mappings | Add-Member -NotePropertyName $_.RowKey -NotePropertyValue @{ label = "$($_.NinjaOneName)"; value = "$($_.NinjaOne)" }
+ $Mappings | Add-Member -NotePropertyName $_.RowKey -NotePropertyValue @{ label = "$($_.IntegrationName)"; value = "$($_.IntegrationId)" }
}
#Get Available Tenants
@@ -81,10 +81,10 @@ function Invoke-NinjaOneOrgMapping {
$MatchedM365Tenants.add($Tenant)
$MatchedNinjaOrgs.add($MatchedOrg)
$AddObject = @{
- PartitionKey = 'NinjaOrgsMapping'
- RowKey = "$($Tenant.customerId)"
- 'NinjaOne' = "$($MatchedOrg.id)"
- 'NinjaOneName' = "$($MatchedOrg.name)"
+ PartitionKey = 'NinjaOneMapping'
+ RowKey = "$($Tenant.customerId)"
+ IntegrationId = "$($MatchedOrg.id)"
+ IntegrationName = "$($MatchedOrg.name)"
}
Add-AzDataTableEntity @CIPPMapping -Entity $AddObject -Force
Write-LogMessage -API 'NinjaOneAutoMap_Queue' -user 'CIPP' -message "Added mapping from Organization name match for $($Tenant.customerId). to $($($MatchedOrg.name))" -Sev 'Info'
diff --git a/Modules/CippExtensions/NinjaOne/Invoke-NinjaOneOrgMappingTenant.ps1 b/Modules/CippExtensions/Public/NinjaOne/Invoke-NinjaOneOrgMappingTenant.ps1
similarity index 69%
rename from Modules/CippExtensions/NinjaOne/Invoke-NinjaOneOrgMappingTenant.ps1
rename to Modules/CippExtensions/Public/NinjaOne/Invoke-NinjaOneOrgMappingTenant.ps1
index 317770c3bb78..c3f05acf1cc3 100644
--- a/Modules/CippExtensions/NinjaOne/Invoke-NinjaOneOrgMappingTenant.ps1
+++ b/Modules/CippExtensions/Public/NinjaOne/Invoke-NinjaOneOrgMappingTenant.ps1
@@ -14,7 +14,7 @@ function Invoke-NinjaOneOrgMappingTenant {
$TenantFilter = $Tenant.customerId
- $M365DevicesRaw = New-GraphGetRequest -uri "https://graph.microsoft.com/beta/deviceManagement/managedDevices" -Tenantid $tenantfilter
+ $M365DevicesRaw = New-GraphGetRequest -uri 'https://graph.microsoft.com/beta/deviceManagement/managedDevices' -Tenantid $tenantfilter
$M365Devices = foreach ($Device in $M365DevicesRaw) {
[pscustomobject]@{
@@ -28,10 +28,10 @@ function Invoke-NinjaOneOrgMappingTenant {
[System.Collections.Generic.List[PSCustomObject]]$MatchedDevices = @()
# Match devices on serial
- $DevicesToMatchSerial = $M365Devices | where-object { $null -ne $_.DeviceSerial }
+ $DevicesToMatchSerial = $M365Devices | Where-Object { $null -ne $_.DeviceSerial }
foreach ($SerialMatchDevice in $DevicesToMatchSerial) {
- $MatchedDevice = $NinjaDevices | where-object { $_.Serial -eq $SerialMatchDevice.DeviceSerial -or $_.BiosSerialNumber -eq $SerialMatchDevice.DeviceSerial }
- if (($MatchedDevice | measure-object).count -eq 1) {
+ $MatchedDevice = $NinjaDevices | Where-Object { $_.Serial -eq $SerialMatchDevice.DeviceSerial -or $_.BiosSerialNumber -eq $SerialMatchDevice.DeviceSerial }
+ if (($MatchedDevice | Measure-Object).count -eq 1) {
$Match = [pscustomobject]@{
M365 = $SerialMatchDevice
Ninja = $MatchedDevice
@@ -41,10 +41,10 @@ function Invoke-NinjaOneOrgMappingTenant {
}
# Try to match on Name
- $DevicesToMatchName = $M365Devices | where-object { $_ -notin $MatchedDevices.M365 }
+ $DevicesToMatchName = $M365Devices | Where-Object { $_ -notin $MatchedDevices.M365 }
foreach ($NameMatchDevice in $DevicesToMatchName) {
- $MatchedDevice = $NinjaDevices | where-object { $_.SystemName -eq $NameMatchDevice.DeviceName -or $_.DNSName -eq $NameMatchDevice.DeviceName }
- if (($MatchedDevice | measure-object).count -eq 1) {
+ $MatchedDevice = $NinjaDevices | Where-Object { $_.SystemName -eq $NameMatchDevice.DeviceName -or $_.DNSName -eq $NameMatchDevice.DeviceName }
+ if (($MatchedDevice | Measure-Object).count -eq 1) {
$Match = [pscustomobject]@{
M365 = $NameMatchDevice
Ninja = $MatchedDevice
@@ -56,17 +56,17 @@ function Invoke-NinjaOneOrgMappingTenant {
# Match on the Org with the most devices that match
if (($MatchedDevices.Ninja.ID | Measure-Object).Count -eq 1) {
- $MatchedOrgID = ($MatchedDevices.Ninja | group-object OrgID | sort-object Count -desc)[0].name
+ $MatchedOrgID = ($MatchedDevices.Ninja | Group-Object OrgID | Sort-Object Count -desc)[0].name
$MatchedOrg = $NinjaOrgs | Where-Object { $_.id -eq $MatchedOrgID }
$AddObject = @{
- PartitionKey = 'NinjaOrgsMapping'
- RowKey = "$($Tenant.customerId)"
- 'NinjaOne' = "$($MatchedOrg.id)"
- 'NinjaOneName' = "$($MatchedOrg.name)"
+ PartitionKey = 'NinjaOneMapping'
+ RowKey = "$($Tenant.customerId)"
+ IntegrationId = "$($MatchedOrg.id)"
+ IntegrationName = "$($MatchedOrg.name)"
}
Add-AzDataTableEntity @CIPPMapping -Entity $AddObject -Force
- Write-LogMessage -API 'NinjaOneAutoMap_Queue' -user 'CIPP' -message "Added mapping from Device match for $($Tenant.displayName) to $($($MatchedOrg.name))" -Sev 'Info'
+ Write-LogMessage -API 'NinjaOneAutoMap_Queue' -user 'CIPP' -message "Added mapping from Device match for $($Tenant.displayName) to $($($MatchedOrg.name))" -Sev 'Info'
}
diff --git a/Modules/CippExtensions/NinjaOne/Invoke-NinjaOneSync.ps1 b/Modules/CippExtensions/Public/NinjaOne/Invoke-NinjaOneSync.ps1
similarity index 91%
rename from Modules/CippExtensions/NinjaOne/Invoke-NinjaOneSync.ps1
rename to Modules/CippExtensions/Public/NinjaOne/Invoke-NinjaOneSync.ps1
index 5567ddb7c1b8..c6fb732eb30a 100644
--- a/Modules/CippExtensions/NinjaOne/Invoke-NinjaOneSync.ps1
+++ b/Modules/CippExtensions/Public/NinjaOne/Invoke-NinjaOneSync.ps1
@@ -3,8 +3,8 @@ function Invoke-NinjaOneSync {
$Table = Get-CIPPTable -TableName NinjaOneSettings
$CIPPMapping = Get-CIPPTable -TableName CippMapping
- $Filter = "PartitionKey eq 'NinjaOrgsMapping'"
- $TenantsToProcess = Get-AzDataTableEntity @CIPPMapping -Filter $Filter | Where-Object { $Null -ne $_.NinjaOne -and $_.NinjaOne -ne '' }
+ $Filter = "PartitionKey eq 'NinjaOneMapping'"
+ $TenantsToProcess = Get-AzDataTableEntity @CIPPMapping -Filter $Filter | Where-Object { $Null -ne $_.IntegrationId -and $_.IntegrationId -ne '' }
$Batch = foreach ($Tenant in $TenantsToProcess) {
diff --git a/Modules/CippExtensions/NinjaOne/Invoke-NinjaOneTenantSync.ps1 b/Modules/CippExtensions/Public/NinjaOne/Invoke-NinjaOneTenantSync.ps1
similarity index 96%
rename from Modules/CippExtensions/NinjaOne/Invoke-NinjaOneTenantSync.ps1
rename to Modules/CippExtensions/Public/NinjaOne/Invoke-NinjaOneTenantSync.ps1
index 9828682c6348..9a3b6949b056 100644
--- a/Modules/CippExtensions/NinjaOne/Invoke-NinjaOneTenantSync.ps1
+++ b/Modules/CippExtensions/Public/NinjaOne/Invoke-NinjaOneTenantSync.ps1
@@ -6,13 +6,13 @@ function Invoke-NinjaOneTenantSync {
try {
$StartQueueTime = Get-Date
Write-Host "$(Get-Date) - Starting NinjaOne Sync"
-
- # Stagger start
+
+ # Stagger start
# Check Global Rate Limiting
- $CurrentMap = Get-ExtensionRateLimit -ExtensionName 'NinjaOne' -ExtensionPartitionKey 'NinjaOrgsMapping' -RateLimit 5 -WaitTime 10
+ $CurrentMap = Get-ExtensionRateLimit -ExtensionName 'NinjaOne' -ExtensionPartitionKey 'NinjaOneMapping' -RateLimit 5 -WaitTime 10
$StartTime = Get-Date
-
+
# Parse out the Tenant we are processing
$MappedTenant = $QueueItem.MappedTenant
@@ -21,7 +21,7 @@ function Invoke-NinjaOneTenantSync {
$StartDate = try { Get-Date($CurrentItem.lastStartTime) } catch { $Null }
$EndDate = try { Get-Date($CurrentItem.lastEndTime) } catch { $Null }
-
+
if (($null -ne $CurrentItem.lastStartTime) -and ($StartDate -gt (Get-Date).AddMinutes(-10)) -and ( $Null -eq $CurrentItem.lastEndTime -or ($StartDate -gt $EndDate))) {
Throw "NinjaOne Sync for Tenant $($MappedTenant.RowKey) is still running, please wait 10 minutes and try again."
}
@@ -40,19 +40,19 @@ function Invoke-NinjaOneTenantSync {
$Table = Get-CIPPTable -TableName NinjaOneSettings
$NinjaSettings = (Get-CIPPAzDataTableEntity @Table)
$CIPPUrl = ($NinjaSettings | Where-Object { $_.RowKey -eq 'CIPPURL' }).SettingValue
-
-
- $Customer = Get-Tenants | Where-Object { $_.customerId -eq $MappedTenant.RowKey }
+
+
+ $Customer = Get-Tenants -IncludeErrors | Where-Object { $_.customerId -eq $MappedTenant.RowKey }
Write-Host "Processing: $($Customer.displayName) - Queued for $((New-TimeSpan -Start $StartQueueTime -End $StartTime).TotalSeconds)"
- Write-LogMessage -API 'NinjaOneSync' -user 'NinjaOneSync' -message "Processing NinjaOne Synchronization for $($Customer.displayName) - Queued for $((New-TimeSpan -Start $StartQueueTime -End $StartTime).TotalSeconds)" -Sev 'Info'
+ Write-LogMessage -API 'NinjaOneSync' -user 'NinjaOneSync' -message "Processing NinjaOne Synchronization for $($Customer.displayName) - Queued for $((New-TimeSpan -Start $StartQueueTime -End $StartTime).TotalSeconds)" -Sev 'Info'
if (($Customer | Measure-Object).count -ne 1) {
Throw "Unable to match the recieved ID to a tenant QueueItem: $($QueueItem | ConvertTo-Json -Depth 100 | Out-String) Matched Customer: $($Customer| ConvertTo-Json -Depth 100 | Out-String)"
}
$TenantFilter = $Customer.defaultDomainName
- $NinjaOneOrg = $MappedTenant.NinjaOne
+ $NinjaOneOrg = $MappedTenant.IntegrationId
# Get the NinjaOne general extension settings.
@@ -62,9 +62,9 @@ function Invoke-NinjaOneTenantSync {
# Pull the list of field Mappings so we know which fields to render.
$MappedFields = [pscustomobject]@{}
$CIPPMapping = Get-CIPPTable -TableName CippMapping
- $Filter = "PartitionKey eq 'NinjaFieldMapping'"
- Get-CIPPAzDataTableEntity @CIPPMapping -Filter $Filter | Where-Object { $Null -ne $_.NinjaOne -and $_.NinjaOne -ne '' } | ForEach-Object {
- $MappedFields | Add-Member -NotePropertyName $_.RowKey -NotePropertyValue $($_.NinjaOne)
+ $Filter = "PartitionKey eq 'NinjaOneFieldMapping'"
+ Get-CIPPAzDataTableEntity @CIPPMapping -Filter $Filter | Where-Object { $Null -ne $_.IntegrationId -and $_.IntegrationId -ne '' } | ForEach-Object {
+ $MappedFields | Add-Member -NotePropertyName $_.RowKey -NotePropertyValue $($_.IntegrationId)
}
# Get NinjaOne Devices
@@ -76,14 +76,14 @@ function Invoke-NinjaOneTenantSync {
$Result
$ResultCount = ($Result.id | Measure-Object -Maximum)
$After = $ResultCount.maximum
-
+
} while ($ResultCount.count -eq $PageSize)
Write-Host 'Fetched NinjaOne Devices'
-
+
[System.Collections.Generic.List[PSCustomObject]]$NinjaOneUserDocs = @()
- if ($Configuration.UserDocumentsEnabled -eq $True) {
+ if ($Configuration.UserDocumentsEnabled -eq $True) {
# Get NinjaOne User Documents
$UserDocTemplate = [PSCustomObject]@{
name = 'CIPP - Microsoft 365 Users'
@@ -169,7 +169,7 @@ function Invoke-NinjaOneTenantSync {
# Get NinjaOne Users
[System.Collections.Generic.List[PSCustomObject]]$NinjaOneUserDocs = ((Invoke-WebRequest -Uri "https://$($Configuration.Instance)/api/v2/organization/documents?organizationIds=$($NinjaOneOrg)&templateIds=$($NinjaOneUsersTemplate.id)" -Method GET -Headers @{Authorization = "Bearer $($token.access_token)" } -ContentType 'application/json').content | ConvertFrom-Json -Depth 100)
-
+
foreach ($NinjaDoc in $NinjaOneUserDocs) {
$ParsedFields = [pscustomobject]@{}
foreach ($Field in $NinjaDoc.Fields) {
@@ -185,7 +185,7 @@ function Invoke-NinjaOneTenantSync {
Write-Host 'Fetched NinjaOne User Docs'
}
-
+
[System.Collections.Generic.List[PSCustomObject]]$NinjaOneLicenseDocs = @()
if ($Configuration.LicenseDocumentsEnabled) {
# NinjaOne License Documents
@@ -236,10 +236,10 @@ function Invoke-NinjaOneTenantSync {
}
$NinjaOneLicenseTemplate = Invoke-NinjaOneDocumentTemplate -Template $LicenseDocTemplate -Token $Token
-
+
# Get NinjaOne Licenses
[System.Collections.Generic.List[PSCustomObject]]$NinjaOneLicenseDocs = ((Invoke-WebRequest -Uri "https://$($Configuration.Instance)/api/v2/organization/documents?organizationIds=$($NinjaOneOrg)&templateIds=$($NinjaOneLicenseTemplate.id)" -Method GET -Headers @{Authorization = "Bearer $($token.access_token)" } -ContentType 'application/json').content | ConvertFrom-Json -Depth 100)
-
+
foreach ($NinjaLic in $NinjaOneLicenseDocs) {
$ParsedFields = [pscustomobject]@{}
foreach ($Field in $NinjaLic.Fields) {
@@ -328,8 +328,8 @@ function Invoke-NinjaOneTenantSync {
id = 'Subscriptions'
method = 'GET'
url = '/directory/subscriptions'
- }
-
+ }
+
)
Write-Verbose "$(Get-Date) - Fetching Bulk Data"
@@ -346,14 +346,14 @@ function Invoke-NinjaOneTenantSync {
$SecureScore = Get-GraphBulkResultByID -value -Results $TenantResults -ID 'SecureScore'
$Subscriptions = Get-GraphBulkResultByID -value -Results $TenantResults -ID 'Subscriptions'
-
+
[System.Collections.Generic.List[PSCustomObject]]$SecureScoreProfiles = Get-GraphBulkResultByID -value -Results $TenantResults -ID 'SecureScoreControlProfiles'
$CurrentSecureScore = ($SecureScore | Sort-Object createDateTime -Descending | Select-Object -First 1)
$MaxSecureScoreRank = ($SecureScoreProfiles.rank | Measure-Object -Maximum).maximum
$MaxSecureScore = $CurrentSecureScore.maxScore
-
+
[System.Collections.Generic.List[PSCustomObject]]$SecureScoreParsed = Foreach ($Score in $CurrentSecureScore.controlScores) {
$MatchedProfile = $SecureScoreProfiles | Where-Object { $_.id -eq $Score.controlName }
[PSCustomObject]@{
@@ -368,20 +368,20 @@ function Invoke-NinjaOneTenantSync {
maxScore = $MatchedProfile.maxScore
rank = $MatchedProfile.rank
adjustedRank = $MaxSecureScoreRank - $MatchedProfile.rank
-
+
}
}
$TenantDetails = Get-GraphBulkResultByID -value -Results $TenantResults -ID 'TenantDetails'
Write-Verbose "$(Get-Date) - Parsing Users"
- # Grab licensed users
- $licensedUsers = $Users | Where-Object { $null -ne $_.AssignedLicenses.SkuId } | Sort-Object UserPrincipalName
-
- Write-Verbose "$(Get-Date) - Parsing Roles"
+ # Grab licensed users
+ $licensedUsers = $Users | Where-Object { $null -ne $_.AssignedLicenses.SkuId } | Sort-Object UserPrincipalName
+
+ Write-Verbose "$(Get-Date) - Parsing Roles"
# Get All Roles
$AllRoles = Get-GraphBulkResultByID -value -Results $TenantResults -ID 'AllRoles'
-
+
$SelectList = 'id', 'displayName', 'userPrincipalName'
[System.Collections.Generic.List[PSCustomObject]]$RolesRequestArray = @()
@@ -410,11 +410,11 @@ function Invoke-NinjaOneTenantSync {
ParsedMembers = $Result.body.value.Displayname -join ', '
}
}
-
+
$AdminUsers = (($Roles | Where-Object { $_.Displayname -match 'Administrator' }).Members | Where-Object { $null -ne $_.displayName })
-
+
Write-Verbose "$(Get-Date) - Fetching Domains"
try {
$RawDomains = Get-GraphBulkResultByID -value -Results $TenantResults -ID 'RawDomains'
@@ -422,8 +422,8 @@ function Invoke-NinjaOneTenantSync {
$RawDomains = $null
}
$customerDomains = ($RawDomains | Where-Object { $_.IsVerified -eq $True }).id -join ', ' | Out-String
-
-
+
+
Write-Verbose "$(Get-Date) - Parsing Licenses"
# Get Licenses
$Licenses = Get-GraphBulkResultByID -value -Results $TenantResults -ID 'Licenses'
@@ -432,7 +432,7 @@ function Invoke-NinjaOneTenantSync {
if ($Licenses) {
$LicensesParsed = $Licenses | Where-Object { $_.PrepaidUnits.Enabled -gt 0 } | Select-Object @{N = 'License Name'; E = { (Get-Culture).TextInfo.ToTitleCase((convert-skuname -skuname $_.SkuPartNumber).Tolower()) } }, @{N = 'Active'; E = { $_.PrepaidUnits.Enabled } }, @{N = 'Consumed'; E = { $_.ConsumedUnits } }, @{N = 'Unused'; E = { $_.PrepaidUnits.Enabled - $_.ConsumedUnits } }
}
-
+
Write-Verbose "$(Get-Date) - Parsing Devices"
# Get all devices from Intune
$devices = Get-GraphBulkResultByID -value -Results $TenantResults -ID 'Devices'
@@ -440,7 +440,7 @@ function Invoke-NinjaOneTenantSync {
Write-Verbose "$(Get-Date) - Parsing Device Compliance Polcies"
# Fetch Compliance Policy Status
$DeviceCompliancePolicies = Get-GraphBulkResultByID -value -Results $TenantResults -ID 'DeviceCompliancePolicies'
-
+
# Get the status of each device for each policy
[System.Collections.Generic.List[PSCustomObject]]$PolicyRequestArray = @()
foreach ($CompliancePolicy in $DeviceCompliancePolicies) {
@@ -466,9 +466,9 @@ function Invoke-NinjaOneTenantSync {
DeviceStatuses = $Result.body.value
}
}
-
+
Write-Verbose "$(Get-Date) - Parsing Groups"
- # Fetch Groups
+ # Fetch Groups
$AllGroups = Get-GraphBulkResultByID -value -Results $TenantResults -ID 'Groups'
# Fetch the App status for each device
@@ -492,7 +492,7 @@ function Invoke-NinjaOneTenantSync {
$Groups = foreach ($Result in $GroupMembersReturn) {
[pscustomobject]@{
ID = $Result.id
- DisplayName = ($AllGroups | Where-Object { $_.id -eq $Result.id }).DisplayName
+ DisplayName = ($AllGroups | Where-Object { $_.id -eq $Result.id }).DisplayName
Members = $result.body.value
}
}
@@ -555,10 +555,10 @@ function Invoke-NinjaOneTenantSync {
Members = $CAMembers
}
}
-
+
Write-Verbose "$(Get-Date) - Fetching One Drive Details"
try {
- $OneDriveDetails = New-GraphGetRequest -uri "https://graph.microsoft.com/beta/reports/getOneDriveUsageAccountDetail(period='D7')" -tenantid $TenantFilter | ConvertFrom-Csv
+ $OneDriveDetails = New-GraphGetRequest -uri "https://graph.microsoft.com/beta/reports/getOneDriveUsageAccountDetail(period='D7')" -tenantid $TenantFilter | ConvertFrom-Csv
} catch {
Write-Error "Failed to fetch Onedrive Details: $_"
$OneDriveDetails = $null
@@ -571,7 +571,7 @@ function Invoke-NinjaOneTenantSync {
Write-Error "Failed to fetch CAS Details: $_"
$CASFull = $null
}
-
+
Write-Verbose "$(Get-Date) - Fetching Mailbox Details"
try {
$MailboxDetailedFull = New-ExoRequest -TenantID $Customer.defaultDomainName -cmdlet 'Get-Mailbox'
@@ -590,12 +590,12 @@ function Invoke-NinjaOneTenantSync {
Write-Verbose "$(Get-Date) - Fetching Mailbox Stats"
try {
- $MailboxStatsFull = New-GraphGetRequest -uri "https://graph.microsoft.com/v1.0/reports/getMailboxUsageDetail(period='D7')" -tenantid $TenantFilter | ConvertFrom-Csv
+ $MailboxStatsFull = New-GraphGetRequest -uri "https://graph.microsoft.com/v1.0/reports/getMailboxUsageDetail(period='D7')" -tenantid $TenantFilter | ConvertFrom-Csv
} catch {
Write-Error "Failed to fetch Mailbox Stats: $_"
$MailboxStatsFull = $null
}
-
+
Write-Host 'Fetched M365 Additional Data'
@@ -604,7 +604,7 @@ function Invoke-NinjaOneTenantSync {
############################ Format and Synchronize to NinjaOne ############################
$DeviceTable = Get-CippTable -tablename 'CacheNinjaOneParsedDevices'
$DeviceMapTable = Get-CippTable -tablename 'NinjaOneDeviceMap'
-
+
$DeviceFilter = "PartitionKey eq '$($Customer.CustomerId)'"
[System.Collections.Generic.List[PSCustomObject]]$RawParsedDevices = Get-CIPPAzDataTableEntity @DeviceTable -Filter $DeviceFilter
@@ -621,13 +621,13 @@ function Invoke-NinjaOneTenantSync {
# Parse Devices
Foreach ($Device in $Devices | Where-Object { $_.id -notin $ParsedDevices.id }) {
-
+
# First lets match on serial
$MatchedNinjaDevice = $NinjaDevices | Where-Object { $_.system.biosSerialNumber -eq $Device.SerialNumber -or $_.system.serialNumber -eq $Device.SerialNumber }
# See if we found just one device, if not match on name
if (($MatchedNinjaDevice | Measure-Object).count -ne 1) {
- $MatchedNinjaDevice = $NinjaDevices | Where-Object { $_.systemName -eq $Device.Name -or $_.dnsName -eq $Device.Name }
+ $MatchedNinjaDevice = $NinjaDevices | Where-Object { $_.systemName -eq $Device.Name -or $_.dnsName -eq $Device.Name }
}
# Check on a match again and set name
@@ -658,8 +658,8 @@ function Invoke-NinjaOneTenantSync {
Add-CIPPAzDataTableEntity @DeviceMapTable -Entity $MappedDevice -Force
}
-
-
+
+
Foreach ($DeviceUser in $Device.usersloggedon) {
$FoundUser = ($Users | Where-Object { $_.id -eq $DeviceUser.userid })
@@ -690,7 +690,7 @@ function Invoke-NinjaOneTenantSync {
})
}
}
-
+
}
}
@@ -743,7 +743,7 @@ function Invoke-NinjaOneTenantSync {
} -Force
$ParsedDevices.add($ParsedDevice)
-
+
### Update NinjaOne Device Fields
if ($MatchedNinjaDevice) {
$NinjaDeviceUpdate = [PSCustomObject]@{}
@@ -767,7 +767,7 @@ function Invoke-NinjaOneTenantSync {
)
-
+
$DeviceLinksHTML = Get-NinjaOneLinks -Data $DeviceLinksData -SmallCols 2 -MedCols 3 -LargeCols 3 -XLCols 3
$DeviceLinksHtml = '
'
@@ -778,7 +778,7 @@ function Invoke-NinjaOneTenantSync {
}
if ($MappedFields.DeviceSummary) {
-
+
# Set Compliance Status
if ($Device.complianceState -eq 'compliant') {
$Compliance = '
Compliant'
@@ -795,9 +795,9 @@ function Invoke-NinjaOneTenantSync {
'Enrolled' = $Device.enrolledDateTime
'Last Checkin' = $Device.lastSyncDateTime
'Compliant' = $Compliance
- 'Management Type' = $Device.managementAgent
+ 'Management Type' = $Device.managementAgent
}
-
+
$DeviceDetailsCard = Get-NinjaOneInfoCard -Title 'Device Details' -Data $DeviceDetailsData -Icon 'fas fa-laptop'
# Device Hardware
@@ -808,8 +808,8 @@ function Invoke-NinjaOneTenantSync {
'Chassis' = $Device.chassisType
'Model' = $Device.model
'Manufacturer' = $Device.manufacturer
- }
-
+ }
+
$DeviceHardwareCard = Get-NinjaOneInfoCard -Title 'Device Details' -Data $DeviceHardwareData -Icon 'fas fa-microchip'
# Device Enrollment
@@ -821,8 +821,8 @@ function Invoke-NinjaOneTenantSync {
'Device Guard Requirements' = $Device.hardwareinformation.deviceGuardVirtualizationBasedSecurityHardwareRequirementState
'Virtualistation Based Security' = $Device.hardwareinformation.deviceGuardVirtualizationBasedSecurityState
'Credential Guard' = $Device.hardwareinformation.deviceGuardLocalSystemAuthorityCredentialGuardState
- }
-
+ }
+
$DeviceEnrollmentCard = Get-NinjaOneInfoCard -Title 'Device Enrollment' -Data $DeviceEnrollmentData -Icon 'fas fa-table-list'
@@ -831,7 +831,7 @@ function Invoke-NinjaOneTenantSync {
$DevicePoliciesHTML = ([System.Web.HttpUtility]::HtmlDecode($DevicePoliciesFormatted) -replace '
', ' | ') -replace ' | ', ' | '
$TitleLink = "https://intune.microsoft.com/$($Customer.defaultDomainName)/#view/Microsoft_Intune_Devices/DeviceSettingsMenuBlade/~/compliance/mdmDeviceId/$($Device.id)/primaryUserId/"
$DeviceCompliancePoliciesCard = Get-NinjaOneCard -Title 'Device Compliance Policies' -Body $DevicePoliciesHTML -Icon 'fas fa-list-check' -TitleLink $TitleLink
-
+
# Device Groups
$DeviceGroupsTable = foreach ($Group in $Groups) {
if ($device.azureADDeviceId -in $Group.members.deviceId) {
@@ -844,16 +844,16 @@ function Invoke-NinjaOneTenantSync {
$DeviceGroupsHTML = ([System.Web.HttpUtility]::HtmlDecode($DeviceGroupsFormatted) -replace ' | ', ' | ') -replace ' | ', ' | '
$DeviceGroupsCard = Get-NinjaOneCard -Title 'Device Groups' -Body $DeviceGroupsHTML -Icon 'fas fa-layer-group'
- $DeviceSummaryHTML = '' +
- ' ' + $DeviceDetailsCard +
+ $DeviceSummaryHTML = ' ' +
+ ' ' + $DeviceDetailsCard +
' ' + $DeviceHardwareCard +
- ' ' + $DeviceEnrollmentCard +
+ ' ' + $DeviceEnrollmentCard +
' ' + $DeviceCompliancePoliciesCard +
' ' + $DeviceGroupsCard +
' '
-
- $NinjaDeviceUpdate | Add-Member -NotePropertyName $MappedFields.DeviceSummary -NotePropertyValue @{'html' = $DeviceSummaryHTML }
- }
+
+ $NinjaDeviceUpdate | Add-Member -NotePropertyName $MappedFields.DeviceSummary -NotePropertyValue @{'html' = $DeviceSummaryHTML }
+ }
}
if ($MappedFields.DeviceCompliance) {
@@ -863,7 +863,7 @@ function Invoke-NinjaOneTenantSync {
$Compliant = 'Non-Compliant'
}
$NinjaDeviceUpdate | Add-Member -NotePropertyName $MappedFields.DeviceCompliance -NotePropertyValue $Compliant
-
+
}
# Update Device
@@ -888,11 +888,11 @@ function Invoke-NinjaOneTenantSync {
$SyncUsers = $Users
}
-
+
$UsersTable = Get-CippTable -tablename 'CacheNinjaOneParsedUsers'
$UsersUpdateTable = Get-CippTable -tablename 'CacheNinjaOneUsersUpdate'
$UsersMapTable = Get-CippTable -tablename 'NinjaOneUserMap'
-
+
$UsersFilter = "PartitionKey eq '$($Customer.CustomerId)'"
[System.Collections.Generic.List[PSCustomObject]]$ParsedUsers = Get-CIPPAzDataTableEntity @UsersTable -Filter $UsersFilter
@@ -923,7 +923,7 @@ function Invoke-NinjaOneTenantSync {
foreach ($user in $SyncUsers | Where-Object { $_.id -notin $ParsedUsers.RowKey }) {
try {
-
+
$NinjaOneUser = $NinjaOneUserDocs | Where-Object { $_.ParsedFields.cippUserID -eq $User.ID }
if (($NinjaOneUser | Measure-Object).count -gt 1) {
Throw 'Multiple Users with the same ID found'
@@ -1010,7 +1010,7 @@ function Invoke-NinjaOneTenantSync {
$MatchedNinjaDevice = $UserDevice.NinjaDevice
$ParsedDeviceName = $UserDevice.DeviceLink
-
+
# Set Last Login Time
$LastLoginTime = ($UserDevice.UserDetails | Where-Object { $_.id -eq $User.id }).lastLogin
if (!$LastLoginTime) {
@@ -1033,7 +1033,7 @@ function Invoke-NinjaOneTenantSync {
}
' ' + "$ComplianceIcon $OSIcon $($ParsedDeviceName) ($LastLoginTime)"
-
+
}
@@ -1048,7 +1048,7 @@ function Invoke-NinjaOneTenantSync {
} catch {}
}) -join ''
-
+
$UserOneDriveStats = $OneDriveDetails | Where-Object { $_.'Owner Principal Name' -eq $User.userPrincipalName } | Select-Object -First 1
$UserOneDriveUse = $UserOneDriveStats.'Storage Used (Byte)' / 1GB
@@ -1083,7 +1083,7 @@ function Invoke-NinjaOneTenantSync {
$OneDriveParsed = 'Not Enabled'
}
-
+
if ($UserOneDriveStats) {
$OneDriveCardData = [PSCustomObject]@{
'One Drive URL' = ' ' + ($UserOneDriveStats.'Site URL') + ''
@@ -1100,9 +1100,9 @@ function Invoke-NinjaOneTenantSync {
$OneDriveCardData = [PSCustomObject]@{
'One Drive' = 'Disabled'
}
- }
+ }
+
-
$UserMailboxStats = $MailboxStatsFull | Where-Object { $_.'User Principal Name' -eq $User.userPrincipalName } | Select-Object -First 1
$UserMailUse = $UserMailboxStats.'Storage Used (Byte)' / 1GB
$UserMailTotal = $UserMailboxStats.'Prohibit Send/Receive Quota (Byte)' / 1GB
@@ -1243,7 +1243,7 @@ function Invoke-NinjaOneTenantSync {
"@
-
+
# Return Data for Users Summary Table
$ParsedUser = [PSCustomObject]@{
@@ -1264,8 +1264,8 @@ function Invoke-NinjaOneTenantSync {
Add-CIPPAzDataTableEntity @UsersTable -Entity $ParsedUser -Force
$ParsedUsers.add($ParsedUser)
-
-
+
+
if ($Configuration.UserDocumentsEnabled -eq $True) {
# Format into Ninja HTML
@@ -1283,13 +1283,13 @@ function Invoke-NinjaOneTenantSync {
$UserPolciesCard = Get-NinjaOneCard -Title 'Assigned Conditional Access Policies' -Body $UserPoliciesFormatted
- $UserSummaryHTML = ' ' +
- ' ' + $UserOverviewCardHTML +
+ $UserSummaryHTML = ' ' +
+ ' ' + $UserOverviewCardHTML +
' ' + $MailboxDetailsCardHTML +
' ' + $MailboxSettingsCardHTML +
- ' ' + $OneDriveCardHTML +
- ' ' + $UserPolciesCard +
- ' ' + $DeviceSummaryCardHTML +
+ ' ' + $OneDriveCardHTML +
+ ' ' + $UserPolciesCard +
+ ' ' + $DeviceSummaryCardHTML +
' '
@@ -1301,10 +1301,10 @@ function Invoke-NinjaOneTenantSync {
@{n = 'State'; e = { $_.Compliance } },
@{n = 'Model'; e = { $_.Model } },
@{n = 'Manufacturer'; e = { $_.Make } }
-
+
$UserDeviceDetailHTML = $UserDeviceDetailsTable | ConvertTo-Html -As Table -Fragment
$UserDeviceDetailHTML = ([System.Web.HttpUtility]::HtmlDecode($UserDeviceDetailHTML) -replace ' ', ' | ') -replace ' | ', ' | '
-
+
$UserFields = @{
cippUserLinks = @{'html' = $UserLinksHTML }
@@ -1361,7 +1361,7 @@ function Invoke-NinjaOneTenantSync {
} Catch {
Write-Host "Bulk Creation Error, but may have been successful as only 1 record with an issue could have been the cause: $_"
}
-
+
try {
# Update Users
if (($NinjaUserUpdates | Measure-Object).count -ge 100) {
@@ -1385,7 +1385,7 @@ function Invoke-NinjaOneTenantSync {
} else {
$Field = $UserDoc.fields | Where-Object { $_.name -eq 'cippUserID' }
}
-
+
if ($Null -ne $Field.value -and $Field.value -ne '') {
$MappedUser = ($UsersMap | Where-Object { $_.M365ID -eq $Field.value })
@@ -1411,15 +1411,15 @@ function Invoke-NinjaOneTenantSync {
}
-
+
}
} catch {
Write-Error "User $($User.UserPrincipalName): A fatal error occured while processing user $_"
}
-
+
}
-
+
$CreatedUsers = $Null
$UpdatedUsers = $Null
@@ -1431,12 +1431,12 @@ function Invoke-NinjaOneTenantSync {
Write-Host 'Creating NinjaOne Users'
[System.Collections.Generic.List[PSCustomObject]]$CreatedUsers = (Invoke-WebRequest -Uri "https://$($Configuration.Instance)/api/v2/organization/documents" -Method POST -Headers @{Authorization = "Bearer $($token.access_token)" } -ContentType 'application/json; charset=utf-8' -Body ("[$($NinjaUserCreation.body -join ',')]") -EA Stop).content | ConvertFrom-Json -Depth 100
Remove-AzDataTableEntity @UsersUpdateTable -Entity $NinjaUserCreation
-
+
}
} Catch {
Write-Host "Bulk Creation Error, but may have been successful as only 1 record with an issue could have been the cause: $_"
}
-
+
try {
# Update Users
if (($NinjaUserUpdates | Measure-Object).count -ge 1) {
@@ -1450,8 +1450,8 @@ function Invoke-NinjaOneTenantSync {
### Relationship Mapping
# Parse out the NinjaOne ID to MS ID
-
-
+
+
[System.Collections.Generic.List[PSCustomObject]]$UserDocResults = $UpdatedUsers + $CreatedUsers
if (($UserDocResults | Where-Object { $Null -ne $_ -and $_ -ne '' } | Measure-Object).count -ge 1) {
@@ -1462,7 +1462,7 @@ function Invoke-NinjaOneTenantSync {
} else {
$Field = $UserDoc.fields | Where-Object { $_.name -eq 'cippUserID' }
}
-
+
if ($Null -ne $Field.value -and $Field.value -ne '') {
$MappedUser = ($UsersMap | Where-Object { $_.M365ID -eq $Field.value })
@@ -1486,8 +1486,8 @@ function Invoke-NinjaOneTenantSync {
}
}
-
-
+
+
# Relate Users to Devices
Foreach ($LinkDevice in $ParsedDevices | Where-Object { $null -ne $_.NinjaDevice }) {
$RelatedItems = (Invoke-WebRequest -Uri "https://$($Configuration.Instance)/api/v2/related-items/with-entity/NODE/$($LinkDevice.NinjaDevice.id)" -Method GET -Headers @{Authorization = "Bearer $($token.access_token)" } -ContentType 'application/json').content | ConvertFrom-Json -Depth 100
@@ -1507,7 +1507,7 @@ function Invoke-NinjaOneTenantSync {
}
}
-
+
try {
# Update Relations
@@ -1534,7 +1534,7 @@ function Invoke-NinjaOneTenantSync {
$FriendlyLicenseName = $License.SkuPartNumber
}
-
+
$LicenseUsers = foreach ($SubUser in $Users) {
$MatchedLicense = $SubUser.assignedLicenses | Where-Object { $License.skuId -in $_.skuId }
$MatchedPlans = $SubUser.AssignedPlans | Where-Object { $_.servicePlanId -in $License.servicePlans.servicePlanID }
@@ -1551,7 +1551,7 @@ function Invoke-NinjaOneTenantSync {
'License Assigned' = $(try { $(Get-Date(($MatchedPlans | Group-Object assignedDateTime | Sort-Object Count -Desc | Select-Object -First 1).name) -Format u) } catch { 'Unknown' })
NinjaUserDocID = $SubRelUserID
}
- }
+ }
}
$LicenseUsersHTML = $LicenseUsers | Select-Object -ExcludeProperty NinjaUserDocID | ConvertTo-Html -As Table -Fragment
@@ -1578,12 +1578,12 @@ function Invoke-NinjaOneTenantSync {
$LicenseItemsTable = $License.servicePlans | Select-Object @{n = 'Plan Name'; e = { convert-skuname -skuname $_.servicePlanName } }, @{n = 'Applies To'; e = { $_.appliesTo } }, @{n = 'Provisioning Status'; e = { $_.provisioningStatus } }
$LicenseItemsHTML = $LicenseItemsTable | ConvertTo-Html -As Table -Fragment
$LicenseItemsHTML = ([System.Web.HttpUtility]::HtmlDecode($LicenseItemsHTML) -replace ' | ', ' | ') -replace ' | ', ' | '
-
+
$LicenseItemsCardHTML = Get-NinjaOneCard -Title 'License Items' -Body $LicenseItemsHTML -Icon 'fas fa-chart-bar'
- $LicenseSummaryHTML = '' +
- ' ' + $LicenseOverviewCardHTML +
+ $LicenseSummaryHTML = ' ' +
+ ' ' + $LicenseOverviewCardHTML +
' ' + $SubscriptionCardHTML +
' ' + $LicenseItemsCardHTML +
' '
@@ -1630,7 +1630,7 @@ function Invoke-NinjaOneTenantSync {
} Catch {
Write-Host "Bulk Creation Error, but may have been successful as only 1 record with an issue could have been the cause: $_"
}
-
+
try {
# Update Subscriptions
if (($NinjaLicenseUpdates | Measure-Object).count -ge 1) {
@@ -1663,7 +1663,7 @@ function Invoke-NinjaOneTenantSync {
)
}
}
-
+
try {
# Update Relations
@@ -1750,7 +1750,7 @@ function Invoke-NinjaOneTenantSync {
$M365LinksHTML = Get-NinjaOneLinks -Data $ManagementLinksData -Title 'Portals' -SmallCols 2 -MedCols 3 -LargeCols 3 -XLCols 3
$CIPPLinksData = @(
-
+
@{
Name = 'CIPP Tenant Dashboard'
Link = "https://$CIPPUrl/home?customerId=$($Customer.CustomerId)"
@@ -1802,8 +1802,8 @@ function Invoke-NinjaOneTenantSync {
### Tenant Overview Card
$ParsedAdmins = [PSCustomObject]@{}
-
- $AdminUsers | Select-Object displayname, userPrincipalName -Unique | ForEach-Object {
+
+ $AdminUsers | Select-Object displayname, userPrincipalName -Unique | ForEach-Object {
$ParsedAdmins | Add-Member -NotePropertyName $_.displayname -NotePropertyValue $_.userPrincipalName
}
@@ -1814,7 +1814,7 @@ function Invoke-NinjaOneTenantSync {
'Creation Date' = $TenantDetails.createdDateTime
'Domains' = $customerDomains
'Admin Users' = ($AdminUsers | ForEach-Object { "$($_.DisplayName)" }) -join ', '
-
+
}
$TenantSummaryCard = Get-NinjaOneInfoCard -Title 'Tenant Details' -Data $TenantDetailsItems -Icon 'fas fa-building'
@@ -1826,8 +1826,8 @@ function Invoke-NinjaOneTenantSync {
$LicensedUsersCount = ($licensedUsers | Measure-Object).count
$UnlicensedUsersCount = $TotalUsersCount - $GuestUsersCount - $LicensedUsersCount
$UsersEnabledCount = ($Users | Where-Object { $_.accountEnabled -eq $True } | Measure-Object).count
-
- # Enabled Users
+
+ # Enabled Users
$Data = @(
@{
@@ -1841,10 +1841,10 @@ function Invoke-NinjaOneTenantSync {
Colour = '#D53948'
}
)
-
-
+
+
$UsersEnabledChartHTML = Get-NinjaInLineBarGraph -Title 'User Status' -Data $Data -KeyInLine
-
+
# User Types
$Data = @(
@@ -1863,8 +1863,8 @@ function Invoke-NinjaOneTenantSync {
Amount = $GuestUsersCount
Colour = '#8063BF'
}
- )
-
+ )
+
$UsersTypesChartHTML = Get-NinjaInLineBarGraph -Title 'User Types' -Data $Data -KeyInLine
# Create the Users Card
@@ -1901,8 +1901,8 @@ function Invoke-NinjaOneTenantSync {
Colour = '#D53948'
}
)
-
-
+
+
$DeviceComplianceChartHTML = Get-NinjaInLineBarGraph -Title 'Device Compliance' -Data $Data -KeyInLine
# Device OS Types
@@ -1928,8 +1928,8 @@ function Invoke-NinjaOneTenantSync {
Amount = $IOSCount
Colour = '#007AFF'
}
- )
-
+ )
+
$DeviceOsChartHTML = Get-NinjaInLineBarGraph -Title 'Device Operating Systems' -Data $Data -KeyInLine
# Last online time
@@ -1946,7 +1946,7 @@ function Invoke-NinjaOneTenantSync {
Colour = '#CCCCCC'
}
)
-
+
$DeviceOnlineChartHTML = Get-NinjaInLineBarGraph -Title 'Devices Online in the last 30 days' -Data $Data -KeyInLine
# Create the Devices Card
@@ -1974,7 +1974,7 @@ function Invoke-NinjaOneTenantSync {
Colour = '#CCCCCC'
}
)
-
+
$SecureScoreHTML = Get-NinjaInLineBarGraph -Title "Secure Score - $([System.Math]::Round((($CurrentSecureScore.currentScore / $MaxSecureScore) * 100),2))%" -Data $Data -KeyInLine -NoCount -NoSort
# Recommended Actions HTML
@@ -1995,7 +1995,7 @@ function Invoke-NinjaOneTenantSync {
$Table = Get-CippTable -tablename 'standards'
- $Filter = "PartitionKey eq 'standards'"
+ $Filter = "PartitionKey eq 'standards'"
$AllStandards = (Get-CIPPAzDataTableEntity @Table -Filter $Filter).JSON | ConvertFrom-Json -Depth 100
@@ -2025,11 +2025,11 @@ function Invoke-NinjaOneTenantSync {
Write-Host 'License Details'
$LicenseTableHTML = $LicensesParsed | Sort-Object 'License Name' | ConvertTo-Html -As Table -Fragment
$LicenseTableHTML = ' ' + (([System.Web.HttpUtility]::HtmlDecode($LicenseTableHTML) -replace ' ', ' | ') -replace ' | ', ' | ') + ''
-
+
$TitleLink = "https://$CIPPUrl/tenant/administration/list-licenses?customerId=$($Customer.customerId)"
$LicensesSummaryCardHTML = Get-NinjaOneCard -Title 'Licenses' -Body $LicenseTableHTML -Icon 'fas fa-chart-bar' -TitleLink $TitleLink
-
+
### Summary Stats
Write-Host 'Widget Details'
@@ -2056,7 +2056,7 @@ function Invoke-NinjaOneTenantSync {
# Colour = $ResultColour
# Link = "https://$CIPPUrl/tenant/standards/bpa-report?SearchNow=true&Report=CIPP+Best+Practices+v1.0+-+Tenant+view&tenantFilter=$($Customer.customerId)"
# })
-
+
# Unused Licenses
$WidgetData.add([PSCustomObject]@{
Value = $(
@@ -2076,15 +2076,15 @@ function Invoke-NinjaOneTenantSync {
Colour = $ResultColour
Link = "https://$CIPPUrl/tenant/standards/bpa-report?SearchNow=true&Report=CIPP+Best+Practices+v1.5+-+Tenant+view&tenantFilter=$($Customer.customerId)"
})
-
-
+
+
# Unified Audit Log
$WidgetData.add([PSCustomObject]@{
Value = $(if ($BPAData.UnifiedAuditLog -eq $True) {
- $ResultColour = '#26A644'
+ $ResultColour = '#26A644'
''
} else {
- $ResultColour = '#D53948'
+ $ResultColour = '#D53948'
''
}
)
@@ -2092,14 +2092,14 @@ function Invoke-NinjaOneTenantSync {
Colour = $ResultColour
Link = "https://security.microsoft.com/auditlogsearch?viewid=Async%20Search&tid=$($Customer.customerId)"
})
-
+
# Passwords Never Expire
$WidgetData.add([PSCustomObject]@{
Value = $(if ($BPAData.PasswordNeverExpires -eq $True) {
- $ResultColour = '#26A644'
+ $ResultColour = '#26A644'
''
} else {
- $ResultColour = '#D53948'
+ $ResultColour = '#D53948'
''
}
)
@@ -2111,10 +2111,10 @@ function Invoke-NinjaOneTenantSync {
# oAuth App Consent
$WidgetData.add([PSCustomObject]@{
Value = $(if ($BPAData.OAuthAppConsent -eq $True) {
- $ResultColour = '#26A644'
+ $ResultColour = '#26A644'
''
} else {
- $ResultColour = '#D53948'
+ $ResultColour = '#D53948'
''
}
)
@@ -2122,7 +2122,7 @@ function Invoke-NinjaOneTenantSync {
Colour = $ResultColour
Link = "https://entra.microsoft.com/$($Customer.customerId)/#view/Microsoft_AAD_IAM/ConsentPoliciesMenuBlade/~/UserSettings"
})
-
+
}
# Blocked Senders
@@ -2146,7 +2146,7 @@ function Invoke-NinjaOneTenantSync {
Colour = '#CCCCCC'
Link = "https://$CIPPUrl/identity/administration/users?customerId=$($Customer.customerId)"
})
-
+
# Devices
$WidgetData.add([PSCustomObject]@{
Value = ($Devices | Measure-Object).count
@@ -2211,11 +2211,11 @@ function Invoke-NinjaOneTenantSync {
Link = "https://entra.microsoft.com/$($Customer.customerId)/#view/Microsoft_AAD_IAM/DirectoriesADConnectBlade"
})
-
-
+
+
Write-Host 'Summary Details'
$SummaryDetailsCardHTML = Get-NinjaOneWidgetCard -Data $WidgetData -Icon 'fas fa-building' -SmallCols 2 -MedCols 3 -LargeCols 4 -XLCols 6 -NoCard
@@ -2223,15 +2223,15 @@ function Invoke-NinjaOneTenantSync {
# Create the Tenant Summary Field
Write-Host 'Complete Tenant Summary'
$TenantSummaryHTML = ' ' + $SummaryDetailsCardHTML + ' ' +
- '' +
- ' ' + $TenantSummaryCard +
+ ' ' +
+ ' ' + $TenantSummaryCard +
' ' + $LicensesSummaryCardHTML +
- ' ' + $DeviceSummaryCardHTML +
+ ' ' + $DeviceSummaryCardHTML +
' ' + $CIPPStandardsSummaryCardHTML +
- ' ' + $SecureScoreSummaryCardHTML +
- ' ' + $UserSummaryCardHTML +
+ ' ' + $SecureScoreSummaryCardHTML +
+ ' ' + $UserSummaryCardHTML +
' '
-
+
$NinjaOrgUpdate | Add-Member -NotePropertyName $MappedFields.TenantSummary -NotePropertyValue @{'html' = $TenantSummaryHTML }
@@ -2241,7 +2241,7 @@ function Invoke-NinjaOneTenantSync {
if ($MappedFields.UsersSummary) {
Write-Host 'User Details Section'
- $UsersTableFornatted = $ParsedUsers | Sort-Object name | Select-Object -First 100 Name,
+ $UsersTableFornatted = $ParsedUsers | Sort-Object name | Select-Object -First 100 Name,
@{n = 'User Principal Name'; e = { $_.UPN } },
#Aliases,
Licenses,
@@ -2250,7 +2250,7 @@ function Invoke-NinjaOneTenantSync {
@{n = 'Devices (Last Login)'; e = { $_.Devices } },
Actions
-
+
$UsersTableHTML = $UsersTableFornatted | ConvertTo-Html -As Table -Fragment
$UsersTableHTML = ([System.Web.HttpUtility]::HtmlDecode($UsersTableHTML) -replace ' ', ' | ') -replace ' | ', ' | '
@@ -2270,47 +2270,47 @@ function Invoke-NinjaOneTenantSync {
} else {
$Overflow = ''
}
-
+
$NinjaOrgUpdate | Add-Member -NotePropertyName $MappedFields.UsersSummary -NotePropertyValue @{'html' = $Overflow + $UsersTableHTML }
}
-
+
Write-Host 'Posting Details'
-
+
$Token = Get-NinjaOneToken -configuration $Configuration
Write-Host "Ninja Body: $($NinjaOrgUpdate | ConvertTo-Json -Depth 100)"
- $Result = Invoke-WebRequest -Uri "https://$($Configuration.Instance)/api/v2/organization/$($MappedTenant.NinjaOne)/custom-fields" -Method PATCH -Headers @{Authorization = "Bearer $($token.access_token)" } -ContentType 'application/json; charset=utf-8' -Body ($NinjaOrgUpdate | ConvertTo-Json -Depth 100)
+ $Result = Invoke-WebRequest -Uri "https://$($Configuration.Instance)/api/v2/organization/$($MappedTenant.IntegrationId)/custom-fields" -Method PATCH -Headers @{Authorization = "Bearer $($token.access_token)" } -ContentType 'application/json; charset=utf-8' -Body ($NinjaOrgUpdate | ConvertTo-Json -Depth 100)
Write-Host 'Cleaning Users Cache'
if (($ParsedUsers | Measure-Object).count -gt 0) {
Remove-AzDataTableEntity @UsersTable -Entity ($ParsedUsers | Select-Object PartitionKey, RowKey)
}
-
+
Write-Host 'Cleaning Device Cache'
if (($ParsedDevices | Measure-Object).count -gt 0) {
Remove-AzDataTableEntity @DeviceTable -Entity ($ParsedDevices | Select-Object PartitionKey, RowKey)
}
-
+
Write-Host "Total Fetch Time: $((New-TimeSpan -Start $StartTime -End $FetchEnd).TotalSeconds)"
- Write-Host "Completed Total Time: $((New-TimeSpan -Start $StartTime -End (Get-Date)).TotalSeconds)"
+ Write-Host "Completed Total Time: $((New-TimeSpan -Start $StartTime -End (Get-Date)).TotalSeconds)"
# Set Last End Time
$CurrentItem | Add-Member -NotePropertyName lastEndTime -NotePropertyValue ([string]$((Get-Date).ToUniversalTime().ToString('yyyy-MM-ddTHH:mm:ss.fffZ'))) -Force
$CurrentItem | Add-Member -NotePropertyName lastStatus -NotePropertyValue 'Completed' -Force
Add-CIPPAzDataTableEntity @MappingTable -Entity $CurrentItem -Force
- Write-LogMessage -API 'NinjaOneSync' -user 'NinjaOneSync' -message "Completed NinjaOne Sync for $($Customer.displayName). Queued for $((New-TimeSpan -Start $StartQueueTime -End $StartTime).TotalSeconds) seconds. Data fetched in $((New-TimeSpan -Start $StartTime -End $FetchEnd).TotalSeconds) seconds. Total processing time $((New-TimeSpan -Start $StartTime -End (Get-Date)).TotalSeconds) seconds" -Sev 'info'
+ Write-LogMessage -API 'NinjaOneSync' -user 'NinjaOneSync' -message "Completed NinjaOne Sync for $($Customer.displayName). Queued for $((New-TimeSpan -Start $StartQueueTime -End $StartTime).TotalSeconds) seconds. Data fetched in $((New-TimeSpan -Start $StartTime -End $FetchEnd).TotalSeconds) seconds. Total processing time $((New-TimeSpan -Start $StartTime -End (Get-Date)).TotalSeconds) seconds" -Sev 'info'
} catch {
$Message = if ($_.ErrorDetails.Message) {
Get-NormalizedError -Message $_.ErrorDetails.Message
} else {
$_.Exception.message
- }
+ }
Write-Error "Failed NinjaOne Processing for $($Customer.displayName) Linenumber: $($_.InvocationInfo.ScriptLineNumber) Error: $Message"
Write-LogMessage -API 'NinjaOneSync' -user 'NinjaOneSync' -message "Failed NinjaOne Processing for $($Customer.displayName) Linenumber: $($_.InvocationInfo.ScriptLineNumber) Error: $Message" -Sev 'Error'
$CurrentItem | Add-Member -NotePropertyName lastEndTime -NotePropertyValue ([string]$((Get-Date).ToUniversalTime().ToString('yyyy-MM-ddTHH:mm:ss.fffZ'))) -Force
diff --git a/Modules/CippExtensions/NinjaOne/NinjaOneHelper.ps1 b/Modules/CippExtensions/Public/NinjaOne/NinjaOneHelper.ps1
similarity index 100%
rename from Modules/CippExtensions/NinjaOne/NinjaOneHelper.ps1
rename to Modules/CippExtensions/Public/NinjaOne/NinjaOneHelper.ps1
diff --git a/Modules/CippExtensions/NinjaOne/Push-NinjaOneQueue.ps1 b/Modules/CippExtensions/Public/NinjaOne/Push-NinjaOneQueue.ps1
similarity index 100%
rename from Modules/CippExtensions/NinjaOne/Push-NinjaOneQueue.ps1
rename to Modules/CippExtensions/Public/NinjaOne/Push-NinjaOneQueue.ps1
diff --git a/Modules/CippExtensions/NinjaOne/Set-NinjaOneFieldMapping.ps1 b/Modules/CippExtensions/Public/NinjaOne/Set-NinjaOneFieldMapping.ps1
similarity index 72%
rename from Modules/CippExtensions/NinjaOne/Set-NinjaOneFieldMapping.ps1
rename to Modules/CippExtensions/Public/NinjaOne/Set-NinjaOneFieldMapping.ps1
index 4653d51ed13a..87d243b8cda1 100644
--- a/Modules/CippExtensions/NinjaOne/Set-NinjaOneFieldMapping.ps1
+++ b/Modules/CippExtensions/Public/NinjaOne/Set-NinjaOneFieldMapping.ps1
@@ -6,7 +6,7 @@ function Set-NinjaOneFieldMapping {
$Request,
$TriggerMetadata
)
-
+
$SettingsTable = Get-CIPPTable -TableName NinjaOneSettings
$AddObject = @{
PartitionKey = 'NinjaConfig'
@@ -17,15 +17,15 @@ function Set-NinjaOneFieldMapping {
foreach ($Mapping in ([pscustomobject]$Request.body.mappings).psobject.properties) {
$AddObject = @{
- PartitionKey = 'NinjaFieldMapping'
- RowKey = "$($mapping.name)"
- 'NinjaOne' = "$($mapping.value.value)"
- 'NinjaOneName' = "$($mapping.value.label)"
+ PartitionKey = 'NinjaOneFieldMapping'
+ RowKey = "$($mapping.name)"
+ IntegrationId = "$($mapping.value.value)"
+ IntegrationName = "$($mapping.value.label)"
}
Add-AzDataTableEntity @CIPPMapping -Entity $AddObject -Force
- Write-LogMessage -API $APINAME -user $request.headers.'x-ms-client-principal' -message "Added mapping for $($mapping.name)." -Sev 'Info'
+ Write-LogMessage -API $APINAME -user $request.headers.'x-ms-client-principal' -message "Added mapping for $($mapping.name)." -Sev 'Info'
}
- $Result = [pscustomobject]@{'Results' = "Successfully edited mapping table." }
+ $Result = [pscustomobject]@{'Results' = 'Successfully edited mapping table.' }
Return $Result
}
\ No newline at end of file
diff --git a/Modules/CippExtensions/NinjaOne/Set-NinjaOneOrgMapping.ps1 b/Modules/CippExtensions/Public/NinjaOne/Set-NinjaOneOrgMapping.ps1
similarity index 71%
rename from Modules/CippExtensions/NinjaOne/Set-NinjaOneOrgMapping.ps1
rename to Modules/CippExtensions/Public/NinjaOne/Set-NinjaOneOrgMapping.ps1
index ee09580b94bf..43b1c597e3b0 100644
--- a/Modules/CippExtensions/NinjaOne/Set-NinjaOneOrgMapping.ps1
+++ b/Modules/CippExtensions/Public/NinjaOne/Set-NinjaOneOrgMapping.ps1
@@ -6,18 +6,18 @@ function Set-NinjaOneOrgMapping {
$Request
)
- Get-CIPPAzDataTableEntity @CIPPMapping -Filter "PartitionKey eq 'NinjaOrgsMapping'" | ForEach-Object {
+ Get-CIPPAzDataTableEntity @CIPPMapping -Filter "PartitionKey eq 'NinjaOneMapping'" | ForEach-Object {
Remove-AzDataTableEntity @CIPPMapping -Entity $_
}
foreach ($Mapping in ([pscustomobject]$Request.body.mappings).psobject.properties) {
$AddObject = @{
- PartitionKey = 'NinjaOrgsMapping'
- RowKey = "$($mapping.name)"
- 'NinjaOne' = "$($mapping.value.value)"
- 'NinjaOneName' = "$($mapping.value.label)"
+ PartitionKey = 'NinjaOneMapping'
+ RowKey = "$($mapping.name)"
+ IntegrationId = "$($mapping.value.value)"
+ IntegrationName = "$($mapping.value.label)"
}
Add-AzDataTableEntity @CIPPMapping -Entity $AddObject -Force
- Write-LogMessage -API $APINAME -user $request.headers.'x-ms-client-principal' -message "Added mapping for $($mapping.name)." -Sev 'Info'
+ Write-LogMessage -API $APINAME -user $request.headers.'x-ms-client-principal' -message "Added mapping for $($mapping.name)." -Sev 'Info'
}
$Result = [pscustomobject]@{'Results' = 'Successfully edited mapping table.' }
diff --git a/Modules/CippExtensions/Public/New-PwPushLink.ps1 b/Modules/CippExtensions/Public/PwPush/New-PwPushLink.ps1
similarity index 100%
rename from Modules/CippExtensions/Public/New-PwPushLink.ps1
rename to Modules/CippExtensions/Public/PwPush/New-PwPushLink.ps1
diff --git a/Modules/CippExtensions/Private/Set-PwPushConfig.ps1 b/Modules/CippExtensions/Public/PwPush/Set-PwPushConfig.ps1
similarity index 100%
rename from Modules/CippExtensions/Private/Set-PwPushConfig.ps1
rename to Modules/CippExtensions/Public/PwPush/Set-PwPushConfig.ps1
diff --git a/Modules/HuduAPI/2.4.9/HuduAPI.psd1 b/Modules/HuduAPI/2.4.9/HuduAPI.psd1
new file mode 100644
index 000000000000..c5654110bc01
--- /dev/null
+++ b/Modules/HuduAPI/2.4.9/HuduAPI.psd1
@@ -0,0 +1,154 @@
+#
+# Module manifest for module 'HuduAPI'
+#
+# Generated by: Luke Whitelock
+#
+# Generated on: 06/30/2024
+#
+
+@{
+
+# Script module or binary module file associated with this manifest.
+RootModule = '.\HuduAPI.psm1'
+
+# Version number of this module.
+ModuleVersion = '2.4.9'
+
+# Supported PSEditions
+# CompatiblePSEditions = @()
+
+# ID used to uniquely identify this module
+GUID = '4e0a4feb-1658-416b-b854-ab9e913a56de'
+
+# Author of this module
+Author = 'Luke Whitelock'
+
+# Company or vendor of this module
+CompanyName = 'MSPP'
+
+# Copyright statement for this module
+Copyright = '(c) 2021 Luke Whitelock. All rights reserved.'
+
+# Description of the functionality provided by this module
+Description = 'This module provides an interface to the Hudu Rest API further information can be found at https://github.com/lwhitelock/HuduAPI'
+
+# Minimum version of the PowerShell engine required by this module
+PowerShellVersion = '7.0'
+
+# Name of the PowerShell host required by this module
+# PowerShellHostName = ''
+
+# Minimum version of the PowerShell host required by this module
+# PowerShellHostVersion = ''
+
+# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
+# DotNetFrameworkVersion = ''
+
+# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
+# ClrVersion = ''
+
+# Processor architecture (None, X86, Amd64) required by this module
+# ProcessorArchitecture = ''
+
+# Modules that must be imported into the global environment prior to importing this module
+# RequiredModules = @()
+
+# Assemblies that must be loaded prior to importing this module
+# RequiredAssemblies = @()
+
+# Script files (.ps1) that are run in the caller's environment prior to importing this module.
+# ScriptsToProcess = @()
+
+# Type files (.ps1xml) to be loaded when importing this module
+# TypesToProcess = @()
+
+# Format files (.ps1xml) to be loaded when importing this module
+# FormatsToProcess = @()
+
+# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
+# NestedModules = @()
+
+# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
+FunctionsToExport = 'Get-HuduActivityLogs', 'Get-HuduApiKey', 'Get-HuduAppInfo',
+ 'Get-HuduArticles', 'Get-HuduAssetLayoutFieldID',
+ 'Get-HuduAssetLayouts', 'Get-HuduAssets', 'Get-HuduBaseURL',
+ 'Get-HuduCard', 'Get-HuduCompanies', 'Get-HuduExpirations',
+ 'Get-HuduFolderMap', 'Get-HuduFolders', 'Get-HuduIntegrationMatchers',
+ 'Get-HuduMagicDashes', 'Get-HuduObjectByUrl',
+ 'Get-HuduPasswordFolders', 'Get-HuduPasswords', 'Get-HuduProcesses',
+ 'Get-HuduPublicPhotos', 'Get-HuduRelations', 'Get-HuduUploads',
+ 'Get-HuduWebsites', 'Initialize-HuduFolder',
+ 'Move-HuduAssetsToNewLayout', 'New-HuduAPIKey', 'New-HuduArticle',
+ 'New-HuduAsset', 'New-HuduAssetLayout', 'New-HuduBaseURL',
+ 'New-HuduCompany', 'New-HuduCustomHeaders', 'New-HuduFolder',
+ 'New-HuduPassword', 'New-HuduPublicPhoto', 'New-HuduRelation',
+ 'New-HuduUpload', 'New-HuduWebsite', 'Remove-HuduAPIKey',
+ 'Remove-HuduArticle', 'Remove-HuduAsset', 'Remove-HuduBaseURL',
+ 'Remove-HuduCompany', 'Remove-HuduCustomHeaders',
+ 'Remove-HuduMagicDash', 'Remove-HuduPassword', 'Remove-HuduRelation',
+ 'Remove-HuduUpload', 'Remove-HuduWebsite', 'Set-HuduArticle',
+ 'Set-HuduArticleArchive', 'Set-HuduAsset', 'Set-HuduAssetArchive',
+ 'Set-HuduAssetLayout', 'Set-HuduCompany', 'Set-HuduCompanyArchive',
+ 'Set-HuduFolder', 'Set-HuduIntegrationMatcher', 'Set-HuduMagicDash',
+ 'Set-HuduPassword', 'Set-HuduPasswordArchive', 'Set-HuduWebsite'
+
+# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
+CmdletsToExport = @()
+
+# Variables to export from this module
+VariablesToExport = '*'
+
+# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
+AliasesToExport = @()
+
+# DSC resources to export from this module
+# DscResourcesToExport = @()
+
+# List of all modules packaged with this module
+# ModuleList = @()
+
+# List of all files packaged with this module
+# FileList = @()
+
+# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
+PrivateData = @{
+
+ PSData = @{
+
+ # Tags applied to this module. These help with module discovery in online galleries.
+ # Tags = @()
+
+ # A URL to the license for this module.
+ # LicenseUri = ''
+
+ # A URL to the main website for this project.
+ # ProjectUri = ''
+
+ # A URL to an icon representing this module.
+ # IconUri = ''
+
+ # ReleaseNotes of this module
+ # ReleaseNotes = ''
+
+ # Prerelease string of this module
+ # Prerelease = ''
+
+ # Flag to indicate whether the module requires explicit user acceptance for install/update/save
+ # RequireLicenseAcceptance = $false
+
+ # External dependent modules of this module
+ # ExternalModuleDependencies = @()
+
+ } # End of PSData hashtable
+
+
+} # End of PrivateData hashtable
+
+# HelpInfo URI of this module
+# HelpInfoURI = ''
+
+# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
+# DefaultCommandPrefix = ''
+
+}
+
diff --git a/Modules/HuduAPI/2.4.9/HuduAPI.psm1 b/Modules/HuduAPI/2.4.9/HuduAPI.psm1
new file mode 100644
index 000000000000..24c908667318
--- /dev/null
+++ b/Modules/HuduAPI/2.4.9/HuduAPI.psm1
@@ -0,0 +1,4201 @@
+#Region './Private/ArgumentCompleters/AssetLayoutCompleter.ps1' -1
+
+$AssetLayoutCompleter = {
+ param (
+ $CommandName,
+ $ParamName,
+ $AssetLayout,
+ $CommandAst,
+ $fakeBoundParameters
+ )
+ if (!$script:AssetLayouts) {
+ Get-HuduAssetLayouts | Out-Null
+ }
+
+ $AssetLayout = $AssetLayout -replace "'", ''
+ ($script:AssetLayouts).name | Where-Object { $_ -match "$AssetLayout" } | ForEach-Object { "'$_'" }
+}
+
+Register-ArgumentCompleter -CommandName Get-HuduAssets -ParameterName AssetLayout -ScriptBlock $AssetLayoutCompleter
+#EndRegion './Private/ArgumentCompleters/AssetLayoutCompleter.ps1' 18
+#Region './Private/Get-HuduCompanyFolders.ps1' -1
+
+function Get-HuduCompanyFolders {
+ [CmdletBinding()]
+ Param (
+ [PSCustomObject]$FoldersRaw
+ )
+
+ $RootFolders = $FoldersRaw | Where-Object { $null -eq $_.parent_folder_id }
+ $ReturnObject = [PSCustomObject]@{}
+ foreach ($folder in $RootFolders) {
+ $SubFolders = Get-HuduSubFolders -id $folder.id -FoldersRaw $FoldersRaw
+ foreach ($SubFolder in $SubFolders) {
+ $Folder | Add-Member -MemberType NoteProperty -Name $(Get-HuduFolderCleanName $($SubFolder.PSObject.Properties.name)) -Value $SubFolder.PSObject.Properties.value
+ }
+ $ReturnObject | Add-Member -MemberType NoteProperty -Name $(Get-HuduFolderCleanName $($folder.name)) -Value $folder
+ }
+ return $ReturnObject
+}
+#EndRegion './Private/Get-HuduCompanyFolders.ps1' 18
+#Region './Private/Get-HuduFolderCleanName.ps1' -1
+
+function Get-HuduFolderCleanName {
+ [CmdletBinding()]
+ param(
+ [string]$Name
+ )
+
+ $FieldNames = @('id', 'company_id', 'icon', 'description', 'name', 'parent_folder_id', 'created_at', 'updated_at')
+
+ if ($Name -in $FieldNames) {
+ Return "fld_$Name"
+ } else {
+ Return $Name
+ }
+
+}
+#EndRegion './Private/Get-HuduFolderCleanName.ps1' 16
+#Region './Private/Get-HuduSubFolders.ps1' -1
+
+function Get-HuduSubFolders {
+ [CmdletBinding()]
+ Param(
+ [int]$id,
+ [PSCustomObject]$FoldersRaw
+ )
+
+ $SubFolders = $FoldersRaw | Where-Object { $_.parent_folder_id -eq $id }
+ $ReturnFolders = [System.Collections.ArrayList]@()
+ foreach ($Folder in $SubFolders) {
+ $SubSubFolders = Get-HuduSubFolders -id $Folder.id -FoldersRaw $FoldersRaw
+ foreach ($AddFolder in $SubSubFolders) {
+ $null = $folder | Add-Member -MemberType NoteProperty -Name $(Get-HuduFolderCleanName $($AddFolder.PSObject.Properties.name)) -Value $AddFolder.PSObject.Properties.value
+ }
+ $ReturnObject = [PSCustomObject]@{
+ $(Get-HuduFolderCleanName $($Folder.name)) = $Folder
+ }
+ $null = $ReturnFolders.add($ReturnObject)
+ }
+
+ return $ReturnFolders
+
+}
+#EndRegion './Private/Get-HuduSubFolders.ps1' 24
+#Region './Private/Invoke-HuduRequest.ps1' -1
+
+function Invoke-HuduRequest {
+ <#
+ .SYNOPSIS
+ Main Hudu API function
+
+ .DESCRIPTION
+ Calls Hudu API with token
+
+ .PARAMETER Method
+ GET,POST,DELETE,PUT,etc
+
+ .PARAMETER Path
+ Path to API endpoint
+
+ .PARAMETER Params
+ Hashtable of parameters
+
+ .PARAMETER Body
+ JSON encoded body string
+
+ .PARAMETER Form
+ Multipart form data
+
+ .EXAMPLE
+ Invoke-HuduRequest -Resource '/api/v1/articles' -Method GET
+ #>
+ [CmdletBinding()]
+ Param(
+ [Parameter()]
+ [string]$Method = 'GET',
+
+ [Parameter()]
+ [ValidateNotNullOrEmpty()]
+ [string]$Resource,
+
+ [Parameter()]
+ [hashtable]$Params = @{},
+
+ [Parameter()]
+ [string]$Body,
+
+ [Parameter()]
+ [hashtable]$Form
+ )
+
+ $HuduAPIKey = Get-HuduApiKey
+ $HuduBaseURL = Get-HuduBaseURL
+
+ # Assemble parameters
+ $ParamCollection = [System.Web.HttpUtility]::ParseQueryString([String]::Empty)
+
+ # Sort parameters
+ foreach ($Item in ($Params.GetEnumerator() | Sort-Object -CaseSensitive -Property Key)) {
+ $ParamCollection.Add($Item.Key, $Item.Value)
+ }
+
+ # Query string
+ $Request = $ParamCollection.ToString()
+
+ $Headers = @{
+ 'x-api-key' = (New-Object PSCredential 'user', $HuduAPIKey).GetNetworkCredential().Password;
+ }
+
+ if (($Script:Int_HuduCustomHeaders | Measure-Object).count -gt 0){
+
+ foreach($Entry in $Int_HuduCustomHeaders.GetEnumerator()) {
+ $Headers[$Entry.Name] = $Entry.Value
+ }
+ }
+
+ $ContentType = 'application/json; charset=utf-8'
+
+ $Uri = '{0}{1}' -f $HuduBaseURL, $Resource
+ # Make API call URI
+ if ($Request) {
+ $UriBuilder = [System.UriBuilder]$Uri
+ $UriBuilder.Query = $Request
+ $Uri = $UriBuilder.Uri
+ }
+ Write-Verbose ( '{0} [{1}]' -f $Method, $Uri )
+
+ $RestMethod = @{
+ Method = $Method
+ Uri = $Uri
+ Headers = $Headers
+ ContentType = $ContentType
+ }
+
+ if ($Body) {
+ $RestMethod.Body = $Body
+ Write-Verbose $Body
+ }
+
+ if ($Form) {
+ $RestMethod.Form = $Form
+ Write-Verbose ( $Form | Out-String )
+ }
+
+ try {
+ $Results = Invoke-RestMethod @RestMethod
+ } catch {
+ if ("$_".trim() -eq 'Retry later' -or "$_".trim() -eq 'The remote server returned an error: (429) Too Many Requests.') {
+ Write-Information 'Hudu API Rate limited. Waiting 30 Seconds then trying again'
+ Start-Sleep 30
+ $Results = Invoke-HuduRequest @RestMethod
+ } else {
+ Write-Error "'$_'"
+ }
+ }
+
+ $Results
+}
+#EndRegion './Private/Invoke-HuduRequest.ps1' 113
+#Region './Private/Invoke-HuduRequestPaginated.ps1' -1
+
+function Invoke-HuduRequestPaginated {
+ <#
+ .SYNOPSIS
+ Paginated requests to Hudu API
+
+ .DESCRIPTION
+ Wraps Invoke-HuduRequest with page sizes
+
+ .PARAMETER HuduRequest
+ Request to paginate
+
+ .PARAMETER Property
+ Property name to return (don't specify to return entire response object)
+
+ .PARAMETER PageSize
+ Number of results to return per page (default 1000)
+
+ #>
+ [CmdletBinding()]
+ Param(
+ [hashtable]$HuduRequest,
+ [string]$Property,
+ [int]$PageSize = 1000
+ )
+
+ $i = 1
+ do {
+ $HuduRequest.Params.page = $i
+ $HuduRequest.Params.page_size = $PageSize
+ $Response = Invoke-HuduRequest @HuduRequest
+ $i++
+ if ($Property) {
+ $Response.$Property
+ }
+
+ else {
+ $Response
+ }
+ } while (($Property -and $Response.$Property.count % $PageSize -eq 0 -and $Response.$Property.count -ne 0) -or (!$Property -and $Response.count % $PageSize -eq 0 -and $Response.count -ne 0))
+}
+#EndRegion './Private/Invoke-HuduRequestPaginated.ps1' 41
+#Region './Public/Get-HuduActivityLogs.ps1' -1
+
+function Get-HuduActivityLogs {
+ <#
+ .SYNOPSIS
+ Get activity logs for account
+
+ .DESCRIPTION
+ Calls Hudu API to retrieve activity logs with filters
+
+ .PARAMETER UserId
+ Filter logs by user_id
+
+ .PARAMETER UserEmail
+ Filter logs by email address
+
+ .PARAMETER ResourceId
+ Filter logs by resource id. Must be coupled with resource_type
+
+ .PARAMETER ResourceType
+ Filter logs by resource type (Asset, AssetPassword, Company, Article, etc.). Must be coupled with resource_id
+
+ .PARAMETER ActionMessage
+ Filter logs by action
+
+ .PARAMETER StartDate
+ Filter logs by start date. Converts string to ISO 8601 format
+
+ .PARAMETER EndDate
+ Filter logs by end date, should be coupled with start date to limit results
+
+ .EXAMPLE
+ Get-HuduActivityLogs -StartDate 2023-02-01
+
+ #>
+ [CmdletBinding()]
+ Param (
+ [Alias('user_id')]
+ [Int]$UserId = '',
+ [Alias('user_email')]
+ [String]$UserEmail = '',
+ [Alias('resource_id')]
+ [Int]$ResourceId = '',
+ [Alias('resource_type')]
+ [String]$ResourceType = '',
+ [Alias('action_message')]
+ [String]$ActionMessage = '',
+ [Alias('start_date')]
+ [DateTime]$StartDate,
+ [Alias('end_date')]
+ [DateTime]$EndDate
+ )
+
+ $Params = @{}
+
+ if ($UserId) { $Params.user_id = $UserId }
+ if ($UserEmail) { $Params.user_email = $UserEmail }
+ if ($ResourceId) { $Params.resource_id = $ResourceId }
+ if ($ResourceType) { $Params.resource_type = $ResourceType }
+ if ($ActionMessage) { $Params.action_message = $ActionMessage }
+ if ($StartDate) {
+ $ISO8601Date = $StartDate.ToString('o');
+ $Params.start_date = $ISO8601Date
+ }
+
+ $HuduRequest = @{
+ Method = 'GET'
+ Resource = '/api/v1/activity_logs'
+ Params = $Params
+ }
+
+ $AllActivity = Invoke-HuduRequestPaginated -HuduRequest $HuduRequest
+
+ if ($EndDate) {
+ $AllActivity = $AllActivity | Where-Object { $([DateTime]::Parse($_.created_at)) -le $EndDate }
+ }
+
+ return $AllActivity
+}
+#EndRegion './Public/Get-HuduActivityLogs.ps1' 78
+#Region './Public/Get-HuduApiKey.ps1' -1
+
+function Get-HuduApiKey {
+ <#
+ .SYNOPSIS
+ Get Hudu API key
+
+ .DESCRIPTION
+ Returns Hudu API key in securestring format
+
+ .EXAMPLE
+ Get-HuduApiKey
+
+ #>
+ [CmdletBinding()]
+ Param()
+ if ($null -eq $Int_HuduAPIKey) {
+ Write-Error 'No API key has been set. Please use New-HuduAPIKey to set it.'
+ } else {
+ $Int_HuduAPIKey
+ }
+}
+#EndRegion './Public/Get-HuduApiKey.ps1' 21
+#Region './Public/Get-HuduAppInfo.ps1' -1
+
+function Get-HuduAppInfo {
+ <#
+ .SYNOPSIS
+ Retrieve information regarding API
+
+ .DESCRIPTION
+ Calls Hudu API to retrieve version number and date
+
+ .EXAMPLE
+ Get-HuduAppInfo
+
+ #>
+ [CmdletBinding()]
+ Param()
+
+ [version]$script:HuduRequiredVersion = '2.21'
+
+ try {
+ Invoke-HuduRequest -Resource '/api/v1/api_info'
+ } catch {
+ [PSCustomObject]@{
+ version = '0.0.0.0'
+ date = '2000-01-01'
+ }
+ }
+}
+#EndRegion './Public/Get-HuduAppInfo.ps1' 27
+#Region './Public/Get-HuduArticles.ps1' -1
+
+function Get-HuduArticles {
+ <#
+ .SYNOPSIS
+ Get Knowledge Base Articles
+
+ .DESCRIPTION
+ Calls Hudu API to retrieve KB articles by Id or a list
+
+ .PARAMETER Id
+ Id of the Article
+
+ .PARAMETER CompanyId
+ Filter by company id
+
+ .PARAMETER Name
+ Filter by name of article
+
+ .PARAMETER Slug
+ Filter by slug of article
+
+ .EXAMPLE
+ Get-HuduArticles -Name 'Article name'
+
+ #>
+ [CmdletBinding()]
+ Param (
+ [Int]$Id = '',
+ [Alias('company_id')]
+ [Int]$CompanyId = '',
+ [String]$Name = '',
+ [String]$Slug
+ )
+
+ if ($Id) {
+ Invoke-HuduRequest -Method get -Resource "/api/v1/articles/$Id"
+ } else {
+ $Params = @{}
+
+ if ($CompanyId) { $Params.company_id = $CompanyId }
+ if ($Name) { $Params.name = $Name }
+ if ($Slug) { $Params.slug = $Slug }
+
+ $HuduRequest = @{
+ Method = 'GET'
+ Resource = '/api/v1/articles'
+ Params = $Params
+ }
+
+ Invoke-HuduRequestPaginated -HuduRequest $HuduRequest -Property articles
+ }
+}
+#EndRegion './Public/Get-HuduArticles.ps1' 52
+#Region './Public/Get-HuduAssetLayoutFieldID.ps1' -1
+
+function Get-HuduAssetLayoutFieldID {
+ <#
+ .SYNOPSIS
+ Get Hudu Asset Layout Field ID
+
+ .DESCRIPTION
+ Retrieves ID for Hudu Asset Layout Fields
+
+ .PARAMETER Name
+ Name of Field
+
+ .PARAMETER LayoutId
+ Asset Layout Id
+
+ .EXAMPLE
+ Get-HuduAssetLayoutFieldID -Name 'Extra Info' -LayoutId 1
+
+ #>
+ [CmdletBinding()]
+ Param (
+ [Parameter(Mandatory = $true)]
+ [String]$Name,
+ [Alias('asset_layout_id')]
+ [Parameter(Mandatory = $true)]
+ [Int]$LayoutId
+ )
+
+ $Layout = Get-HuduAssetLayouts -LayoutId $LayoutId
+
+ $Fields = [Collections.Generic.List[Object]]($Layout.fields)
+ $Index = $Fields.FindIndex( { $args[0].label -eq $Name } )
+ $Fields[$Index].id
+}
+#EndRegion './Public/Get-HuduAssetLayoutFieldID.ps1' 34
+#Region './Public/Get-HuduAssetLayouts.ps1' -1
+
+function Get-HuduAssetLayouts {
+ <#
+ .SYNOPSIS
+ Get a list of Asset Layouts
+
+ .DESCRIPTION
+ Call Hudu API to retrieve asset layouts for server
+
+ .PARAMETER Name
+ Filter by name of Asset Layout
+
+ .PARAMETER LayoutId
+ Id of Asset Layout
+
+ .PARAMETER Slug
+ Filter by url slug
+
+ .EXAMPLE
+ Get-HuduAssetLayouts -Name 'Contacts'
+
+ #>
+ [CmdletBinding()]
+ Param (
+ [String]$Name,
+ [Alias('id', 'layout_id')]
+ [int]$LayoutId,
+ [String]$Slug
+ )
+
+ $HuduRequest = @{
+ Resource = '/api/v1/asset_layouts'
+ Method = 'GET'
+ }
+
+ if ($LayoutId) {
+ $HuduRequest.Resource = '{0}/{1}' -f $HuduRequest.Resource, $LayoutId
+ $AssetLayout = Invoke-HuduRequest @HuduRequest
+ return $AssetLayout.asset_layout
+ } else {
+ $Params = @{}
+ if ($Name) { $Params.name = $Name }
+ if ($Slug) { $Params.slug = $Slug }
+ $HuduRequest.Params = $Params
+
+ $AssetLayouts = Invoke-HuduRequestPaginated -HuduRequest $HuduRequest -Property 'asset_layouts' -PageSize 25
+
+ if (!$Name -and !$Slug) {
+ $script:AssetLayouts = $AssetLayouts | Sort-Object -Property name
+ }
+ $AssetLayouts
+ }
+}
+#EndRegion './Public/Get-HuduAssetLayouts.ps1' 53
+#Region './Public/Get-HuduAssets.ps1' -1
+
+function Get-HuduAssets {
+ <#
+ .SYNOPSIS
+ Get a list of Assets
+
+ .DESCRIPTION
+ Call Hudu API to retrieve Assets
+
+ .PARAMETER Id
+ Id of requested asset
+
+ .PARAMETER AssetLayoutId
+ Id of the requested asset layout
+
+ .PARAMETER AssetLayout
+ Name of the requested asset layout
+
+ .PARAMETER CompanyId
+ Id of the requested company
+
+ .PARAMETER Name
+ Filter by name
+
+ .PARAMETER Archived
+ Show archived results
+
+ .PARAMETER PrimarySerial
+ Filter by primary serial
+
+ .PARAMETER Slug
+ Filter by slug
+
+ .EXAMPLE
+ Get-HuduAssets -AssetLayout 'Contacts'
+
+ #>
+ [CmdletBinding()]
+ Param (
+ [ValidateRange(1, [int]::MaxValue)]
+ [Int]$Id = '',
+ [Alias('asset_layout_id')]
+ [ValidateRange(1, [int]::MaxValue)]
+ [Int]$AssetLayoutId = '',
+ [string]$AssetLayout,
+ [Alias('company_id')]
+ [ValidateRange(1, [int]::MaxValue)]
+ [Int]$CompanyId = '',
+ [String]$Name = '',
+ [switch]$Archived,
+ [Alias('primary_serial')]
+ [String]$PrimarySerial = '',
+ [String]$Slug
+ )
+
+ if ($AssetLayout) {
+ if (!$script:AssetLayouts) { Get-HuduAssetLayouts | Out-Null }
+ $AssetLayoutId = $script:AssetLayouts | Where-Object { $_.name -eq $AssetLayout } | Select-Object -ExpandProperty id
+ }
+
+ if ($id -and $CompanyId) {
+ $HuduRequest = @{
+ Resource = "/api/v1/companies/$CompanyId/assets/$Id"
+ Method = 'GET'
+ }
+ Invoke-HuduRequest @HuduRequest
+ } else {
+ $Params = @{}
+ if ($CompanyId) { $Params.company_id = $CompanyId }
+ if ($AssetLayoutId) { $Params.asset_layout_id = $AssetLayoutId }
+ if ($Name) { $Params.name = $Name }
+ if ($Archived.IsPresent) { $params.archived = $Archived.IsPresent }
+ if ($PrimarySerial) { $Params.primary_serial = $PrimarySerial }
+ if ($Id) { $Params.id = $Id }
+ if ($Slug) { $Params.slug = $Slug }
+
+ $HuduRequest = @{
+ Resource = '/api/v1/assets'
+ Method = 'GET'
+ Params = $Params
+ }
+ Invoke-HuduRequestPaginated -HuduRequest $HuduRequest -Property assets
+ }
+}
+#EndRegion './Public/Get-HuduAssets.ps1' 84
+#Region './Public/Get-HuduBaseURL.ps1' -1
+
+function Get-HuduBaseURL {
+ <#
+ .SYNOPSIS
+ Get Hudu Base URL
+
+ .DESCRIPTION
+ Returns Hudu Base URL
+
+ .EXAMPLE
+ Get-HuduBaseURL
+
+ #>
+ [CmdletBinding()]
+ Param()
+ if ($null -eq $Int_HuduBaseURL) {
+ Write-Error 'No Base URL has been set. Please use New-HuduBaseURL to set it.'
+ } else {
+ $Int_HuduBaseURL
+ }
+}
+#EndRegion './Public/Get-HuduBaseURL.ps1' 21
+#Region './Public/Get-HuduCard.ps1' -1
+
+function Get-HuduCard {
+ <#
+ .SYNOPSIS
+ Get Integration Cards
+
+ .DESCRIPTION
+ Lookup cards with outside integration details
+
+ .PARAMETER IntegrationSlug
+ Identifier of outside integration
+
+ .PARAMETER IntegrationId
+ ID in the integration. Must be present, unless integration_identifier is set
+
+ .PARAMETER IntegrationIdentifier
+ Identifier in the integration (if integration_id is not set)
+
+ .EXAMPLE
+ Get-HuduCard -IntegrationSlug cw_manage -IntegrationId 1
+
+ #>
+ [CmdletBinding()]
+ Param (
+ [Parameter(Mandatory = $true)]
+ [Alias('integration_slug')]
+ [String]$IntegrationSlug,
+
+ [Alias('integration_id')]
+ [String]$IntegrationId,
+
+ [Alias('integration_identifier')]
+ [String]$IntegrationIdentifier
+ )
+
+ $Params = @{
+ integration_slug = $IntegrationSlug
+ }
+
+ if ($IntegrationId) { $Params.integration_id = $IntegrationId }
+ if ($IntegrationIdentifier) { $Params.integration_identifier = $IntegrationIdentifier }
+
+ if (!$IntegrationId -and !$IntegrationIdentifier) {
+ throw 'IntegrationId or IntegrationIdentifier required'
+ }
+
+ $HuduRequest = @{
+ Method = 'GET'
+ Resource = '/api/v1/cards/lookup'
+ Params = $Params
+ }
+
+ Invoke-HuduRequestPaginated -HuduRequest $HuduRequest -Property integrator_cards
+}
+#EndRegion './Public/Get-HuduCard.ps1' 54
+#Region './Public/Get-HuduCompanies.ps1' -1
+
+function Get-HuduCompanies {
+ <#
+ .SYNOPSIS
+ Get a list of companies
+
+ .DESCRIPTION
+ Call Hudu API to retrieve company list
+
+ .PARAMETER Id
+ Filter companies by id
+
+ .PARAMETER Name
+ Filter companies by name
+
+ .PARAMETER PhoneNumber
+ filter companies by phone number
+
+ .PARAMETER Website
+ Filter companies by website
+
+ .PARAMETER City
+ Filter companies by city
+
+ .PARAMETER State
+ Filter companies by state
+
+ .PARAMETER Search
+ Filter by search query
+
+ .PARAMETER Slug
+ Filter by url slug
+
+ .PARAMETER IdInIntegration
+ Filter companies by id/identifier in PSA/RMM/outside integration
+
+ .EXAMPLE
+ Get-HuduCompanies -Search 'Vendor'
+
+ #>
+ [CmdletBinding()]
+ Param (
+ [String]$Name = '',
+ [Alias('phone_number')]
+ [String]$PhoneNumber = '',
+ [String]$Website = '',
+ [String]$City = '',
+ [String]$State = '',
+ [Alias('id_in_integration')]
+ [Int]$IdInIntegration = '',
+ [Int]$Id = '',
+ [string]$Search,
+ [String]$Slug
+ )
+
+ if ($Id) {
+ $Company = (Invoke-HuduRequest -Method get -Resource "/api/v1/companies/$Id").company
+ return $Company
+ } else {
+ $Params = @{}
+ if ($Name) { $Params.name = $Name }
+ if ($PhoneNumber) { $Params.phone_number = $PhoneNumber }
+ if ($Website) { $Params.website = $Website }
+ if ($City) { $Params.city = $City }
+ if ($State) { $Params.state = $State }
+ if ($IdInIntegration) { $Params.id_in_integration = $IdInIntegration }
+ if ($Search) { $Params.search = $Search }
+ if ($Slug) { $Params.slug = $Slug }
+
+ $HuduRequest = @{
+ Method = 'GET'
+ Resource = '/api/v1/companies'
+ Params = $Params
+ }
+
+ Invoke-HuduRequestPaginated -HuduRequest $HuduRequest -Property 'companies'
+ }
+}
+#EndRegion './Public/Get-HuduCompanies.ps1' 78
+#Region './Public/Get-HuduExpirations.ps1' -1
+
+function Get-HuduExpirations {
+ <#
+ .SYNOPSIS
+ Get expirations for account
+
+ .DESCRIPTION
+ Calls Hudu API to retrieve expirations
+
+ .PARAMETER CompanyId
+ Filter expirations by company_id
+
+ .PARAMETER ExpirationType
+ Filter expirations by expiration type (undeclared, domain, ssl_certificate, warranty, asset_field, article_expiration)
+
+ .PARAMETER ResourceId
+ Filter logs by resource id. Must be coupled with resource_type
+
+ .PARAMETER ResourceType
+ Filter logs by resource type (Asset, AssetPassword, Company, Article, etc.). Must be coupled with resource_id
+
+ .EXAMPLE
+ Get-HuduExpirations -ExpirationType domain
+
+ #>
+ [CmdletBinding()]
+ Param (
+ [Alias('company_id')]
+ [Int]$CompanyId = '',
+
+ [ValidateSet('undeclared', 'domain', 'ssl_certificate', 'warranty', 'asset_field', 'article_expiration')]
+ [Alias('expiration_type')]
+ [String]$ExpirationType = '',
+
+ [Alias('resource_id')]
+ [Int]$ResourceId = '',
+
+ [Alias('resource_type')]
+ [String]$ResourceType = ''
+ )
+
+ $Params = @{}
+
+ if ($CompanyId) { $Params.company_id = $CompanyId }
+ if ($ExpirationType) { $Params.expiration_type = $ExpirationType }
+ if ($ResourceType) { $Params.resource_type = $ResourceType }
+ if ($ResourceId) { $Params.resource_id = $ResourceId }
+
+ $HuduRequest = @{
+ Method = 'GET'
+ Resource = '/api/v1/expirations'
+ Params = $Params
+ }
+
+ Invoke-HuduRequestPaginated -HuduRequest $HuduRequest
+}
+#EndRegion './Public/Get-HuduExpirations.ps1' 56
+#Region './Public/Get-HuduFolderMap.ps1' -1
+
+function Get-HuduFolderMap {
+ [CmdletBinding()]
+ Param (
+ [Alias('company_id')]
+ [Int]$CompanyId = ''
+ )
+
+ if ($CompanyId) {
+ $FoldersRaw = Get-HuduFolders -company_id $CompanyId
+ $SubFolders = Get-HuduCompanyFolders -FoldersRaw $FoldersRaw
+ } else {
+ $FoldersRaw = Get-HuduFolders
+ $FoldersProcessed = $FoldersRaw | Where-Object { $null -eq $_.company_id }
+ $SubFolders = Get-HuduCompanyFolders -FoldersRaw $FoldersProcessed
+ }
+
+ return $SubFolders
+}
+#EndRegion './Public/Get-HuduFolderMap.ps1' 19
+#Region './Public/Get-HuduFolders.ps1' -1
+
+function Get-HuduFolders {
+ <#
+ .SYNOPSIS
+ Get a list of Folders
+
+ .DESCRIPTION
+ Calls Hudu API to retrieve folders
+
+ .PARAMETER Id
+ Id of the folder
+
+ .PARAMETER Name
+ Filter by name
+
+ .PARAMETER CompanyId
+ Filter by company_id
+
+ .EXAMPLE
+ Get-HuduFolders
+
+ #>
+ [CmdletBinding()]
+ Param (
+ [Int]$Id = '',
+ [String]$Name = '',
+ [Alias('company_id')]
+ [Int]$CompanyId = ''
+ )
+
+ if ($id) {
+ $Folder = Invoke-HuduRequest -Method get -Resource "/api/v1/folders/$id"
+ return $Folder.Folder
+ } else {
+ $Params = @{}
+
+ if ($CompanyId) { $Params.company_id = $CompanyId }
+ if ($Name) { $Params.name = $Name }
+
+ $HuduRequest = @{
+ Method = 'GET'
+ Resource = '/api/v1/folders'
+ Params = $Params
+ }
+ Invoke-HuduRequestPaginated -HuduRequest $HuduRequest -Property folders
+ }
+}
+#EndRegion './Public/Get-HuduFolders.ps1' 47
+#Region './Public/Get-HuduIntegrationMatchers.ps1' -1
+
+function Get-HuduIntegrationMatchers {
+ <#
+ .SYNOPSIS
+ List matchers for an integration
+
+ .DESCRIPTION
+ Calls Hudu API to get list of integration matching
+
+ .PARAMETER IntegrationId
+ ID of the integration. Can be found in the URL when editing an integration
+
+ .PARAMETER Matched
+ Filter on whether the company already been matched
+
+ .PARAMETER SyncId
+ Filter by ID of the record in the integration. This is used if the id that the integration uses is an integer.
+
+ .PARAMETER Identifier
+ Filter by Identifier in the integration (if sync_id is not set). This is used if the id that the integration uses is a string.
+
+ .PARAMETER CompanyId
+ Filter on company id
+
+ .EXAMPLE
+ Get-HuduIntegrationMatchers -IntegrationId 1
+
+ #>
+ [CmdletBinding()]
+ Param (
+ [Parameter(Mandatory = $true)]
+ [int]$IntegrationId,
+
+ [switch]$Matched,
+
+ [int]$SyncId = '',
+
+ [string]$Identifier = '',
+
+ [int]$CompanyId
+ )
+
+ $Params = @{
+ integration_id = $IntegrationId
+ }
+
+ if ($Matched.IsPresent) { $Params.matched = 'true' }
+ if ($CompanyId) { $Params.company_id = $CompanyId }
+ if ($Identifier) { $Params.identifier = $Identifier }
+ if ($SyncId) { $Params.sync_id = $SyncId }
+
+ $HuduRequest = @{
+ Method = 'GET'
+ Resource = '/api/v1/matchers'
+ Params = $Params
+ }
+ Invoke-HuduRequestPaginated -HuduRequest $HuduRequest -Property 'matchers'
+}
+#EndRegion './Public/Get-HuduIntegrationMatchers.ps1' 58
+#Region './Public/Get-HuduMagicDashes.ps1' -1
+
+function Get-HuduMagicDashes {
+ <#
+ .SYNOPSIS
+ Get all Magic Dash Items
+
+ .DESCRIPTION
+ Call Hudu API to retrieve Magic Dashes
+
+ .PARAMETER CompanyId
+ Filter by company id
+
+ .PARAMETER Title
+ Filter by title
+
+ .EXAMPLE
+ Get-HuduMagicDashes -Title 'Microsoft 365 - ...'
+
+ #>
+ Param (
+ [Alias('company_id')]
+ [Int]$CompanyId,
+ [String]$Title
+ )
+
+ $Params = @{}
+
+ if ($CompanyId) { $Params.company_id = $CompanyId }
+ if ($Title) { $Params.title = $Title }
+
+ $HuduRequest = @{
+ Method = 'GET'
+ Resource = '/api/v1/magic_dash'
+ Params = $Params
+ }
+ Invoke-HuduRequestPaginated -HuduRequest $HuduRequest
+}
+#EndRegion './Public/Get-HuduMagicDashes.ps1' 37
+#Region './Public/Get-HuduObjectByUrl.ps1' -1
+
+function Get-HuduObjectByUrl {
+ <#
+ .SYNOPSIS
+ Get Hudu object from URL
+
+ .DESCRIPTION
+ Calls Hudu API to retrieve object based on URL string
+
+ .PARAMETER Url
+ Url to retrieve object from
+
+ .EXAMPLE
+ Get-HuduObject -Url https://your-hudu-server/a/some-asset-1z8z7a
+
+ #>
+ [CmdletBinding()]
+ Param (
+ [uri]$Url
+ )
+
+ if ((Get-HuduBaseURL) -match $Url.Authority) {
+ $null, $Type, $Slug = $Url.PathAndQuery -split '/'
+
+ $SlugSplat = @{
+ Slug = $Slug
+ }
+
+ switch ($Type) {
+ 'a' {
+ # Asset
+ Get-HuduAssets @SlugSplat
+ }
+ 'admin' {
+ # Admin path
+ $null, $null, $Type, $Slug = $Url.PathAndQuery -split '/'
+ $SlugSplat = @{
+ Slug = $Slug
+ }
+ switch ($Type) {
+ 'asset_layouts' {
+ # Asset layouts
+ Get-HuduAssetLayouts @SlugSplat
+ }
+ }
+ }
+ 'c' {
+ # Company
+ Get-HuduCompanies @SlugSplat
+ }
+ 'kba' {
+ # KB article
+ Get-HuduArticles @SlugSplat
+ }
+ 'passwords' {
+ # Passwords
+ Get-HuduPasswords @SlugSplat
+ }
+ 'websites' {
+ # Website
+ Get-HuduWebsites @SlugSplat
+ }
+ default {
+ Write-Error "Unsupported object type $Type"
+ }
+ }
+ } else {
+ Write-Error 'Provided URL does not match Hudu Base URL'
+ }
+}
+#EndRegion './Public/Get-HuduObjectByUrl.ps1' 70
+#Region './Public/Get-HuduPasswordFolders.ps1' -1
+
+function Get-HuduPasswordFolders {
+ <#
+ .SYNOPSIS
+ Get a list of Password Folders
+
+ .DESCRIPTION
+ Calls Hudu API to retrieve folders
+
+ .PARAMETER Id
+ Id of the folder
+
+ .PARAMETER Name
+ Filter by name
+
+ .PARAMETER CompanyId
+ Filter by company_id
+
+ .EXAMPLE
+ Get-HuduFolders
+
+ #>
+ [CmdletBinding()]
+ Param (
+ [Int]$Id = '',
+ [String]$Name = '',
+ [String]$Search = '',
+ [Alias('company_id')]
+ [Int]$CompanyId = '',
+ [Int]$page = '',
+ [Int]$page_size = ''
+ )
+
+ if ($id) {
+ $Folder = Invoke-HuduRequest -Method get -Resource "/api/v1/password_folders/$id"
+ return $Folder.password_folder
+ } else {
+ $Params = @{}
+
+ if ($CompanyId) { $Params.company_id = $CompanyId }
+ if ($Name) { $Params.name = $Name }
+
+ $HuduRequest = @{
+ Method = 'GET'
+ Resource = '/api/v1/password_folders'
+ Params = $Params
+ }
+ Invoke-HuduRequestPaginated -HuduRequest $HuduRequest -Property password_folders
+ }
+}
+#EndRegion './Public/Get-HuduPasswordFolders.ps1' 50
+#Region './Public/Get-HuduPasswords.ps1' -1
+
+function Get-HuduPasswords {
+ <#
+ .SYNOPSIS
+ Get a list of Passwords
+
+ .DESCRIPTION
+ Calls Hudu API to list password assets
+
+ .PARAMETER Id
+ Id of the password
+
+ .PARAMETER CompanyId
+ Filter by company id
+
+ .PARAMETER Name
+ Filter by password name
+
+ .PARAMETER Slug
+ Filter by url slug
+
+ .PARAMETER Search
+ Filter by search query
+
+ .EXAMPLE
+ Get-HuduPasswords -CompanyId 1
+
+ #>
+ [CmdletBinding()]
+ Param (
+ [Int]$Id,
+
+ [Alias('company_id')]
+ [Int]$CompanyId,
+
+ [String]$Name,
+
+ [String]$Slug,
+
+ [string]$Search
+ )
+
+ if ($Id) {
+ $Password = Invoke-HuduRequest -Method get -Resource "/api/v1/asset_passwords/$id"
+ return $Password
+ } else {
+ $Params = @{}
+ if ($CompanyId) { $Params.company_id = $CompanyId }
+ if ($Name) { $Params.name = $Name }
+ if ($Slug) { $Params.slug = $Slug }
+ if ($Search) { $Params.search = $Search }
+ }
+
+ $HuduRequest = @{
+ Method = 'GET'
+ Resource = '/api/v1/asset_passwords'
+ Params = $Params
+ }
+ Invoke-HuduRequestPaginated -HuduRequest $HuduRequest -Property 'asset_passwords'
+}
+#EndRegion './Public/Get-HuduPasswords.ps1' 60
+#Region './Public/Get-HuduProcesses.ps1' -1
+
+function Get-HuduProcesses {
+ <#
+ .SYNOPSIS
+ Get a list of Procedures (Processes)
+
+ .DESCRIPTION
+ Calls Hudu API to retrieve list of procedures
+
+ .PARAMETER Id
+ Id of the Procedure
+
+ .PARAMETER CompanyId
+ Filter by company id
+
+ .PARAMETER Name
+ Fitler by name of article
+
+ .PARAMETER Slug
+ Filter by url slug
+
+ .EXAMPLE
+ Get-HuduProcedures -Name 'Procedure 1'
+
+ #>
+ [CmdletBinding()]
+ Param (
+ [Int]$Id = '',
+ [Alias('company_id')]
+ [Int]$CompanyId = '',
+ [String]$Name = '',
+ [String]$Slug
+ )
+
+ if ($Id) {
+ Invoke-HuduRequest -Method get -Resource "/api/v1/procedures/$id"
+ } else {
+ $Params = @{}
+
+ if ($CompanyId) { $Params.company_id = $CompanyId }
+ if ($Name) { $Params.name = $Name }
+ if ($Slug) { $Params.slug = $Slug }
+
+
+ $HuduRequest = @{
+ Method = 'GET'
+ Resource = '/api/v1/procedures'
+ Params = $Params
+ }
+ Invoke-HuduRequestPaginated -HuduRequest $HuduRequest -Property 'procedures'
+ }
+}
+#EndRegion './Public/Get-HuduProcesses.ps1' 52
+#Region './Public/Get-HuduPublicPhotos.ps1' -1
+
+function Get-HuduPublicPhotos {
+ <#
+ .SYNOPSIS
+ Get a list of Public_Photos
+
+ .DESCRIPTION
+ Calls Hudu API to retrieve public photos
+
+ .EXAMPLE
+ Get-HuduPublicPhotos
+
+ #>
+ [CmdletBinding()]
+ Param()
+
+ $HuduRequest = @{
+ Method = 'GET'
+ Resource = '/api/v1/public_photos'
+ Params = @{}
+ }
+ Invoke-HuduRequestPaginated -HuduRequest $HuduRequest -Property 'public_photos'
+}
+#EndRegion './Public/Get-HuduPublicPhotos.ps1' 23
+#Region './Public/Get-HuduRelations.ps1' -1
+
+function Get-HuduRelations {
+ <#
+ .SYNOPSIS
+ Get a list of all relations
+
+ .DESCRIPTION
+ Calls Hudu API to retrieve object relationsihps
+
+ .EXAMPLE
+ Get-HuduRelations -CompanyId 1
+
+ #>
+ [CmdletBinding()]
+ Param()
+
+ $HuduRequest = @{
+ Method = 'GET'
+ Resource = '/api/v1/relations'
+ Params = @{}
+ }
+
+ Invoke-HuduRequestPaginated -HuduRequest $HuduRequest -Property 'relations'
+}
+#EndRegion './Public/Get-HuduRelations.ps1' 24
+#Region './Public/Get-HuduUploads.ps1' -1
+
+function Get-HuduUploads {
+ <#
+ .SYNOPSIS
+ Get a list of uploads
+
+ .DESCRIPTION
+ Calls Hudu API to retrieve uploads
+
+ .EXAMPLE
+ Get-HuduUploads
+
+ #>
+ [CmdletBinding()]
+ Param(
+ [Int]$Id
+ )
+
+ if ($Id) {
+ $Upload = Invoke-HuduRequest -Method Get -Resource "/api/v1/uploads/$Id"
+ } else {
+ $Upload = Invoke-HuduRequest -Method Get -Resource "/api/v1/uploads"
+ }
+ return $Upload
+}
+#EndRegion './Public/Get-HuduUploads.ps1' 25
+#Region './Public/Get-HuduWebsites.ps1' -1
+
+function Get-HuduWebsites {
+ <#
+ .SYNOPSIS
+ Get a list of all websites
+
+ .DESCRIPTION
+ Calls Hudu API to get websites
+
+ .PARAMETER Name
+ Filter websites by name
+
+ .PARAMETER Id
+ ID of website
+
+ .PARAMETER Slug
+ Filter by url slug
+
+ .PARAMETER Search
+ Fitler by search query
+
+ .EXAMPLE
+ Get-HuduWebsites -Search 'domain.com'
+
+ #>
+ [CmdletBinding()]
+ Param (
+ [String]$Name,
+ [Alias('website_id')]
+ [Int]$WebsiteId,
+ [String]$Slug,
+ [string]$Search
+ )
+
+ if ($WebsiteId) {
+ Invoke-HuduRequest -Method get -Resource "/api/v1/websites/$($WebsiteId)"
+ } else {
+ $Params = @{}
+ if ($Name) { $Params.name = $Name }
+ if ($Slug) { $Params.slug = $Slug }
+ if ($Search) { $Params.search = $Search }
+
+ $HuduRequest = @{
+ Method = 'GET'
+ Resource = '/api/v1/websites'
+ Params = $Params
+ }
+ Invoke-HuduRequestPaginated -HuduRequest $HuduRequest
+ }
+}
+#EndRegion './Public/Get-HuduWebsites.ps1' 50
+#Region './Public/Initialize-HuduFolder.ps1' -1
+
+function Initialize-HuduFolder {
+ [CmdletBinding()]
+ param(
+ [String[]]$FolderPath,
+ [Alias('company_id')]
+ [int]$CompanyId
+ )
+
+ if ($CompanyId) {
+ $FolderMap = Get-HuduFolderMap -company_id $CompanyId
+ } else {
+ $FolderMap = Get-HuduFolderMap
+ }
+
+ $CurrentFolder = $Foldermap
+ foreach ($Folder in $FolderPath) {
+ if ($CurrentFolder.$(Get-HuduFolderCleanName $Folder)) {
+ $CurrentFolder = $CurrentFolder.$(Get-HuduFolderCleanName $Folder)
+ } else {
+ $CurrentFolder = (New-HuduFolder -Name $Folder -company_id $CompanyID -parent_folder_id $CurrentFolder.id).folder
+ }
+ }
+
+ return $CurrentFolder
+}
+#EndRegion './Public/Initialize-HuduFolder.ps1' 26
+#Region './Public/Move-HuduAssetsToNewLayout.ps1' -1
+
+function Move-HuduAssetsToNewLayout {
+<#
+ .SYNOPSIS
+ Helper function that uses the Set-HuduAsset function to move an asset between asset layouts. This will leave behind orphan data in the database.
+ Review the article https://portal.risingtidegroup.net/kb?id=29 for more details.
+
+ .DESCRIPTION
+ Calls the Hudu API to update an asset by switching its asset_layout_id property to a different asset layout.
+ This function migrates the asset to the specified new layout while maintaining its fields. Note that this
+ operation may leave behind orphaned data in the Hudu database, so use it with caution.
+
+ .PARAMETER AssetsToMove
+ An array of assets to be moved to a new asset layout. Each asset must contain both 'id' and 'fields' properties.
+
+ .PARAMETER NewAssetLayoutID
+ The ID of the new asset layout to which the assets will be moved.
+
+ .EXAMPLE
+ $AssetLayout = Get-HuduAssetLayouts -Name "Servers"
+ $AssetsToUpdate = Get-HuduAssets -AssetLayoutId 9
+ Move-HuduAssetsToNewLayout -AssetsToMove $AssetsToUpdate -NewAssetLayoutID $AssetLayout.id
+
+ This example retrieves the asset layout with the name "Servers" and the assets with the layout ID 9, then moves those assets to the new layout.
+
+ .NOTES
+ Ensure that the new asset layout ID is valid and that the assets to be moved contain the required properties.
+ Using this function may result in orphaned data in your Hudu database. Review the provided article for more details.
+#>
+ [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'High')]
+ param(
+ [Parameter(Mandatory = $true)]
+ [ValidateNotNullOrEmpty()]
+ [ValidateScript({
+ if ($BadAssets = ($_ | where {(-not $_.id)})) {
+ $BadAssets
+ throw "Assets must be an object with an ID"
+ }
+ return $true
+ })]
+ [array]
+ $AssetsToMove,
+
+ [Parameter(Mandatory = $true)]
+ [int]
+ $NewAssetLayoutID
+ )
+
+ Write-Warning "Performing this function will leave behind orphaned data in your Hudu database. Please review https://portal.risingtidegroup.net/kb?id=29"
+ Read-Host "Press Enter to continue or (CTRL+C) to cancel..."
+
+ $assets = foreach ($AssetToMove in $AssetsToMove) {
+ if (-not ($AssetToMove.PSObject.Properties.Match('id')) -or -not ($AssetToMove.PSObject.Properties.Match('fields'))) {
+ Write-Error "Asset does not contain both 'id' and 'fields' properties. Skipping this asset."
+ continue
+ }
+
+ if (-not $AssetToMove.fields) {
+ Write-Warning "Asset ID: $($AssetToMove.id) has no fields. Proceeding with moving the asset."
+ }
+
+ $assetId = $AssetToMove.id
+
+ if ($PSCmdlet.ShouldProcess("Asset ID: $assetId", "Move to new layout with ID $NewAssetLayoutID")) {
+ try {
+ Write-Verbose "Processing Asset ID: $assetId"
+
+ $fields = New-Object -TypeName psobject
+ foreach ($field in $AssetToMove.fields) {
+ $fieldName = $field.label.replace(' ', '_').tolower()
+ $fields | Add-Member -MemberType NoteProperty -Name $fieldName -Value $field.value -Force
+ }
+
+ (Set-HuduAsset -Id $assetId -AssetLayoutId $NewAssetLayoutID -Fields $fields).asset
+
+ Write-Verbose "Successfully moved Asset ID: $assetId"
+ }
+ catch {
+ Write-Error "Failed to move Asset ID: $assetId. Error: $_"
+ }
+ finally {
+ Remove-Variable -Name fields -ErrorAction SilentlyContinue
+ }
+ }
+ }
+ return $assets
+}
+#EndRegion './Public/Move-HuduAssetsToNewLayout.ps1' 87
+#Region './Public/New-HuduAPIKey.ps1' -1
+
+function New-HuduAPIKey {
+ <#
+ .SYNOPSIS
+ Set Hudu API Key
+
+ .DESCRIPTION
+ API keys are required to interact with Hudu
+
+ .PARAMETER ApiKey
+ The API key
+
+ .EXAMPLE
+ New-HuduAPIKey -ApiKey abdc1234
+
+ #>
+ [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingConvertToSecureStringWithPlainText', '', Scope = 'Function')]
+ [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '', Scope = 'Function')]
+ [CmdletBinding()]
+ Param (
+ [Parameter(Mandatory = $false, ValueFromPipeline = $true)]
+ [String]$ApiKey
+ )
+
+ process {
+ if ($ApiKey) {
+ $SecApiKey = ConvertTo-SecureString $ApiKey -AsPlainText -Force
+ } else {
+ $SecApiKey = Read-Host -Prompt 'Please enter your Hudu API key, you can obtain it from https://your-hudu-domain/admin/api_keys:' -AsSecureString
+ }
+ Set-Variable -Name 'Int_HuduAPIKey' -Value $SecApiKey -Visibility Private -Scope script -Force
+
+ if ($script:Int_HuduBaseURL) {
+ [version]$version = (Get-HuduAppInfo).version
+ if ($version -lt $script:HuduRequiredVersion) {
+ Write-Warning "A connection error occured or Hudu version is below $script:HuduRequiredVersion"
+ }
+ }
+ }
+}
+#EndRegion './Public/New-HuduAPIKey.ps1' 40
+#Region './Public/New-HuduArticle.ps1' -1
+
+function New-HuduArticle {
+ <#
+ .SYNOPSIS
+ Create a Knowledge Base Article
+
+ .DESCRIPTION
+ Uses Hudu API to create KB articles
+
+ .PARAMETER Name
+ Name of article
+
+ .PARAMETER Content
+ Article HTML contents
+
+ .PARAMETER EnableSharing
+ Create public URL for users to view without being authenticated
+
+ .PARAMETER FolderId
+ Associate article with folder id
+
+ .PARAMETER CompanyId
+ Associate article with company id
+
+ .PARAMETER Slug
+ Manually define slug for Article
+
+ .EXAMPLE
+ New-HuduArticle -Name "Test" -CompanyId 1 -Content 'Testing' -EnableSharing -Slug 'this-is-a-test'
+
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ Param (
+ [Parameter(Mandatory = $true)]
+ [String]$Name,
+
+ [Parameter(Mandatory = $true)]
+ [String]$Content,
+
+ [switch]$EnableSharing,
+
+ [Alias('folder_id')]
+ [Int]$FolderId = '',
+
+ [Alias('company_id')]
+ [Int]$CompanyId = '',
+
+ [string]$Slug
+ )
+
+ $Article = [ordered]@{article = [ordered]@{} }
+
+ $Article.article.add('name', $Name)
+ $Article.article.add('content', $Content)
+
+ if ($FolderId) {
+ $Article.article.add('folder_id', $FolderId)
+ }
+
+ if ($CompanyId) {
+ $Article.article.add('company_id', $CompanyId)
+ }
+
+ if ($EnableSharing.IsPresent) {
+ $Article.article.add('enable_sharing', 'true')
+ }
+
+ if ($Slug) {
+ $Article.article.add('slug', $Slug)
+ }
+
+ $JSON = $Article | ConvertTo-Json -Depth 10
+
+ if ($PSCmdlet.ShouldProcess($Name)) {
+ Invoke-HuduRequest -Method post -Resource '/api/v1/articles' -Body $JSON
+ }
+}
+#EndRegion './Public/New-HuduArticle.ps1' 77
+#Region './Public/New-HuduAsset.ps1' -1
+
+function New-HuduAsset {
+ <#
+ .SYNOPSIS
+ Create an Asset
+
+ .DESCRIPTION
+ Uses Hudu API to create assets using custom layouts
+
+ .PARAMETER Name
+ Name of the Asset
+
+ .PARAMETER CompanyId
+ Company id for asset
+
+ .PARAMETER AssetLayoutId
+ Asset layout id
+
+ .PARAMETER Fields
+ Array of custom fields and values
+
+ .PARAMETER PrimarySerial
+ Asset primary serial number
+
+ .PARAMETER PrimaryMail
+ Asset primary mail
+
+ .PARAMETER PrimaryModel
+ Asset primary model
+
+ .PARAMETER PrimaryManufacturer
+ Asset primary manufacturer
+
+ .PARAMETER Slug
+ Url identifier
+
+ .EXAMPLE
+ New-HuduAsset -Name 'Some asset' -CompanyId 1 -Fields @(@{'field_name'='Field Value'})
+
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ Param (
+ [Parameter(Mandatory = $true)]
+ [String]$Name,
+
+ [Alias('company_id')]
+ [Parameter(Mandatory = $true)]
+ [Int]$CompanyId,
+
+ [Alias('asset_layout_id')]
+ [Parameter(Mandatory = $true)]
+ [Int]$AssetLayoutId,
+
+ [Array]$Fields,
+
+ [Alias('primary_serial')]
+ [string]$PrimarySerial,
+
+ [Alias('primary_mail')]
+ [string]$PrimaryMail,
+
+ [Alias('primary_model')]
+ [string]$PrimaryModel,
+
+ [Alias('primary_manufacturer')]
+ [string]$PrimaryManufacturer
+ )
+
+ $Asset = [ordered]@{asset = [ordered]@{} }
+
+ $Asset.asset.add('name', $Name)
+ $Asset.asset.add('asset_layout_id', $AssetLayoutId)
+
+
+ if ($PrimarySerial) {
+ $Asset.asset.add('primary_serial', $PrimarySerial)
+ }
+
+ if ($PrimaryMail) {
+ $Asset.asset.add('primary_mail', $PrimaryMail)
+ }
+
+ if ($PrimaryModel) {
+ $Asset.asset.add('primary_model', $PrimaryModel)
+ }
+
+ if ($PrimaryManufacturer) {
+ $Asset.asset.add('primary_manufacturer', $PrimaryManufacturer)
+ }
+
+ if ($Fields) {
+ $Asset.asset.add('custom_fields', $Fields)
+ }
+
+ if ($Slug) {
+ $Asset.asset.add('slug', $Slug)
+ }
+
+ $JSON = $Asset | ConvertTo-Json -Depth 10
+
+ if ($PSCmdlet.ShouldProcess($Name)) {
+ Invoke-HuduRequest -Method post -Resource "/api/v1/companies/$CompanyId/assets" -Body $JSON
+ }
+}
+#EndRegion './Public/New-HuduAsset.ps1' 104
+#Region './Public/New-HuduAssetLayout.ps1' -1
+
+function New-HuduAssetLayout {
+ <#
+ .SYNOPSIS
+ Create an Asset Layout
+
+ .DESCRIPTION
+ Uses Hudu API to create new custom asset layout
+
+ .PARAMETER Name
+ Name of the layout
+
+ .PARAMETER Icon
+ FontAwesome Icon class name, example: "fas fa-home"
+
+ .PARAMETER Color
+ Background color hex code
+
+ .PARAMETER IconColor
+ Icon color hex code
+
+ .PARAMETER IncludePasswords
+ Boolean for including passwords
+
+ .PARAMETER IncludePhotos
+ Boolean for including photos
+
+ .PARAMETER IncludeComments
+ Boolean for including comments
+
+ .PARAMETER IncludeFiles
+ Boolean for including files
+
+ .PARAMETER PasswordTypes
+ List of password types, separated with new line characters
+
+ .PARAMETER Slug
+ Url identifier
+
+ .PARAMETER Fields
+ Array of hashtable or custom objects representing layout fields. Most field types only require a label and type.
+ Valid field types are: Text, RichText, Heading, CheckBox, Website (aka Link), Password (aka ConfidentialText), Number, Date, DropDown, Embed, Email (aka CopyableText), Phone, AssetLink
+ Field types are Case Sensitive as of Hudu V2.27 due to a known issue with asset type validation.
+
+ .EXAMPLE
+ New-HuduAssetLayout -Name 'Test asset layout' -Icon 'fas fa-home' -IncludePassword $true
+
+ .EXAMPLE
+ New-HuduAssetLayout -Name 'Test asset layout' -Icon 'fas fa-home' -IncludePassword $true -Fields @(
+ @{label = 'Test field'; 'field_type' = 'Text'}
+ )
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ # This will silence the warning for variables with Password in their name.
+ [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingPlainTextForPassword', '')]
+ Param (
+ [Parameter(Mandatory = $true)]
+ [String]$Name,
+
+ [Parameter(Mandatory = $true)]
+ [String]$Icon,
+
+ [Parameter(Mandatory = $true)]
+ [String]$Color,
+
+ [Alias('icon_color')]
+ [Parameter(Mandatory = $true)]
+ [String]$IconColor,
+
+ [Alias('include_passwords')]
+ [bool]$IncludePasswords = '',
+
+ [Alias('include_photos')]
+ [bool]$IncludePhotos = '',
+
+ [Alias('include_comments')]
+ [bool]$IncludeComments = '',
+
+ [Alias('include_files')]
+ [bool]$IncludeFiles = '',
+
+ [Alias('password_types')]
+ [String]$PasswordTypes = '',
+
+ [Parameter(Mandatory = $true)]
+ [system.collections.generic.list[hashtable]]$Fields
+ )
+
+ foreach ($field in $fields) {
+ if ($field.show_in_list) { $field.show_in_list = [System.Convert]::ToBoolean($field.show_in_list) } else { $field.remove('show_in_list') }
+ if ($field.required) { $field.required = [System.Convert]::ToBoolean($field.required) } else { $field.remove('required') }
+ if ($field.expiration) { $field.expiration = [System.Convert]::ToBoolean($field.expiration) } else { $field.remove('expiration') }
+ # A bug in versions of Hudu 2.27 and earlier can cause asset layouts to become corrupted if the field type value is not properly cased.
+ switch ($field.'field_type') {
+ 'text' { $field.'field_type' = 'Text' }
+ 'richtext' { $field.'field_type' = 'RichText' }
+ 'heading' { $field.'field_type' = 'Heading' }
+ 'checkbox' { $field.'field_type' = 'CheckBox' }
+ 'number' { $field.'field_type' = 'Number' }
+ 'date' { $field.'field_type' = 'Date' }
+ 'dropdown' { $field.'field_type' = 'Dropdown' }
+ 'embed' { $field.'field_type' = 'Embed' }
+ 'phone' { $field.'field_type' = 'Phone' }
+ 'email' { $field.'field_type' = 'Email' }
+ 'copyabletext' { $field.'field_type' = 'Email' }
+ 'assettag' { $field.'field_type' = 'AssetTag' }
+ 'assetlink' { $field.'field_type' = 'AssetTag' }
+ 'website' { $field.'field_type' = 'Website' }
+ 'link' { $field.'field_type' = 'Website' }
+ 'password' { $field.'field_type' = 'Password' }
+ 'confidentialtext' { $field.'field_type' = 'Password' }
+ Default { throw "Invalid field type: $($field.'field_type') found in field $($field.name)" }
+ }
+ }
+
+ $AssetLayout = [ordered]@{asset_layout = [ordered]@{} }
+
+ $AssetLayout.asset_layout.add('name', $Name)
+ $AssetLayout.asset_layout.add('icon', $Icon)
+ $AssetLayout.asset_layout.add('color', $Color)
+ $AssetLayout.asset_layout.add('icon_color', $IconColor)
+ $AssetLayout.asset_layout.add('fields', $Fields)
+ #$AssetLayout.asset_layout.add('active', $Active)
+
+ if ($IncludePasswords) {
+ $AssetLayout.asset_layout.add('include_passwords', [System.Convert]::ToBoolean($IncludePasswords))
+ }
+
+ if ($IncludePhotos) {
+ $AssetLayout.asset_layout.add('include_photos', [System.Convert]::ToBoolean($IncludePhotos))
+ }
+
+ if ($IncludeComments) {
+ $AssetLayout.asset_layout.add('include_comments', [System.Convert]::ToBoolean($IncludeComments))
+ }
+
+ if ($IncludeFiles) {
+ $AssetLayout.asset_layout.add('include_files', [System.Convert]::ToBoolean($IncludeFiles))
+ }
+
+ if ($PasswordTypes) {
+ $AssetLayout.asset_layout.add('password_types', $PasswordTypes)
+ }
+
+ if ($Slug) {
+ $AssetLayout.asset_layout.add('slug', $Slug)
+ }
+
+ $JSON = $AssetLayout | ConvertTo-Json -Depth 10
+
+ Write-Verbose $JSON
+
+ if ($PSCmdlet.ShouldProcess($Name)) {
+ Invoke-HuduRequest -Method post -Resource '/api/v1/asset_layouts' -Body $JSON
+ }
+}
+#EndRegion './Public/New-HuduAssetLayout.ps1' 156
+#Region './Public/New-HuduBaseURL.ps1' -1
+
+function New-HuduBaseURL {
+ <#
+ .SYNOPSIS
+ Set Hudu Base URL
+
+ .DESCRIPTION
+ In order to access the Hudu API the Base URL must be set
+
+ .PARAMETER BaseURL
+ Url with no trailing slash e.g. https://demo.huducloud.com
+
+ .EXAMPLE
+ New-HuduBaseURL -BaseURL https://demo.huducloud.com
+
+ .NOTES
+ General notes
+ #>
+ [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '', Scope = 'Function')]
+ [CmdletBinding()]
+ Param (
+ [Parameter(Mandatory = $false,
+ ValueFromPipeline = $true)]
+ [String]
+ $BaseURL
+ )
+ process {
+ if (!$BaseURL) {
+ $BaseURL = Read-Host -Prompt 'Please enter your Hudu Base URL with no trailing /, for example https://demo.huducloud.com :'
+ }
+
+ $Protocol = $BaseURL[0..7] -join ''
+ if ($Protocol -ne 'https://') {
+ if ($Protocol -like 'http://*') {
+ Write-Warning "Non HTTPS Base URL was set, rewriting URL to be secure transport only. If connection fails please make sure hostname is correct and HTTPS is enabld."
+ $BaseURL = $BaseURL.Replace('http://','https://')
+ }
+ else {
+ Write-Warning "No protocol was specified, adding https:// to the beginning of the specified hostname"
+ $BaseURL = "https://$BaseURL"
+ }
+ }
+
+ Set-Variable -Name 'Int_HuduBaseURL' -Value $BaseURL -Visibility Private -Scope script -Force
+
+ if ($script:Int_HuduAPIKey) {
+ [version]$Version = (Get-HuduAppInfo).version
+ if ($Version -lt $script:HuduRequiredVersion) {
+ Write-Warning "A connection error occured or Hudu version is below $script:HuduRequiredVersion"
+ }
+ }
+ }
+}
+#EndRegion './Public/New-HuduBaseURL.ps1' 53
+#Region './Public/New-HuduCompany.ps1' -1
+
+function New-HuduCompany {
+ <#
+ .SYNOPSIS
+ Create a company
+
+ .DESCRIPTION
+ Uses Hudu API to create a new company
+
+ .PARAMETER Name
+ Company name
+
+ .PARAMETER Nickname
+ Company nickname
+
+ .PARAMETER CompanyType
+ Company type
+
+ .PARAMETER AddressLine1
+ Address line 1
+
+ .PARAMETER AddressLine2
+ Address line 2
+
+ .PARAMETER City
+ City
+
+ .PARAMETER State
+ State
+
+ .PARAMETER Zip
+ Zip
+
+ .PARAMETER CountryName
+ Country
+
+ .PARAMETER PhoneNumber
+ Phone number
+
+ .PARAMETER FaxNumber
+ Fax number
+
+ .PARAMETER Website
+ Website
+
+ .PARAMETER IdNumber
+ Company id number
+
+ .PARAMETER ParentCompanyId
+ Parent company id number
+
+ .PARAMETER Notes
+ Parameter description
+
+ .PARAMETER Slug
+ Url identifier
+
+ .EXAMPLE
+ New-HuduCompany -Name 'Company name'
+
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ Param (
+ [Parameter(Mandatory = $true)]
+ [String]$Name,
+
+ [String]$Nickname = '',
+
+ [Alias('company_type')]
+ [String]$CompanyType = '',
+
+ [Alias('address_line_1')]
+ [String]$AddressLine1 = '',
+
+ [Alias('address_line_2')]
+ [String]$AddressLine2 = '',
+
+ [String]$City = '',
+
+ [String]$State = '',
+
+ [Alias('PostalCode', 'PostCode')]
+ [String]$Zip = '',
+
+ [Alias('country_name')]
+ [String]$CountryName = '',
+
+ [Alias('phone_number')]
+ [String]$PhoneNumber = '',
+
+ [Alias('fax_number')]
+ [String]$FaxNumber = '',
+
+ [String]$Website = '',
+
+ [Alias('id_number')]
+ [String]$IdNumber = '',
+
+ [Alias('parent_company_id')]
+ [int]$ParentCompanyId,
+
+ [String]$Notes = '',
+
+ [string]$Slug
+ )
+
+
+ $Company = [ordered]@{company = [ordered]@{} }
+
+ $Company.company.add('name', $Name)
+ if (-not ([string]::IsNullOrEmpty($Nickname))) { $Company.company.add('nickname', $Nickname) }
+ if (-not ([string]::IsNullOrEmpty($Nickname))) { $Company.company.add('company_type', $CompanyType) }
+ if (-not ([string]::IsNullOrEmpty($AddressLine1))) { $Company.company.add('address_line_1', $AddressLine1) }
+ if (-not ([string]::IsNullOrEmpty($AddressLine2))) { $Company.company.add('address_line_2', $AddressLine2) }
+ if (-not ([string]::IsNullOrEmpty($City))) { $Company.company.add('city', $City) }
+ if (-not ([string]::IsNullOrEmpty($State))) { $Company.company.add('state', $State) }
+ if (-not ([string]::IsNullOrEmpty($Zip))) { $Company.company.add('zip', $Zip) }
+ if (-not ([string]::IsNullOrEmpty($CountryName))) { $Company.company.add('country_name', $CountryName) }
+ if (-not ([string]::IsNullOrEmpty($PhoneNumber))) { $Company.company.add('phone_number', $PhoneNumber) }
+ if (-not ([string]::IsNullOrEmpty($FaxNumber))) { $Company.company.add('fax_number', $FaxNumber) }
+ if (-not ([string]::IsNullOrEmpty($Website))) { $Company.company.add('website', $Website) }
+ if (-not ([string]::IsNullOrEmpty($IdNumber))) { $Company.company.add('id_number', $IdNumber) }
+ if (-not ([string]::IsNullOrEmpty($ParentCompanyId))) { $Company.company.add('parent_company_id', $ParentCompanyId) }
+ if (-not ([string]::IsNullOrEmpty($Notes))) { $Company.company.add('notes', $Notes) }
+ if (-not ([string]::IsNullOrEmpty($Slug))) { $Company.company.add('slug', $Slug) }
+
+ $JSON = $Company | ConvertTo-Json -Depth 10
+ Write-Verbose $JSON
+
+ if ($PSCmdlet.ShouldProcess($Name)) {
+ Invoke-HuduRequest -Method post -Resource '/api/v1/companies' -Body $JSON
+ }
+}
+#EndRegion './Public/New-HuduCompany.ps1' 133
+#Region './Public/New-HuduCustomHeaders.ps1' -1
+
+function New-HuduCustomHeaders {
+ <#
+ .SYNOPSIS
+ Set Hudu custom headers to be injected into each request
+
+ .DESCRIPTION
+ There may be times when one might need to use custom headers e.g. Service Tokens for Cloudflare Zero Trust
+
+ .PARAMETER Headers
+ Hashtable with the Custom Headers that need to be injected into each request
+
+ .EXAMPLE
+ New-HuduCustomHeaders -Headers @{"CF-Access-Client-Id" = "x"; "CF-Access-Client-Secret" = "y"}
+
+ .NOTES
+ General notes
+ #>
+ [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '', Scope = 'Function')]
+ [CmdletBinding()]
+ Param (
+ [Parameter(Mandatory = $true,
+ ValueFromPipeline = $true)]
+ [hashtable]
+ $Headers
+ )
+ process {
+ if ($Headers.Count -eq 0) {
+ Write-Host "Empty Custom Header hashtable was provided, no Custom Headers will be set"
+ return 0
+ }
+
+ Set-Variable -Name 'Int_HuduCustomHeaders' -Value $Headers -Visibility Private -Scope script -Force
+ }
+}
+#EndRegion './Public/New-HuduCustomHeaders.ps1' 35
+#Region './Public/New-HuduFolder.ps1' -1
+
+function New-HuduFolder {
+ <#
+ .SYNOPSIS
+ Create a Folder
+
+ .DESCRIPTION
+ Uses Hudu API to create a new folder
+
+ .PARAMETER Name
+ Name of the folder
+
+ .PARAMETER Icon
+ Folder Icon
+
+ .PARAMETER Description
+ Folder description
+
+ .PARAMETER ParentFolderId
+ Parent folder ID
+
+ .PARAMETER CompanyId
+ Company id
+
+ .EXAMPLE
+ New-HuduFolder -Name 'Test folder' -CompanyId 1
+
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ Param (
+ [Parameter(Mandatory = $true)]
+ [String]$Name,
+ [String]$Icon = '',
+ [String]$Description = '',
+ [Alias('parent_folder_id')]
+ [Int]$ParentFolderId = '',
+ [Alias('company_id')]
+ [Int]$CompanyId = ''
+ )
+
+ $Folder = [ordered]@{folder = [ordered]@{} }
+
+ $Folder.folder.add('name', $Name)
+
+ if ($Icon) {
+ $Folder.folder.add('icon', $Icon)
+ }
+
+ if ($Description) {
+ $Folder.folder.add('description', $Description)
+ }
+
+ if ($ParentFolderId) {
+ $Folder.folder.add('parent_folder_id', $ParentFolderId)
+ }
+
+ if ($CompanyId) {
+ $Folder.folder.add('company_id', $CompanyId)
+ }
+
+ $JSON = $Folder | ConvertTo-Json
+
+ if ($PSCmdlet.ShouldProcess($Name)) {
+ Invoke-HuduRequest -Method post -Resource '/api/v1/folders' -Body $JSON
+ }
+}
+#EndRegion './Public/New-HuduFolder.ps1' 66
+#Region './Public/New-HuduPassword.ps1' -1
+
+function New-HuduPassword {
+ <#
+ .SYNOPSIS
+ Create a Password
+
+ .DESCRIPTION
+ Uses Hudu API to create a new password
+
+ .PARAMETER Name
+ Name of the password
+
+ .PARAMETER CompanyId
+ Company id
+
+ .PARAMETER PasswordableType
+ Asset type for the password
+
+ .PARAMETER PasswordableId
+ Asset id for the password
+
+ .PARAMETER InPortal
+ Boolean for in portal
+
+ .PARAMETER Password
+ Password
+
+ .PARAMETER OTPSecret
+ OTP secret
+
+ .PARAMETER URL
+ Password URL
+
+ .PARAMETER Username
+ Username
+
+ .PARAMETER Description
+ Password description
+
+ .PARAMETER PasswordType
+ Password type
+
+ .PARAMETER PasswordFolderId
+ Password folder id
+
+ .PARAMETER Slug
+ Url identifier
+
+ .EXAMPLE
+ New-HuduPassword -Name 'Some website password' -Username 'user@domain.com' -Password '12345'
+
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ # This will silence the warning for variables with Password in their name.
+ [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingPlainTextForPassword', '')]
+ [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingUsernameAndPasswordParams', '')]
+ Param (
+ [Parameter(Mandatory = $true)]
+ [String]$Name,
+
+ [Alias('company_id')]
+ [Parameter(Mandatory = $true)]
+ [Int]$CompanyId,
+
+ [Alias('passwordable_type')]
+ [String]$PasswordableType = '',
+
+ [Alias('passwordable_id')]
+ [int]$PasswordableId = '',
+
+ [Alias('in_portal')]
+ [Bool]$InPortal = $false,
+
+ [Parameter(Mandatory = $true)]
+ [String]$Password = '',
+
+ [Alias('otp_secret')]
+ [string]$OTPSecret = '',
+
+ [String]$URL = '',
+
+ [String]$Username = '',
+
+ [String]$Description = '',
+
+ [Alias('password_type')]
+ [String]$PasswordType = '',
+
+ [Alias('password_folder_id')]
+ [int]$PasswordFolderId,
+
+ [string]$Slug
+ )
+
+ $AssetPassword = [ordered]@{asset_password = [ordered]@{} }
+
+ $AssetPassword.asset_password.add('name', $Name)
+ $AssetPassword.asset_password.add('company_id', $CompanyId)
+ $AssetPassword.asset_password.add('password', $Password)
+ $AssetPassword.asset_password.add('in_portal', $InPortal)
+
+ if ($PasswordableType) {
+ $AssetPassword.asset_password.add('passwordable_type', $PasswordableType)
+ }
+ if ($PasswordableId) {
+ $AssetPassword.asset_password.add('passwordable_id', $PasswordableId)
+ }
+
+ if ($OTPSecret) {
+ $AssetPassword.asset_password.add('otp_secret', $OTPSecret)
+ }
+
+ if ($URL) {
+ $AssetPassword.asset_password.add('url', $URL)
+ }
+
+ if ($Username) {
+ $AssetPassword.asset_password.add('username', $Username)
+ }
+
+ if ($Description) {
+ $AssetPassword.asset_password.add('description', $Description)
+ }
+
+ if ($PasswordType) {
+ $AssetPassword.asset_password.add('password_type', $PasswordType)
+ }
+
+ if ($PasswordFolderId) {
+ $AssetPassword.asset_password.add('password_folder_id', $PasswordFolderId)
+ }
+
+ if ($Slug) {
+ $AssetPassword.asset_password.add('slug', $Slug)
+ }
+
+ $JSON = $AssetPassword | ConvertTo-Json -Depth 10
+
+ if ($PSCmdlet.ShouldProcess($Name)) {
+ Invoke-HuduRequest -Method post -Resource '/api/v1/asset_passwords' -Body $JSON
+ }
+}
+#EndRegion './Public/New-HuduPassword.ps1' 142
+#Region './Public/New-HuduPublicPhoto.ps1' -1
+
+function New-HuduPublicPhoto {
+ <#
+ .SYNOPSIS
+ Create a Public Photo
+
+ .DESCRIPTION
+ Uses Hudu API to upload an image for use in an asset or article
+
+ .PARAMETER FilePath
+ Path to the image
+
+ .PARAMETER RecordId
+ Record id to associate with the photo
+
+ .PARAMETER RecordType
+ Record type to associate with the photo
+
+ .EXAMPLE
+ New-HuduPublicPhoto -FilePath 'c:\path\to\image.png' -RecordId 1 -RecordType 'asset'
+
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ param(
+ [Parameter(Mandatory)]
+ [string]$FilePath,
+
+ [Alias('record_id')]
+ [int]$RecordId,
+
+ [Alias('record_type')]
+ [string]$RecordType
+ )
+
+ $File = Get-Item $FilePath
+ $form = @{
+ photo = $File
+ }
+
+ if ($RecordId) { $form['record_id'] = $RecordId }
+ if ($RecordType) { $form['record_type'] = $RecordType }
+
+ if ($PSCmdlet.ShouldProcess($File.FullName)) {
+ Invoke-HuduRequest -Method POST -Resource '/api/v1/public_photos' -Form $form
+ }
+}
+#EndRegion './Public/New-HuduPublicPhoto.ps1' 46
+#Region './Public/New-HuduRelation.ps1' -1
+
+function New-HuduRelation {
+ <#
+ .SYNOPSIS
+ Create a Relation
+
+ .DESCRIPTION
+ Uses Hudu API to create relationships between objects
+
+ .PARAMETER Description
+ Give a description to the relation so you know why two things are related
+
+ .PARAMETER FromableType
+ The type of the FROM relation (Asset, Website, Procedure, AssetPassword, Company, Article)
+
+ .PARAMETER FromableID
+ The ID of the FROM relation
+
+ .PARAMETER ToableType
+ The type of the TO relation (Asset, Website, Procedure, AssetPassword, Company, Article)
+
+ .PARAMETER ToableID
+ The ID of the TO relation
+
+ .PARAMETER IsInverse
+ When a relation is created, it will also create another relation that is the inverse. When this is true, this relation is the inverse.
+
+ .EXAMPLE
+ An example
+
+ .NOTES
+ General notes
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ Param (
+ [String]$Description,
+
+ [Parameter(Mandatory = $true)]
+ [ValidateSet('Asset', 'Website', 'Procedure', 'AssetPassword', 'Company', 'Article')]
+ [Alias('fromable_type')]
+ [String]$FromableType,
+
+ [Alias('fromable_id')]
+ [int]$FromableID,
+
+ [Alias('toable_type')]
+ [String]$ToableType,
+
+ [Alias('toable_id')]
+ [int]$ToableID,
+
+ [Alias('is_inverse')]
+ [string]$IsInverse
+ )
+
+ $Relation = [ordered]@{relation = [ordered]@{} }
+
+ $Relation.relation.add('fromable_type', $FromableType)
+ $Relation.relation.add('fromable_id', $FromableID)
+ $Relation.relation.add('toable_type', $ToableType)
+ $Relation.relation.add('toable_id', $ToableID)
+
+ if ($Description) {
+ $Relation.relation.add('description', $Description)
+ }
+
+ if ($ISInverse) {
+ $Relation.relation.add('is_inverse', $ISInverse)
+ }
+
+ $JSON = $Relation | ConvertTo-Json -Depth 100
+
+ if ($PSCmdlet.ShouldProcess($FromableType)) {
+ Invoke-HuduRequest -Method post -Resource '/api/v1/relations' -Body $JSON
+ }
+}
+#EndRegion './Public/New-HuduRelation.ps1' 76
+#Region './Public/New-HuduUpload.ps1' -1
+
+function New-HuduUpload {
+ <#
+ .SYNOPSIS
+ Create a Upload
+
+ .DESCRIPTION
+ Uses Hudu API to upload a file for use in an asset. RecordType can be of 'asset','website','procedure','assetpassword','comapny','article'.
+
+ .PARAMETER FilePath
+ Path to the file
+
+ .PARAMETER RecordId
+ Record id to associate with the Upload
+
+ .PARAMETER RecordType
+ Record type to associate with the Upload
+
+ .EXAMPLE
+ New-HuduUpload -FilePath 'c:\path\to\file.png' -RecordId 1 -RecordType 'asset'
+
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ param(
+ [Parameter(Mandatory)]
+ [string]$FilePath,
+
+ [Parameter(Mandatory)]
+ [Alias('record_id','recordid')]
+ [int]$uploadable_id,
+
+ [Parameter(Mandatory)]
+ [Alias('record_type','recordtype')]
+ [ValidateSet('Asset', 'Website', 'Procedure', 'AssetPassword', 'Company', 'Article')]
+ [string]$uploadable_type
+ )
+
+ $File = Get-Item $FilePath
+
+ $form = @{
+ file = $File
+ "upload[uploadable_id]" = $uploadable_id
+ "upload[uploadable_type]" = $uploadable_type
+ }
+
+ if ($PSCmdlet.ShouldProcess($File.FullName)) {
+ Invoke-HuduRequest -Method POST -Resource '/api/v1/uploads' -Form $form
+ }
+}
+#EndRegion './Public/New-HuduUpload.ps1' 49
+#Region './Public/New-HuduWebsite.ps1' -1
+
+function New-HuduWebsite {
+ <#
+ .SYNOPSIS
+ Create a Website
+
+ .DESCRIPTION
+ Uses Hudu API to create a website
+
+ .PARAMETER Name
+ Website name (e.g. https://domain.com)
+
+ .PARAMETER Notes
+ Used to add additional notes to a website
+
+ .PARAMETER Paused
+ When true, website monitoring is paused
+
+ .PARAMETER CompanyId
+ Used to associate website with company
+
+ .PARAMETER DisableDNS
+ When true, dns monitoring is paused.
+
+ .PARAMETER DisableSSL
+ When true, ssl cert monitoring is paused.
+
+ .PARAMETER DisableWhois
+ When true, whois monitoring is paused.
+
+ .PARAMETER Slug
+ Url identifier
+
+ .EXAMPLE
+ New-HuduWebsite -CompanyId 1 -Name https://domain.com
+
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ Param (
+ [Parameter(Mandatory = $true)]
+ [String]$Name,
+
+ [String]$Notes = '',
+
+ [String]$Paused = '',
+
+ [Alias('company_id')]
+ [Parameter(Mandatory = $true)]
+ [Int]$CompanyId,
+
+ [Alias('disable_dns')]
+ [String]$DisableDNS = '',
+
+ [Alias('disable_ssl')]
+ [String]$DisableSSL = '',
+
+ [Alias('disable_whois')]
+ [String]$DisableWhois = '',
+
+ [string]$Slug
+ )
+
+ $Website = [ordered]@{website = [ordered]@{} }
+
+ $Website.website.add('name', $Name)
+
+ if ($Notes) {
+ $Website.website.add('notes', $Notes)
+ }
+
+ if ($Paused) {
+ $Website.website.add('paused', $Paused)
+ }
+
+ $Website.website.add('company_id', $CompanyId)
+
+ if ($DisableDNS) {
+ $Website.website.add('disable_dns', $DisableDNS)
+ }
+
+ if ($DisableSSL) {
+ $Website.website.add('disable_ssl', $DisableSSL)
+ }
+
+ if ($DisableWhois) {
+ $Website.website.add('disable_whois', $DisableWhois)
+ }
+
+ if ($Slug) {
+ $Website.website.add('slug', $Slug)
+ }
+
+ $JSON = $Website | ConvertTo-Json
+
+ if ($PSCmdlet.ShouldProcess($Name)) {
+ Invoke-HuduRequest -Method post -Resource '/api/v1/websites' -Body $JSON
+ }
+}
+#EndRegion './Public/New-HuduWebsite.ps1' 98
+#Region './Public/Remove-HuduAPIKey.ps1' -1
+
+function Remove-HuduAPIKey {
+ <#
+ .SYNOPSIS
+ Remove API key
+
+ .DESCRIPTION
+ Unsets the variable for the Hudu API Key
+
+ .EXAMPLE
+ Remove-HuduAPIKey
+
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ Param()
+
+ if ($PSCmdlet.ShouldProcess('API Key')) {
+ Remove-Variable -Name 'Int_HuduAPIKey' -Scope script -Force
+ }
+}
+#EndRegion './Public/Remove-HuduAPIKey.ps1' 20
+#Region './Public/Remove-HuduArticle.ps1' -1
+
+function Remove-HuduArticle {
+ <#
+ .SYNOPSIS
+ Delete a Knowledge Base Article
+
+ .DESCRIPTION
+ Uses Hudu API to remove a KB article
+
+ .PARAMETER Id
+ Id of the requested article
+
+ .EXAMPLE
+ Remove-HuduArticle -Id 1
+
+ .NOTES
+ General notes
+ #>
+ [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')]
+ Param (
+ [Parameter(ValueFromPipelineByPropertyName = $true, Mandatory = $true)]
+ [Int]$Id
+ )
+ process {
+ if ($PSCmdlet.ShouldProcess($Id)) {
+ Invoke-HuduRequest -Method delete -Resource "/api/v1/articles/$Id"
+ }
+ }
+}
+#EndRegion './Public/Remove-HuduArticle.ps1' 29
+#Region './Public/Remove-HuduAsset.ps1' -1
+
+function Remove-HuduAsset {
+ <#
+ .SYNOPSIS
+ Delete an Asset
+
+ .DESCRIPTION
+ Uses Hudu API to remove an Asset from a company
+
+ .PARAMETER Id
+ Id of the requested Asset
+
+ .PARAMETER CompanyId
+ Id of the requested parent Company
+
+ .EXAMPLE
+ Remove-HuduAsset -CompanyId 1 -Id 1
+
+ #>
+ [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')]
+ Param (
+ [Parameter(ValueFromPipelineByPropertyName = $true, Mandatory = $true)]
+ [Int]$Id,
+ [Alias('company_id')]
+ [Parameter(ValueFromPipelineByPropertyName = $true, Mandatory = $true)]
+ [Int]$CompanyId
+ )
+
+ process {
+ if ($PSCmdlet.ShouldProcess($Id)) {
+ Invoke-HuduRequest -Method delete -Resource "/api/v1/companies/$CompanyId/assets/$Id"
+ }
+ }
+}
+#EndRegion './Public/Remove-HuduAsset.ps1' 34
+#Region './Public/Remove-HuduBaseURL.ps1' -1
+
+function Remove-HuduBaseURL {
+ <#
+ .SYNOPSIS
+ Remove base URL
+
+ .DESCRIPTION
+ Unsets the Hudu Base URL variable
+
+ .EXAMPLE
+ Remove-HuduBaseURL
+
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ Param()
+ if ($PSCmdlet.ShouldProcess('Base URL')) {
+ Remove-Variable -Name 'Int_HuduBaseURL' -Scope script -Force
+ }
+}
+#EndRegion './Public/Remove-HuduBaseURL.ps1' 19
+#Region './Public/Remove-HuduCompany.ps1' -1
+
+function Remove-HuduCompany {
+ <#
+ .SYNOPSIS
+ Delete a Website
+
+ .DESCRIPTION
+ Uses Hudu API to delete a company
+
+ .PARAMETER Id
+ Id of the Company to delete
+
+ .EXAMPLE
+ Remove-HuduCompany -Id 1
+
+ #>
+ [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')]
+ Param (
+ [Parameter(ValueFromPipelineByPropertyName = $true, Mandatory = $true)]
+ [Int]$Id
+ )
+
+ process {
+ if ($PSCmdlet.ShouldProcess($Id)) {
+ Invoke-HuduRequest -Method delete -Resource "/api/v1/companies/$Id"
+ }
+ }
+}
+#EndRegion './Public/Remove-HuduCompany.ps1' 28
+#Region './Public/Remove-HuduCustomHeaders.ps1' -1
+
+function Remove-HuduCustomHeaders {
+ <#
+ .SYNOPSIS
+ Remove Custom Headers that are injected into each request
+
+ .DESCRIPTION
+ Unsets the Hudu Custom Header variable
+
+ .EXAMPLE
+ Remove-HuduCustomHeaders
+
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ Param()
+ if ($PSCmdlet.ShouldProcess('Custom Headers')) {
+ Remove-Variable -Name 'Int_HuduCustomHeaders' -Scope script -Force
+ }
+}
+#EndRegion './Public/Remove-HuduCustomHeaders.ps1' 19
+#Region './Public/Remove-HuduMagicDash.ps1' -1
+
+function Remove-HuduMagicDash {
+ <#
+ .SYNOPSIS
+ Delete a Magic Dash Item
+
+ .DESCRIPTION
+ Uses Hudu API to remove Magic Dash by Id or Title and Company Name
+
+ .PARAMETER Title
+ Title of the Magic Dash
+
+ .PARAMETER CompanyName
+ Company Name
+
+ .PARAMETER Id
+ Id of the Magic Dash
+
+ .EXAMPLE
+ Remove-HuduMagicDash -Id 1
+
+ .EXAMPLE
+ Remove-HuduMagicDash -Title 'Microsoft 365' -CompanyName 'AcmeCorp'
+
+ #>
+ [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High', DefaultParameterSetName = 'Id')]
+ Param (
+ [Parameter(ValueFromPipelineByPropertyName = $true, Mandatory = $true, ParameterSetName = 'TitleCompany')]
+ [String]$Title,
+
+ [Parameter(ValueFromPipelineByPropertyName = $true, Mandatory = $true, ParameterSetName = 'TitleCompany')]
+ [Alias('company_name')]
+ [String]$CompanyName,
+
+ [Parameter(ValueFromPipelineByPropertyName = $true, Mandatory = $true, ParameterSetName = 'Id')]
+ [int]$Id
+ )
+
+ process {
+ if ($id) {
+ if ($PSCmdlet.ShouldProcess($Id)) {
+ $null = Invoke-HuduRequest -Method delete -Resource "/api/v1/magic_dash/$Id"
+ }
+ } else {
+ $MagicDash = @{}
+
+ $MagicDash.add('title', $Title)
+ $MagicDash.add('company_name', $CompanyName)
+
+ $JSON = $MagicDash | ConvertTo-Json
+
+ if ($PSCmdlet.ShouldProcess("$Company - $Title")) {
+ $null = Invoke-HuduRequest -Method delete -Resource '/api/v1/magic_dash' -Body $JSON
+ }
+ }
+ }
+}
+#EndRegion './Public/Remove-HuduMagicDash.ps1' 57
+#Region './Public/Remove-HuduPassword.ps1' -1
+
+function Remove-HuduPassword {
+ <#
+ .SYNOPSIS
+ Delete a Password
+
+ .DESCRIPTION
+ Uses Hudu API to remove asset password
+
+ .PARAMETER Id
+ Id of the password
+
+ .EXAMPLE
+ Remove-HuduPassword -Id 1
+
+ #>
+ [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')]
+ Param (
+ [Parameter(ValueFromPipelineByPropertyName = $true, Mandatory = $true)]
+ [Int]$Id
+ )
+ process {
+ if ($PSCmdlet.ShouldProcess($Id)) {
+ Invoke-HuduRequest -Method delete -Resource "/api/v1/asset_passwords/$Id"
+ }
+ }
+}
+#EndRegion './Public/Remove-HuduPassword.ps1' 27
+#Region './Public/Remove-HuduRelation.ps1' -1
+
+function Remove-HuduRelation {
+ <#
+ .SYNOPSIS
+ Delete a Relation
+
+ .DESCRIPTION
+ Uses Hudu API to delete object relationships
+
+ .PARAMETER Id
+ Id of the requested Relation
+
+ .EXAMPLE
+ Remove-HuduRelation -Id 1
+
+ #>
+ [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')]
+ Param (
+ [Parameter(ValueFromPipelineByPropertyName = $true, Mandatory = $true)]
+ [Int]$Id
+ )
+
+ process {
+ if ($PSCmdlet.ShouldProcess($Id)) {
+ Invoke-HuduRequest -Method delete -Resource "/api/v1/relations/$Id"
+ }
+ }
+}
+#EndRegion './Public/Remove-HuduRelation.ps1' 28
+#Region './Public/Remove-HuduUpload.ps1' -1
+
+function Remove-HuduUpload {
+ <#
+ .SYNOPSIS
+ Delete an Upload by ID
+
+ .DESCRIPTION
+ Calls Hudu API to delete uploads by specifying the ID value
+
+ .EXAMPLE
+ Remove-HuduUpload
+
+ #>
+ [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')]
+ Param(
+ [Parameter(ValueFromPipelineByPropertyName = $true, Mandatory = $true)]
+ [Int]$Id
+ )
+
+ process {
+ if ($PSCmdlet.ShouldProcess($Id)) {
+ Invoke-HuduRequest -Method delete -Resource "/api/v1/uploads/$Id"
+ }
+ }
+
+}
+#EndRegion './Public/Remove-HuduUpload.ps1' 26
+#Region './Public/Remove-HuduWebsite.ps1' -1
+
+function Remove-HuduWebsite {
+ <#
+ .SYNOPSIS
+ Delete a Website
+
+ .DESCRIPTION
+ Uses Hudu API to delete a website
+
+ .PARAMETER Id
+ Id of the requested Website
+
+ .EXAMPLE
+ Remove-HuduWebsite -Id 1
+
+ #>
+ [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')]
+ Param (
+ [Parameter(ValueFromPipelineByPropertyName = $true, Mandatory = $true)]
+ [Int]$Id
+ )
+
+ process {
+ if ($PSCmdlet.ShouldProcess($Id)) {
+ Invoke-HuduRequest -Method delete -Resource "/api/v1/websites/$Id"
+ }
+ }
+}
+#EndRegion './Public/Remove-HuduWebsite.ps1' 28
+#Region './Public/Set-HuduArticle.ps1' -1
+
+function Set-HuduArticle {
+ <#
+ .SYNOPSIS
+ Update a Knowledge Base Article
+
+ .DESCRIPTION
+ Uses Hudu API to update KB Article
+
+ .PARAMETER Name
+ Name of the Article
+
+ .PARAMETER Content
+ Article Content
+
+ .PARAMETER EnableSharing
+ Set article to public and generate a URL
+
+ .PARAMETER FolderId
+ Used to associate article with folder
+
+ .PARAMETER CompanyId
+ Used to associate article with company
+
+ .PARAMETER ArticleId
+ Id of the requested article
+
+ .PARAMETER Slug
+ Url identifier
+
+ .EXAMPLE
+ Set-HuduArticle -ArticleId 1 -Name 'Article Name' -Content 'New article contents'
+
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ Param (
+ [String]$Name,
+
+ [String]$Content,
+ [switch]$EnableSharing,
+
+ [Alias('folder_id')]
+ [Int]$FolderId = '',
+
+ [Alias('company_id')]
+ [Int]$CompanyId = '',
+
+ [Alias('article_id', 'id')]
+ [Parameter(Mandatory = $true)]
+ [Int]$ArticleId,
+
+ [string]$Slug
+ )
+
+ $Object = Get-HuduArticles -Id $ArticleId
+ $Article = [ordered]@{article = $Object.article }
+
+ if ($Name) {
+ $Article.article.name = $Name
+ }
+
+ if ($Content) {
+ $Article.article.content = $Content
+ }
+
+ if ($FolderId) {
+ $Article.article.folder_id = $FolderId
+ }
+
+ if ($CompanyId) {
+ $Article.article.company_id = $CompanyId
+ }
+
+ if ($EnableSharing.IsPresent) {
+ $Article.article.enable_sharing = $true
+ }
+
+ if ($Slug) {
+ $Article.article.slug = $Slug
+ }
+
+ $JSON = $Article | ConvertTo-Json -Depth 10
+
+ if ($PSCmdlet.ShouldProcess($Name)) {
+ Invoke-HuduRequest -Method put -Resource "/api/v1/articles/$ArticleId" -Body $JSON
+ }
+}
+#EndRegion './Public/Set-HuduArticle.ps1' 87
+#Region './Public/Set-HuduArticleArchive.ps1' -1
+
+function Set-HuduArticleArchive {
+ <#
+ .SYNOPSIS
+ Archive/Unarchive a Knowledge Base Article
+
+ .DESCRIPTION
+ Uses Hudu API to archive or unarchive an article
+
+ .PARAMETER Id
+ Id of the requested article
+
+ .PARAMETER Archive
+ Boolean for archive status
+
+ .EXAMPLE
+ Set-HuduArticleArchive -Id 1 -Archive $true
+
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ Param (
+ [Parameter(Mandatory = $true)]
+ [Int]$Id,
+ [Parameter(Mandatory = $true)]
+ [Bool]$Archive
+ )
+
+ if ($Archive) {
+ $Action = 'archive'
+ } else {
+ $Action = 'unarchive'
+ }
+
+ if ($PSCmdlet.ShouldProcess($Id)) {
+ Invoke-HuduRequest -Method put -Resource "/api/v1/articles/$Id/$Action"
+ }
+}
+#EndRegion './Public/Set-HuduArticleArchive.ps1' 37
+#Region './Public/Set-HuduAsset.ps1' -1
+
+function Set-HuduAsset {
+ <#
+ .SYNOPSIS
+ Update an Asset
+
+ .DESCRIPTION
+ Uses Hudu API to update an Asset
+
+ .PARAMETER Name
+ Name of the Asset
+
+ .PARAMETER CompanyId
+ Company id of the Asset
+
+ .PARAMETER AssetLayoutId
+ Asset layout id
+
+ .PARAMETER Fields
+ List of fields
+
+ .PARAMETER AssetId
+ Id of the requested Asset
+
+ .PARAMETER PrimarySerial
+ Primary serial number
+
+ .PARAMETER PrimaryMail
+ Primary mail
+
+ .PARAMETER PrimaryModel
+ Primary model
+
+ .PARAMETER PrimaryManufacturer
+ Primary manufacturer
+
+ .PARAMETER Slug
+ Url identifier
+
+ .EXAMPLE
+ Set-HuduAsset -AssetId 1 -CompanyId 1 -Fields @(@{'field_name'='Field Value'})
+
+ .NOTES
+ General notes
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ Param (
+ [String]$Name,
+
+ [Alias('company_id')]
+ [Int]$CompanyId,
+
+ [Alias('asset_layout_id')]
+ [Int]$AssetLayoutId,
+
+ [Array]$Fields,
+
+ [Alias('asset_id','assetid')]
+ [Parameter(Mandatory = $true)]
+ [ValidateRange(1, [int]::MaxValue)]
+ [Int]$Id,
+
+ [Alias('primary_serial')]
+ [string]$PrimarySerial,
+
+ [Alias('primary_mail')]
+ [string]$PrimaryMail,
+
+ [Alias('primary_model')]
+ [string]$PrimaryModel,
+
+ [Alias('primary_manufacturer')]
+ [string]$PrimaryManufacturer,
+
+ [string]$Slug
+ )
+
+ $Object = Get-HuduAssets -id $Id | Select-Object name,asset_layout_id,company_id,slug,primary_serial,primary_model,primary_mail,id,primary_manufacturer,@{n='custom_fields';e={$_.fields | ForEach-Object {[pscustomobject]@{$_.label.replace(' ','_').tolower()= $_.value}}}}
+ if ($Object) {
+ $Asset = [ordered]@{asset = $Object }
+ $CompanyId = $Object.company_id
+
+ if ($Name) {
+ $Asset.asset.name = $Name
+ }
+
+ if ($AssetLayoutId) {
+ $Asset.asset.asset_layout_id = $AssetLayoutId
+ }
+
+ if ($PrimarySerial) {
+ $Asset.asset.primary_serial = $PrimarySerial
+ }
+
+ if ($PrimaryMail) {
+ $Asset.asset.primary_mail = $PrimaryMail
+ }
+
+ if ($PrimaryModel) {
+ $Asset.asset.primary_model = $PrimaryModel
+ }
+
+ if ($PrimaryManufacturer) {
+ $Asset.asset.primary_manufacturer = $PrimaryManufacturer
+ }
+
+ if ($Fields) {
+ $Asset.asset.custom_fields = $Fields
+ }
+
+ if ($Slug) {
+ $Asset.asset.slug = $Slug
+ }
+
+ $JSON = $Asset | ConvertTo-Json -Depth 10
+
+ if ($PSCmdlet.ShouldProcess("ID: $($Asset.id) Name: $($Asset.Name)", "Set Hudu Asset")) {
+ Invoke-HuduRequest -Method put -Resource "/api/v1/companies/$CompanyId/assets/$Id" -Body $JSON
+ }
+ } else {
+ throw "A valid asset could not be found to update, please double check the ID and try again"
+ }
+}
+#EndRegion './Public/Set-HuduAsset.ps1' 123
+#Region './Public/Set-HuduAssetArchive.ps1' -1
+
+function Set-HuduAssetArchive {
+ <#
+ .SYNOPSIS
+ Archive/Unarchive an Asset
+
+ .DESCRIPTION
+ Uses Hudu API to archive or unarchive an asset
+
+ .PARAMETER Id
+ Id of the requested Asset
+
+ .PARAMETER CompanyId
+ Id of the requested parent company
+
+ .PARAMETER Archive
+ Boolean for archive status
+
+ .EXAMPLE
+ Set-HuduAssetArchive -Id 1 -CompanyId 1 -Archive $true
+
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ Param (
+ [Parameter(Mandatory = $true)]
+ [Int]$Id,
+ [Alias('company_id')]
+ [Parameter(Mandatory = $true)]
+ [Int]$CompanyId,
+ [Parameter(Mandatory = $true)]
+ [Bool]$Archive
+ )
+
+ if ($Archive) {
+ $Action = 'archive'
+ } else {
+ $Action = 'unarchive'
+ }
+
+ if ($PSCmdlet.ShouldProcess($Id)) {
+ Invoke-HuduRequest -Method put -Resource "/api/v1/companies/$CompanyId/assets/$Id/$Action"
+ }
+}
+#EndRegion './Public/Set-HuduAssetArchive.ps1' 43
+#Region './Public/Set-HuduAssetLayout.ps1' -1
+
+function Set-HuduAssetLayout {
+ <#
+ .SYNOPSIS
+ Update an Asset Layout
+
+ .DESCRIPTION
+ Uses Hudu API to update an Asset Layout
+
+ .PARAMETER Id
+ Id of the requested Asset Layout
+
+ .PARAMETER Name
+ Name of the Asset Layout
+
+ .PARAMETER Icon
+ Icon class name, example: "fas fa-home"
+
+ .PARAMETER Color
+ Hex code for background color, example: #000000
+
+ .PARAMETER IconColor
+ Hex code for background color, example: #000000
+
+ .PARAMETER IncludePasswords
+ Boolean to include passwords
+
+ .PARAMETER IncludePhotos
+ Boolean to include photos
+
+ .PARAMETER IncludeComments
+ Boolean to include comments
+
+ .PARAMETER IncludeFiles
+ Boolean to include files
+
+ .PARAMETER PasswordTypes
+ List of password types, separated with new line characters
+
+ .PARAMETER Slug
+ Url identifier
+
+ .PARAMETER Fields
+ Array of hashtable or custom objects representing layout fields. Most field types only require a label and type.
+ Valid field types are: Text, RichText, Heading, CheckBox, Website (aka Link), Password (aka ConfidentialText), Number, Date, DropDown, Embed, Email (aka CopyableText), Phone, AssetLink
+ Field types are Case Sensitive as of Hudu V2.27 due to a known issue with asset type validation.
+
+ .EXAMPLE
+ Set-HuduAssetLayout -Id 12 -Name 'Test asset layout' -Icon 'fas fa-home' -IncludePassword $true
+
+ .EXAMPLE
+ Set-HuduAssetLayout -Id 12 -Fields @(
+ @{label = 'Test field'; 'field_type' = 'Text'}
+ )
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ # This will silence the warning for variables with Password in their name.
+ [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingPlainTextForPassword', '')]
+ Param (
+ [Parameter(Mandatory = $true)]
+ [Int]$Id,
+
+ [String]$Name,
+
+ [String]$Icon,
+
+ [String]$Color,
+
+ [Alias('icon_color')]
+ [String]$IconColor,
+
+ [Alias('include_passwords')]
+ [bool]$IncludePasswords,
+
+ [Alias('include_photos')]
+ [bool]$IncludePhotos,
+
+ [Alias('include_comments')]
+ [bool]$IncludeComments,
+
+ [Alias('include_files')]
+ [bool]$IncludeFiles,
+
+ [Alias('password_types')]
+ [String]$PasswordTypes = '',
+
+ [bool]$Active,
+
+ [string]$Slug,
+
+ [array]$Fields
+ )
+
+ foreach ($Field in $Fields) {
+ $Field.show_in_list = [System.Convert]::ToBoolean($Field.show_in_list)
+ $Field.required = [System.Convert]::ToBoolean($Field.required)
+ $Field.expiration = [System.Convert]::ToBoolean($Field.expiration)
+ # A bug in versions of Hudu 2.27 and earlier can cause asset layouts to become corrupted if the field type value is not properly cased.
+ switch ($field.'field_type') {
+ 'text' { $field.'field_type' = 'Text' }
+ 'richtext' { $field.'field_type' = 'RichText' }
+ 'heading' { $field.'field_type' = 'Heading' }
+ 'checkbox' { $field.'field_type' = 'CheckBox' }
+ 'number' { $field.'field_type' = 'Number' }
+ 'date' { $field.'field_type' = 'Date' }
+ 'dropdown' { $field.'field_type' = 'Dropdown' }
+ 'embed' { $field.'field_type' = 'Embed' }
+ 'phone' { $field.'field_type' = 'Phone' }
+ ('email' -or 'copyabletext') { $field.'field_type' = 'Email' }
+ ('assettag' -or 'assetlink') { $field.'field_type' = 'AssetTag' }
+ ('website' -or 'link') { $field.'field_type' = 'Website' }
+ ('password' -or 'confidentialtext') { $field.'field_type' = 'Password' }
+ Default { Write-Error "Invalid field type: $($field.'field_type') found in field $($field.name)"; break }
+ }
+ }
+ $Object = Get-HuduAssetLayouts -id $Id
+
+ $AssetLayout = [ordered]@{asset_layout = $Object }
+ #$AssetLayout.asset_layout = $Object
+
+ if ($Name) {
+ $AssetLayout.asset_layout.name = $Name
+ }
+
+ if ($Icon) {
+ $AssetLayout.asset_layout.icon = $Icon
+ }
+
+ if ($Color) {
+ $AssetLayout.asset_layout.color = $Color
+ }
+
+ if ($IconColor) {
+ $AssetLayout.asset_layout.icon_color = $IconColor
+ }
+
+ if ($Fields) {
+ $AssetLayout.asset_layout.fields = $Fields
+ }
+
+ if ($IncludePasswords) {
+ $AssetLayout.asset_layout.include_passwords = [System.Convert]::ToBoolean($IncludePasswords)
+ }
+
+ if ($IncludePhotos) {
+ $AssetLayout.asset_layout.include_photos = [System.Convert]::ToBoolean($IncludePhotos)
+ }
+
+ if ($IncludeComments) {
+ $AssetLayout.asset_layout.include_comments = [System.Convert]::ToBoolean($IncludeComments)
+ }
+
+ if ($IncludeFiles) {
+ $AssetLayout.asset_layout.include_files = [System.Convert]::ToBoolean($IncludeFiles)
+ }
+
+ if ($PasswordTypes) {
+ $AssetLayout.asset_layout.password_types = $PasswordTypes
+ }
+
+ if ($SidebarFolderID) {
+ $AssetLayout.asset_layout.sidebar_folder_id = $SidebarFolderID
+ }
+
+ if ($Slug) {
+ $AssetLayout.asset_layout.slug = $Slug
+ }
+
+ if ($Active) {
+ $AssetLayout.asset_layout.active = [System.Convert]::ToBoolean($Active)
+ }
+
+ $JSON = $AssetLayout | ConvertTo-Json -Depth 10
+
+ if ($PSCmdlet.ShouldProcess($Id)) {
+ Invoke-HuduRequest -Method put -Resource "/api/v1/asset_layouts/$Id" -Body $JSON
+ }
+}
+#EndRegion './Public/Set-HuduAssetLayout.ps1' 178
+#Region './Public/Set-HuduCompany.ps1' -1
+
+function Set-HuduCompany {
+ <#
+ .SYNOPSIS
+ Update a company
+
+ .DESCRIPTION
+ Uses Hudu API to update a Company
+
+ .PARAMETER Id
+ Id of the requested company
+
+ .PARAMETER Name
+ Name of the company
+
+ .PARAMETER Nickname
+ Nickname of the company
+
+ .PARAMETER CompanyType
+ Company type
+
+ .PARAMETER AddressLine1
+ Address line 1
+
+ .PARAMETER AddressLine2
+ Address line 2
+
+ .PARAMETER City
+ City
+
+ .PARAMETER State
+ State
+
+ .PARAMETER Zip
+ Zip
+
+ .PARAMETER CountryName
+ Country name
+
+ .PARAMETER PhoneNumber
+ Phone number
+
+ .PARAMETER FaxNumber
+ Fax number
+
+ .PARAMETER Website
+ Webste
+
+ .PARAMETER IdNumber
+ Id number
+
+ .PARAMETER ParentCompanyId
+ Parent company id
+
+ .PARAMETER Notes
+ Company notes
+
+ .PARAMETER Slug
+ Url identifier
+
+ .EXAMPLE
+ Set-HuduCompany -Id 1 -Name 'New company name'
+
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ Param (
+ [Parameter(Mandatory = $true)]
+ [Int]$Id,
+
+ [String]$Name,
+
+ [String]$Nickname = '',
+
+ [Alias('company_type')]
+ [String]$CompanyType = '',
+
+ [Alias('address_line_1')]
+ [String]$AddressLine1 = '',
+
+ [Alias('address_line_2')]
+ [String]$AddressLine2 = '',
+
+ [String]$City = '',
+
+ [String]$State = '',
+
+ [Alias('PostalCode', 'PostCode')]
+ [String]$Zip = '',
+
+ [Alias('country_name')]
+ [String]$CountryName = '',
+
+ [Alias('phone_number')]
+ [String]$PhoneNumber = '',
+
+ [Alias('fax_number')]
+ [String]$FaxNumber = '',
+
+ [String]$Website = '',
+
+ [Alias('id_number')]
+ [String]$IdNumber = '',
+
+ [Alias('parent_company_id')]
+ [Int]$ParentCompanyId,
+
+ [String]$Notes = '',
+
+ [string]$Slug
+ )
+
+ $Object = Get-HuduCompanies -Id $Id
+
+ $Company = [ordered]@{company = $Object }
+
+ if ($Name) {
+ $Company.company.name = $Name
+ }
+
+ if ($Nickname) {
+ $Company.company.nickname = $Nickname
+ }
+
+ if ($CompanyType) {
+ $Company.company.company_type = $CompanyType
+ }
+
+ if ($AddressLine1) {
+ $Company.company.address_line_1 = $AddressLine1
+ }
+
+ if ($AddressLine2) {
+ $Company.company.address_line_2 = $AddressLine2
+ }
+
+ if ($City) {
+ $Company.company.city = $City
+ }
+
+ if ($State) {
+ $Company.company.state = $State
+ }
+
+ if ($Zip) {
+ $Company.company.zip = $Zip
+ }
+
+ if ($CountryName) {
+ $Company.company.country_name = $CountryName
+ }
+
+ if ($PhoneNumber) {
+ $Company.company.phone_number = $PhoneNumber
+ }
+
+ if ($FaxNumber) {
+ $Company.company.fax_number = $FaxNumber
+ }
+
+ if ($Website) {
+ $Company.company.website = $Website
+ }
+
+ if ($IdNumber) {
+ $Company.company.id_number = $IdNumber
+ }
+
+ if ($ParentCompanyId) {
+ $Company.company.parent_company_id = $ParentCompanyId
+ }
+
+ if ($Notes) {
+ $Company.company.notes = $Notes
+ }
+
+ if ($Slug) {
+ $Company.company.slug = $Slug
+ }
+
+ $JSON = $Company | ConvertTo-Json -Depth 10
+
+ if ($PSCmdlet.ShouldProcess($Id)) {
+ Invoke-HuduRequest -Method put -Resource "/api/v1/companies/$Id" -Body $JSON
+ }
+}
+#EndRegion './Public/Set-HuduCompany.ps1' 185
+#Region './Public/Set-HuduCompanyArchive.ps1' -1
+
+function Set-HuduCompanyArchive {
+ <#
+ .SYNOPSIS
+ Archive/Unarchive a company
+
+ .DESCRIPTION
+ Uses Hudu API to set archive status on a company
+
+ .PARAMETER Id
+ Id of the requested company
+
+ .PARAMETER Archive
+ Boolean for archive status
+
+ .EXAMPLE
+ Set-HuduCompanyArchive -Id 1 -Archive $true
+
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ Param (
+ [Parameter(Mandatory = $true)]
+ [Int]$Id,
+ [Parameter(Mandatory = $true)]
+ [Bool]$Archive
+ )
+
+ if ($Archive -eq $true) {
+ $Action = 'archive'
+ } else {
+ $Action = 'unarchive'
+ }
+ if ($PSCmdlet.ShouldProcess($Id)) {
+ Invoke-HuduRequest -Method put -Resource "/api/v1/companies/$Id/$Action"
+ }
+}
+#EndRegion './Public/Set-HuduCompanyArchive.ps1' 36
+#Region './Public/Set-HuduFolder.ps1' -1
+
+function Set-HuduFolder {
+ <#
+ .SYNOPSIS
+ Update a Folder
+
+ .DESCRIPTION
+ Uses Hudu API to update a folder
+
+ .PARAMETER Id
+ Id of the requested folder
+
+ .PARAMETER Name
+ Name of the folder
+
+ .PARAMETER Icon
+ Folder icon
+
+ .PARAMETER Description
+ Folder description
+
+ .PARAMETER ParentFolderId
+ Folder parent id
+
+ .PARAMETER CompanyId
+ Folder company id
+
+ .EXAMPLE
+ Set-HuduFolder -Id 1 -Name 'New folder name'
+
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ Param (
+ [Parameter(Mandatory = $true)]
+ [Int]$Id,
+
+ [Parameter(Mandatory = $true)]
+ [String]$Name,
+
+ [String]$Icon = '',
+
+ [String]$Description = '',
+
+ [Alias('parent_folder_id')]
+ [Int]$ParentFolderId = '',
+
+ [Alias('company_id')]
+ [Int]$CompanyId = ''
+ )
+
+ $Folder = [ordered]@{folder = [ordered]@{} }
+
+ $Folder.folder.add('name', $Name)
+
+ if ($icon) {
+ $Folder.folder.add('icon', $Icon)
+ }
+
+ if ($Description) {
+ $Folder.folder.add('description', $Description)
+ }
+
+ if ($ParentFolderId) {
+ $Folder.folder.add('parent_folder_id', $ParentFolderId)
+ }
+
+ if ($CompanyId) {
+ $Folder.folder.add('company_id', $CompanyId)
+ }
+
+ $JSON = $Folder | ConvertTo-Json
+
+ if ($PSCmdlet.ShouldProcess($Id)) {
+ Invoke-HuduRequest -Method put -Resource "/api/v1/folders/$Id" -Body $JSON
+ }
+}
+#EndRegion './Public/Set-HuduFolder.ps1' 76
+#Region './Public/Set-HuduIntegrationMatcher.ps1' -1
+
+function Set-HuduIntegrationMatcher {
+ <#
+ .SYNOPSIS
+ Update a Matcher
+
+ .DESCRIPTION
+ Uses Hudu API to set integration matchers
+
+ .PARAMETER Id
+ Id of the requested matcher
+
+ .PARAMETER AcceptSuggestedMatch
+ Set the Sync Id/Identifier to the suggested one
+
+ .PARAMETER CompanyId
+ Requested company id to match
+
+ .PARAMETER PotentialCompanyId
+ Potential company id to match
+
+ .PARAMETER SyncId
+ Sync id to match
+
+ .PARAMETER Identifier
+ Identifier to match
+
+ .EXAMPLE
+ Set-HuduIntegrationMatcher -Id 1 -AcceptSuggestedMatch
+
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ Param (
+ [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)]
+ [String]$Id,
+
+ [Parameter(ParameterSetName = 'AcceptSuggestedMatch')]
+ [switch]$AcceptSuggestedMatch,
+
+ [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'SetCompanyId')]
+ [Alias('company_id')]
+ [String]$CompanyId,
+
+ [Parameter(ValueFromPipelineByPropertyName = $true)]
+ [Alias('potential_company_id')]
+ [String]$PotentialCompanyId,
+
+ [Parameter(ValueFromPipelineByPropertyName = $true)]
+ [Alias('sync_id')]
+ [String]$SyncId,
+
+ [Parameter(ValueFromPipelineByPropertyName = $true)]
+ [String]$Identifier
+ )
+
+ process {
+ $Matcher = [ordered]@{matcher = [ordered]@{} }
+
+ if ($AcceptSuggestedMatch) {
+ $Matcher.matcher.add('company_id', $PotentialCompanyId) | Out-Null
+ } else {
+ $Matcher.matcher.add('company_id', $CompanyId) | Out-Null
+ }
+
+ if ($PotentialCompanyId) {
+ $Matcher.matcher.add('potential_company_id', $PotentialCompanyId) | Out-Null
+ }
+ if ($SyncId) {
+ $Matcher.matcher.add('sync_id', $SyncId) | Out-Null
+ }
+ if ($Identifier) {
+ $Matcher.matcher.add('identifier', $identifier) | Out-Null
+ }
+
+ $JSON = $Matcher | ConvertTo-Json -Depth 10
+
+ if ($PSCmdlet.ShouldProcess($Id)) {
+ Invoke-HuduRequest -Method put -Resource "/api/v1/matchers/$Id" -Body $JSON
+ }
+ }
+}
+#EndRegion './Public/Set-HuduIntegrationMatcher.ps1' 81
+#Region './Public/Set-HuduMagicDash.ps1' -1
+
+function Set-HuduMagicDash {
+ <#
+ .SYNOPSIS
+ Create or Update a Magic Dash Item
+
+ .DESCRIPTION
+ Magic Dash takes just simple key-pairs. Whether you want to add a new Magic Dash Item, or update one, you can use the same endpoint, so it is really easy! It uses the title, and company_name to match.
+
+ .PARAMETER Title
+ This is the title. If there is an existing Magic Dash Item with matching title and company_name, then it will match into that item.
+
+ .PARAMETER CompanyName
+ This is the attribute we use to match to an existing company. If there is an existing Magic Dash Item with matching title and company_name, then it will match into that item.
+
+ .PARAMETER Message
+ This will be the first content that will be displayed on the Magic Dash Item.
+
+ .PARAMETER Icon
+ Either fill this in, or image_url. Use a (FontAwesome icon for the header of a Magic Dash Item. Must be in the format of fas fa-circle
+
+ .PARAMETER ImageURL
+ Either fill this in, or icon. Used in the header of a Magic Dash Item.
+
+ .PARAMETER ContentLink
+ Either fill this in, or content, or leave both blank. Used to have a link to an external website.
+
+ .PARAMETER Content
+ Either fill this in, or content_link, or leave both blank. Fill in with HTML (tables, images, videos, etc.) to display more content in your Magic Dash Item.
+
+ .PARAMETER Shade
+ Use a different color for your Magic Dash Item for different contextual states. Options are to leave it blank, success, or danger
+
+ .EXAMPLE
+ Set-HuduMagicDash -Title 'Test Dash' -CompanyName 'Test Company' -Message 'This will be displayed first'
+
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ Param (
+ [Parameter(Mandatory = $true)]
+ [String]$Title,
+
+ [Alias('company_name')]
+ [Parameter(Mandatory = $true)]
+ [String]$CompanyName,
+
+ [Parameter(Mandatory = $true)]
+ [String]$Message,
+
+ [String]$Icon = '',
+
+ [Alias('image_url')]
+ [String]$ImageURL = '',
+
+ [Alias('content_link')]
+ [String]$ContentLink = '',
+
+ [String]$Content = '',
+
+ [String]$Shade = ''
+ )
+
+ if ($Icon -and $ImageURL) {
+ Write-Error ('You can only use one of icon or image URL')
+ exit 1
+ }
+
+ if ($content_link -and $content) {
+ Write-Error ('You can only use one of content or content_link')
+ exit 1
+ }
+
+ $MagicDash = [ordered]@{}
+
+ if ($Title) {
+ $MagicDash.add('title', $Title)
+ }
+
+ if ($CompanyName) {
+ $MagicDash.add('company_name', $CompanyName)
+ }
+
+ if ($Message) {
+ $MagicDash.add('message', $Message)
+ }
+
+ if ($Icon) {
+ $MagicDash.add('icon', $Icon)
+ }
+
+ if ($ImageURL) {
+ $MagicDash.add('image_url', $ImageURL)
+ }
+
+ if ($ContentLink) {
+ $MagicDash.add('content_link', $ContentLink)
+ }
+
+ if ($Content) {
+ $MagicDash.add('content', $Content)
+ }
+
+ if ($Shade) {
+ $MagicDash.add('shade', $Shade)
+ }
+
+ $JSON = $MagicDash | ConvertTo-Json
+
+ if ($PSCmdlet.ShouldProcess("$Companyname - $Title")) {
+ Invoke-HuduRequest -Method post -Resource '/api/v1/magic_dash' -Body $JSON
+ }
+}
+#EndRegion './Public/Set-HuduMagicDash.ps1' 112
+#Region './Public/Set-HuduPassword.ps1' -1
+
+function Set-HuduPassword {
+ <#
+ .SYNOPSIS
+ Update a Password
+
+ .DESCRIPTION
+ Uses Hudu API to update a password
+
+ .PARAMETER Id
+ Id of the requested Password
+
+ .PARAMETER Name
+ Password name
+
+ .PARAMETER CompanyId
+ Id of requested company
+
+ .PARAMETER PasswordableType
+ Type of asset to associate with the password
+
+ .PARAMETER PasswordableId
+ Id of the asset to associate with the password
+
+ .PARAMETER InPortal
+ Display password in portal
+
+ .PARAMETER Password
+ Password
+
+ .PARAMETER OTPSecret
+ OTP secret
+
+ .PARAMETER URL
+ Url for the password
+
+ .PARAMETER Username
+ Username
+
+ .PARAMETER Description
+ Password description
+
+ .PARAMETER PasswordType
+ Password type
+
+ .PARAMETER PasswordFolderId
+ Id of requested password folder
+
+ .PARAMETER Slug
+ Url identifier
+
+ .EXAMPLE
+ Set-HuduPassword -Id 1 -CompanyId 1 -Password 'this_is_my_new_password'
+
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ # This will silence the warning for variables with Password in their name.
+ [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingPlainTextForPassword', '')]
+ [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingUsernameAndPasswordParams', '')]
+ Param (
+ [Parameter(Mandatory = $true)]
+ [Int]$Id,
+
+ [String]$Name,
+
+ [Alias('company_id')]
+ [Int]$CompanyId,
+
+ [Alias('passwordable_type')]
+ [String]$PasswordableType = '',
+
+ [Alias('passwordable_id')]
+ [int]$PasswordableId = '',
+
+ [Alias('in_portal')]
+ [Bool]$InPortal = $false,
+ [String]$Password = '',
+
+ [Alias('otp_secret')]
+ [string]$OTPSecret = '',
+
+ [String]$URL = '',
+
+ [String]$Username = '',
+
+ [String]$Description = '',
+
+ [Alias('password_type')]
+ [String]$PasswordType = '',
+
+ [Alias('password_folder_id')]
+ [int]$PasswordFolderId,
+
+ [string]$Slug
+ )
+
+ $Object = Get-HuduPasswords -Id $Id
+ $AssetPassword = [ordered]@{asset_password = $Object }
+
+ if ($Name) {
+ $AssetPassword.asset_password | Add-Member -MemberType NoteProperty -Name name -Force -Value $Name
+
+ }
+
+ if ($CompanyId) {
+ $AssetPassword.asset_password | Add-Member -MemberType NoteProperty -Name company_id -Force -Value $CompanyId
+ }
+
+ if ($Password) {
+ $AssetPassword.asset_password | Add-Member -MemberType NoteProperty -Name password -Force -Value $Password
+ }
+
+ if ($InPortal) {
+ $AssetPassword.asset_password | Add-Member -MemberType NoteProperty -Name in_portal -Force -Value $InPortal
+ }
+
+
+ if ($PasswordableType) {
+ $AssetPassword.asset_password | Add-Member -MemberType NoteProperty -Name passwordable_type -Force -Value $PasswordableType
+ }
+ if ($PasswordableId) {
+ $AssetPassword.asset_password | Add-Member -MemberType NoteProperty -Name passwordable_id -Force -Value $PasswordableId
+ }
+
+ if ($OTPSecret) {
+ $AssetPassword.asset_password | Add-Member -MemberType NoteProperty -Name otp_secret -Force -Value $OTPSecret
+ }
+
+ if ($URL) {
+ $AssetPassword.asset_password | Add-Member -MemberType NoteProperty -Name url -Force -Value $URL
+ }
+
+ if ($Username) {
+ $AssetPassword.asset_password | Add-Member -MemberType NoteProperty -Name username -Force -Value $Username
+ }
+
+ if ($Description) {
+ $AssetPassword.asset_password | Add-Member -MemberType NoteProperty -Name description -Force -Value $Description
+ }
+
+ if ($PasswordType) {
+ $AssetPassword.asset_password | Add-Member -MemberType NoteProperty -Name password_type -Force -Value $PasswordType
+ }
+
+ if ($PasswordFolderId) {
+ $AssetPassword.asset_password | Add-Member -MemberType NoteProperty -Name password_folder_id -Force -Value $PasswordFolderId
+ }
+
+ if ($Slug) {
+ $AssetPassword.asset_password | Add-Member -MemberType NoteProperty -Name slug -Force -Value $Slug
+ }
+
+ $JSON = $AssetPassword | ConvertTo-Json -Depth 10
+
+ if ($PSCmdlet.ShouldProcess($Id)) {
+ Invoke-HuduRequest -Method put -Resource "/api/v1/asset_passwords/$Id" -Body $JSON
+ }
+}
+#EndRegion './Public/Set-HuduPassword.ps1' 158
+#Region './Public/Set-HuduPasswordArchive.ps1' -1
+
+function Set-HuduPasswordArchive {
+ <#
+ .SYNOPSIS
+ Archive/Unarchive a Password
+
+ .DESCRIPTION
+ Uses Hudu API to archive or unarchive a password
+
+ .PARAMETER Id
+ Id of the requested Password
+
+ .PARAMETER Archive
+ Boolean of archive status
+
+ .EXAMPLE
+ Set-HuduPasswordArchive -Archive $true -Id 1
+
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ Param (
+ [Parameter(ValueFromPipelineByPropertyName = $true, Mandatory = $true)]
+ [Int]$Id,
+ [Parameter(Mandatory = $true)]
+ [Bool]$Archive
+ )
+
+ process {
+ if ($Archive) {
+ $Action = 'archive'
+ } else {
+ $Action = 'unarchive'
+ }
+
+ if ($PSCmdlet.ShouldProcess($Id)) {
+ Invoke-HuduRequest -Method put -Resource "/api/v1/asset_passwords/$Id/$Action"
+ }
+ }
+}
+#EndRegion './Public/Set-HuduPasswordArchive.ps1' 39
+#Region './Public/Set-HuduWebsite.ps1' -1
+
+function Set-HuduWebsite {
+ <#
+ .SYNOPSIS
+ Update a Website
+
+ .DESCRIPTION
+ Uses Hudu API to update a website
+
+ .PARAMETER Id
+ Id of requested website
+
+ .PARAMETER Name
+ Website name (e.g. https://example.com)
+
+ .PARAMETER Notes
+ Website Notes
+
+ .PARAMETER Paused
+ When true, website monitoring is paused.
+
+ .PARAMETER CompanyId
+ Used to associate website with company
+
+ .PARAMETER DisableDNS
+ When true, dns monitoring is paused.
+
+ .PARAMETER DisableSSL
+ When true, ssl cert monitoring is paused.
+
+ .PARAMETER DisableWhois
+ When true, whois monitoring is paused.
+
+ .PARAMETER Slug
+ Url identifier
+
+ .EXAMPLE
+ Set-HuduWebsite -Id 1 -Paused $true
+
+ #>
+ [CmdletBinding(SupportsShouldProcess)]
+ Param (
+ [Parameter(Mandatory = $true)]
+ [Int]$Id,
+
+ [Parameter(Mandatory = $true)]
+ [String]$Name,
+
+ [String]$Notes = '',
+
+ [String]$Paused = '',
+
+ [Alias('company_id')]
+ [Parameter(Mandatory = $true)]
+ [Int]$CompanyId,
+
+ [Alias('disable_dns')]
+ [String]$DisableDNS = '',
+
+ [Alias('disable_ssl')]
+ [String]$DisableSSL = '',
+
+ [Alias('disable_whois')]
+ [String]$DisableWhois = '',
+
+ [string]$Slug
+ )
+
+ $Website = [ordered]@{website = [ordered]@{} }
+
+ $Website.website.add('name', $Name)
+
+ if ($Notes) {
+ $Website.website.add('notes', $Notes)
+ }
+
+ if ($Paused) {
+ $Website.website.add('paused', $Paused)
+ }
+
+ $Website.website.add('company_id', $companyid)
+
+ if ($DisableDNS) {
+ $Website.website.add('disable_dns', $DisableDNS)
+ }
+
+ if ($DisableSSL) {
+ $Website.website.add('disable_ssl', $DisableSSL)
+ }
+
+ if ($DisableWhois) {
+ $Website.website.add('disable_whois', $DisableWhois)
+ }
+
+ if ($Slug) {
+ $Website.website.add('slug', $Slug)
+ }
+
+ $JSON = $Website | ConvertTo-Json
+
+ if ($PSCmdlet.ShouldProcess($Id)) {
+ Invoke-HuduRequest -Method put -Resource "/api/v1/websites/$Id" -Body $JSON
+ }
+}
+#EndRegion './Public/Set-HuduWebsite.ps1' 104
diff --git a/Modules/HuduAPI/2.4.9/PSGetModuleInfo.xml b/Modules/HuduAPI/2.4.9/PSGetModuleInfo.xml
new file mode 100644
index 000000000000..bc673458843c
--- /dev/null
+++ b/Modules/HuduAPI/2.4.9/PSGetModuleInfo.xml
@@ -0,0 +1,248 @@
+
+
+
+ Microsoft.PowerShell.Commands.PSRepositoryItemInfo
+ System.Management.Automation.PSCustomObject
+ System.Object
+
+
+ HuduAPI
+ 2.4.9
+ Module
+ This module provides an interface to the Hudu Rest API further information can be found at https://github.com/lwhitelock/HuduAPI
+ Luke Whitelock
+
+
+ System.Object[]
+ System.Array
+ System.Object
+
+
+ mspp
+ homotechsual
+ johnduprey
+
+
+ (c) 2021 Luke Whitelock. All rights reserved.
+ 2024-06-30T03:42:36-04:00
+
+
+
+
+
+
+
+
+ PSModule
+
+
+
+
+ System.Collections.Hashtable
+ System.Object
+
+
+
+ RoleCapability
+
+
+
+
+
+
+ DscResource
+ Function
+
+
+
+ Get-HuduActivityLogs
+ Get-HuduApiKey
+ Get-HuduAppInfo
+ Get-HuduArticles
+ Get-HuduAssetLayoutFieldID
+ Get-HuduAssetLayouts
+ Get-HuduAssets
+ Get-HuduBaseURL
+ Get-HuduCard
+ Get-HuduCompanies
+ Get-HuduExpirations
+ Get-HuduFolderMap
+ Get-HuduFolders
+ Get-HuduIntegrationMatchers
+ Get-HuduMagicDashes
+ Get-HuduObjectByUrl
+ Get-HuduPasswordFolders
+ Get-HuduPasswords
+ Get-HuduProcesses
+ Get-HuduPublicPhotos
+ Get-HuduRelations
+ Get-HuduUploads
+ Get-HuduWebsites
+ Initialize-HuduFolder
+ Move-HuduAssetsToNewLayout
+ New-HuduAPIKey
+ New-HuduArticle
+ New-HuduAsset
+ New-HuduAssetLayout
+ New-HuduBaseURL
+ New-HuduCompany
+ New-HuduCustomHeaders
+ New-HuduFolder
+ New-HuduPassword
+ New-HuduPublicPhoto
+ New-HuduRelation
+ New-HuduUpload
+ New-HuduWebsite
+ Remove-HuduAPIKey
+ Remove-HuduArticle
+ Remove-HuduAsset
+ Remove-HuduBaseURL
+ Remove-HuduCompany
+ Remove-HuduCustomHeaders
+ Remove-HuduMagicDash
+ Remove-HuduPassword
+ Remove-HuduRelation
+ Remove-HuduUpload
+ Remove-HuduWebsite
+ Set-HuduArticle
+ Set-HuduArticleArchive
+ Set-HuduAsset
+ Set-HuduAssetArchive
+ Set-HuduAssetLayout
+ Set-HuduCompany
+ Set-HuduCompanyArchive
+ Set-HuduFolder
+ Set-HuduIntegrationMatcher
+ Set-HuduMagicDash
+ Set-HuduPassword
+ Set-HuduPasswordArchive
+ Set-HuduWebsite
+
+
+
+
+ Cmdlet
+ Command
+
+
+
+ Get-HuduActivityLogs
+ Get-HuduApiKey
+ Get-HuduAppInfo
+ Get-HuduArticles
+ Get-HuduAssetLayoutFieldID
+ Get-HuduAssetLayouts
+ Get-HuduAssets
+ Get-HuduBaseURL
+ Get-HuduCard
+ Get-HuduCompanies
+ Get-HuduExpirations
+ Get-HuduFolderMap
+ Get-HuduFolders
+ Get-HuduIntegrationMatchers
+ Get-HuduMagicDashes
+ Get-HuduObjectByUrl
+ Get-HuduPasswordFolders
+ Get-HuduPasswords
+ Get-HuduProcesses
+ Get-HuduPublicPhotos
+ Get-HuduRelations
+ Get-HuduUploads
+ Get-HuduWebsites
+ Initialize-HuduFolder
+ Move-HuduAssetsToNewLayout
+ New-HuduAPIKey
+ New-HuduArticle
+ New-HuduAsset
+ New-HuduAssetLayout
+ New-HuduBaseURL
+ New-HuduCompany
+ New-HuduCustomHeaders
+ New-HuduFolder
+ New-HuduPassword
+ New-HuduPublicPhoto
+ New-HuduRelation
+ New-HuduUpload
+ New-HuduWebsite
+ Remove-HuduAPIKey
+ Remove-HuduArticle
+ Remove-HuduAsset
+ Remove-HuduBaseURL
+ Remove-HuduCompany
+ Remove-HuduCustomHeaders
+ Remove-HuduMagicDash
+ Remove-HuduPassword
+ Remove-HuduRelation
+ Remove-HuduUpload
+ Remove-HuduWebsite
+ Set-HuduArticle
+ Set-HuduArticleArchive
+ Set-HuduAsset
+ Set-HuduAssetArchive
+ Set-HuduAssetLayout
+ Set-HuduCompany
+ Set-HuduCompanyArchive
+ Set-HuduFolder
+ Set-HuduIntegrationMatcher
+ Set-HuduMagicDash
+ Set-HuduPassword
+ Set-HuduPasswordArchive
+ Set-HuduWebsite
+
+
+
+
+ Workflow
+ https://www.powershellgallery.com/api/v2
+ PSGallery
+ NuGet
+
+
+ System.Management.Automation.PSCustomObject
+ System.Object
+
+
+ (c) 2021 Luke Whitelock. All rights reserved.
+ This module provides an interface to the Hudu Rest API further information can be found at https://github.com/lwhitelock/HuduAPI
+ False
+ True
+ True
+ 2653
+ 1260331
+ 24052
+ 6/30/2024 3:42:36 AM -04:00
+ 6/30/2024 3:42:36 AM -04:00
+ 7/1/2024 8:11:32 PM -04:00
+ PSModule PSFunction_Get-HuduActivityLogs PSCommand_Get-HuduActivityLogs PSFunction_Get-HuduApiKey PSCommand_Get-HuduApiKey PSFunction_Get-HuduAppInfo PSCommand_Get-HuduAppInfo PSFunction_Get-HuduArticles PSCommand_Get-HuduArticles PSFunction_Get-HuduAssetLayoutFieldID PSCommand_Get-HuduAssetLayoutFieldID PSFunction_Get-HuduAssetLayouts PSCommand_Get-HuduAssetLayouts PSFunction_Get-HuduAssets PSCommand_Get-HuduAssets PSFunction_Get-HuduBaseURL PSCommand_Get-HuduBaseURL PSFunction_Get-HuduCard PSCommand_Get-HuduCard PSFunction_Get-HuduCompanies PSCommand_Get-HuduCompanies PSFunction_Get-HuduExpirations PSCommand_Get-HuduExpirations PSFunction_Get-HuduFolderMap PSCommand_Get-HuduFolderMap PSFunction_Get-HuduFolders PSCommand_Get-HuduFolders PSFunction_Get-HuduIntegrationMatchers PSCommand_Get-HuduIntegrationMatchers PSFunction_Get-HuduMagicDashes PSCommand_Get-HuduMagicDashes PSFunction_Get-HuduObjectByUrl PSCommand_Get-HuduObjectByUrl PSFunction_Get-HuduPasswordFolders PSCommand_Get-HuduPasswordFolders PSFunction_Get-HuduPasswords PSCommand_Get-HuduPasswords PSFunction_Get-HuduProcesses PSCommand_Get-HuduProcesses PSFunction_Get-HuduPublicPhotos PSCommand_Get-HuduPublicPhotos PSFunction_Get-HuduRelations PSCommand_Get-HuduRelations PSFunction_Get-HuduUploads PSCommand_Get-HuduUploads PSFunction_Get-HuduWebsites PSCommand_Get-HuduWebsites PSFunction_Initialize-HuduFolder PSCommand_Initialize-HuduFolder PSFunction_Move-HuduAssetsToNewLayout PSCommand_Move-HuduAssetsToNewLayout PSFunction_New-HuduAPIKey PSCommand_New-HuduAPIKey PSFunction_New-HuduArticle PSCommand_New-HuduArticle PSFunction_New-HuduAsset PSCommand_New-HuduAsset PSFunction_New-HuduAssetLayout PSCommand_New-HuduAssetLayout PSFunction_New-HuduBaseURL PSCommand_New-HuduBaseURL PSFunction_New-HuduCompany PSCommand_New-HuduCompany PSFunction_New-HuduCustomHeaders PSCommand_New-HuduCustomHeaders PSFunction_New-HuduFolder PSCommand_New-HuduFolder PSFunction_New-HuduPassword PSCommand_New-HuduPassword PSFunction_New-HuduPublicPhoto PSCommand_New-HuduPublicPhoto PSFunction_New-HuduRelation PSCommand_New-HuduRelation PSFunction_New-HuduUpload PSCommand_New-HuduUpload PSFunction_New-HuduWebsite PSCommand_New-HuduWebsite PSFunction_Remove-HuduAPIKey PSCommand_Remove-HuduAPIKey PSFunction_Remove-HuduArticle PSCommand_Remove-HuduArticle PSFunction_Remove-HuduAsset PSCommand_Remove-HuduAsset PSFunction_Remove-HuduBaseURL PSCommand_Remove-HuduBaseURL PSFunction_Remove-HuduCompany PSCommand_Remove-HuduCompany PSFunction_Remove-HuduCustomHeaders PSCommand_Remove-HuduCustomHeaders PSFunction_Remove-HuduMagicDash PSCommand_Remove-HuduMagicDash PSFunction_Remove-HuduPassword PSCommand_Remove-HuduPassword PSFunction_Remove-HuduRelation PSCommand_Remove-HuduRelation PSFunction_Remove-HuduUpload PSCommand_Remove-HuduUpload PSFunction_Remove-HuduWebsite PSCommand_Remove-HuduWebsite PSFunction_Set-HuduArticle PSCommand_Set-HuduArticle PSFunction_Set-HuduArticleArchive PSCommand_Set-HuduArticleArchive PSFunction_Set-HuduAsset PSCommand_Set-HuduAsset PSFunction_Set-HuduAssetArchive PSCommand_Set-HuduAssetArchive PSFunction_Set-HuduAssetLayout PSCommand_Set-HuduAssetLayout PSFunction_Set-HuduCompany PSCommand_Set-HuduCompany PSFunction_Set-HuduCompanyArchive PSCommand_Set-HuduCompanyArchive PSFunction_Set-HuduFolder PSCommand_Set-HuduFolder PSFunction_Set-HuduIntegrationMatcher PSCommand_Set-HuduIntegrationMatcher PSFunction_Set-HuduMagicDash PSCommand_Set-HuduMagicDash PSFunction_Set-HuduPassword PSCommand_Set-HuduPassword PSFunction_Set-HuduPasswordArchive PSCommand_Set-HuduPasswordArchive PSFunction_Set-HuduWebsite PSCommand_Set-HuduWebsite PSIncludes_Function
+ False
+ 2024-07-01T20:11:32Z
+ 2.4.9
+ Luke Whitelock
+ false
+ Module
+ HuduAPI.nuspec|HuduAPI.psm1|HuduAPI.psd1
+ 4e0a4feb-1658-416b-b854-ab9e913a56de
+ 7.0
+ MSPP
+
+
+ C:\GitHub\CIPP Workspace\CIPP-API\Modules\HuduAPI\2.4.9
+
+
+
diff --git a/Scheduler_GetWebhooks/run.ps1 b/Scheduler_GetWebhooks/run.ps1
index 3eb4aaae42fd..cef8cfb6d726 100644
--- a/Scheduler_GetWebhooks/run.ps1
+++ b/Scheduler_GetWebhooks/run.ps1
@@ -3,7 +3,7 @@ param($Timer)
try {
$webhookTable = Get-CIPPTable -tablename webhookTable
- $Webhooks = Get-CIPPAzDataTableEntity @webhookTable -Property RowKey
+ $Webhooks = Get-CIPPAzDataTableEntity @webhookTable -Property PartitionKey, RowKey
if (($Webhooks | Measure-Object).Count -eq 0) {
Write-Host 'No webhook subscriptions found. Exiting.'
return
diff --git a/Scheduler_UserTasks/run.ps1 b/Scheduler_UserTasks/run.ps1
index b5d5cdd874ca..950ca9e691bb 100644
--- a/Scheduler_UserTasks/run.ps1
+++ b/Scheduler_UserTasks/run.ps1
@@ -57,6 +57,11 @@ foreach ($task in $tasks) {
}
}
if (($Batch | Measure-Object).Count -gt 0) {
+ # Create queue entry
+ $Queue = New-CippQueueEntry -Name 'Scheduled Tasks' -TotalTasks ($Batch | Measure-Object).Count
+ $QueueId = $Queue.RowKey
+ $Batch = $Batch | Select-Object *, @{Name = 'QueueId'; Expression = { $QueueId } }, @{Name = 'QueueName'; Expression = { '{0} - {1}' -f $_.TaskInfo.Name, ($_.TaskInfo.Tenant -ne 'AllTenants' ? $_.TaskInfo.Tenant : $_.Parameters.TenantFilter) } }
+
$InputObject = [PSCustomObject]@{
OrchestratorName = 'UserTaskOrchestrator'
Batch = @($Batch)
@@ -66,4 +71,4 @@ if (($Batch | Measure-Object).Count -gt 0) {
$InstanceId = Start-NewOrchestration -FunctionName 'CIPPOrchestrator' -InputObject ($InputObject | ConvertTo-Json -Depth 10 -Compress)
Write-Host "Started orchestration with ID = '$InstanceId'"
-}
\ No newline at end of file
+}
diff --git a/Tools/Initialize-DevEnvironment.ps1 b/Tools/Initialize-DevEnvironment.ps1
index d712e396ad04..8612e74156cf 100644
--- a/Tools/Initialize-DevEnvironment.ps1
+++ b/Tools/Initialize-DevEnvironment.ps1
@@ -12,4 +12,6 @@ ForEach ($Key in $CIPPSettings.PSObject.Properties.Name) {
Import-Module "$CippRoot\Modules\AzBobbyTables"
Import-Module "$CippRoot\Modules\DNSHealth"
Import-Module "$CippRoot\Modules\CippCore"
-Get-CIPPAuthentication
\ No newline at end of file
+Import-Module "$CippRoot\Modules\CippExtensions"
+
+Get-CIPPAuthentication
diff --git a/Tools/Update-StandardsComments.ps1 b/Tools/Update-StandardsComments.ps1
new file mode 100644
index 000000000000..6660c3c5e901
--- /dev/null
+++ b/Tools/Update-StandardsComments.ps1
@@ -0,0 +1,110 @@
+<#
+.SYNOPSIS
+ This script updates the comment block in the CIPP standard files.
+
+.DESCRIPTION
+ The script reads the standards.json file and updates the comment block in the corresponding CIPP standard files.
+ It adds or modifies the comment block based on the properties defined in the standards.json file.
+ This is made to be able to generate the help documentation for the CIPP standards automatically.
+
+.INPUTS
+ None. You cannot pipe objects to this script.
+
+.OUTPUTS
+ None. The script modifies the CIPP standard files directly.
+
+.EXAMPLE
+ Update-StandardsComments.ps1
+
+ This example runs the script to update the comment block in the CIPP standard files.
+
+
+#>
+param (
+ [switch]$WhatIf
+)
+
+# Find the paths to the standards.json file based on the current script path
+$StandardsJSONPath = Split-Path (Split-Path $PSScriptRoot)
+$StandardsJSONPath = Resolve-Path "$StandardsJSONPath\*\src\data\standards.json"
+$StandardsInfo = Get-Content -Path $StandardsJSONPath | ConvertFrom-Json -Depth 10
+
+foreach ($Standard in $StandardsInfo) {
+
+ # Calculate the standards file name and path
+ $StandardFileName = $Standard.name -replace 'standards.', 'Invoke-CIPPStandard'
+ $StandardsFilePath = Resolve-Path "$(Split-Path $PSScriptRoot)\Modules\CIPPCore\Public\Standards\$StandardFileName.ps1"
+ if (-not (Test-Path $StandardsFilePath)) {
+ Write-Host "No file found for standard $($Standard.name)" -ForegroundColor Yellow
+ continue
+ }
+ $Content = (Get-Content -Path $StandardsFilePath -Raw).TrimEnd() + "`r`n"
+
+ # Remove random newlines before the param block
+ $regexPattern = '#>\s*\r?\n\s*\r?\n\s*param'
+ $Content = $Content -replace $regexPattern, "#>`r`n`r`n param"
+
+ # Regex to match the existing comment block
+ $Regex = '<#(.|\n)*?\.FUNCTIONALITY\s*Internal(.|\n)*?#>'
+
+ if ($Content -match $Regex) {
+ $NewComment = [System.Collections.Generic.List[string]]::new()
+ # Add the initial scatic comments
+ $NewComment.Add("<#`r`n")
+ $NewComment.Add(" .FUNCTIONALITY`r`n")
+ $NewComment.Add(" Internal`r`n")
+ $NewComment.Add(" .COMPONENT`r`n")
+ $NewComment.Add(" (APIName) $($Standard.name -replace 'standards.', '')`r`n")
+ $NewComment.Add(" .SYNOPSIS`r`n")
+ $NewComment.Add(" (Label) $($Standard.label.ToString())`r`n")
+ $NewComment.Add(" .DESCRIPTION`r`n")
+ if ([string]::IsNullOrWhiteSpace($Standard.docsDescription)) {
+ $NewComment.Add(" (Helptext) $($Standard.helpText.ToString())`r`n")
+ $NewComment.Add(" (DocsDescription) $($Standard.helpText.ToString())`r`n")
+ } else {
+ $NewComment.Add(" (Helptext) $($Standard.helpText.ToString())`r`n")
+ $NewComment.Add(" (DocsDescription) $($Standard.docsDescription.ToString())`r`n")
+ }
+ $NewComment.Add(" .NOTES`r`n")
+
+ # Loop through the rest of the properties of the standard and add them to the NOTES field
+ foreach ($Property in $Standard.PSObject.Properties) {
+ switch ($Property.Name) {
+ 'name' { continue }
+ 'impactColour' { continue }
+ 'docsDescription' { continue }
+ 'helpText' { continue }
+ 'label' { continue }
+ Default {
+ $NewComment.Add(" $($Property.Name.ToUpper())`r`n")
+ if ($Property.Value -is [System.Object[]]) {
+ foreach ($Value in $Property.Value) {
+ $NewComment.Add(" $(ConvertTo-Json -InputObject $Value -Depth 5 -Compress)`r`n")
+ }
+ continue
+ }
+ $NewComment.Add(" $($Property.Value.ToString())`r`n")
+ }
+ }
+
+ }
+
+ # Add header about how to update the comment block with this script
+ $NewComment.Add(" UPDATECOMMENTBLOCK`r`n")
+ $NewComment.Add(" Run the Tools\Update-StandardsComments.ps1 script to update this comment block`r`n")
+ # -Online help link
+ $NewComment.Add(" .LINK`r`n")
+ $NewComment.Add(" https://docs.cipp.app/user-documentation/tenant/standards/edit-standards`r`n")
+ $NewComment.Add(' #>')
+
+ # Write the new comment block to the file
+ if ($WhatIf.IsPresent) {
+ Write-Host "Would update $StandardsFilePath with the following comment block:"
+ $NewComment
+ } else {
+ $Content -replace $Regex, $NewComment | Set-Content -Path $StandardsFilePath -Encoding utf8 -NoNewLine
+ }
+ } else {
+ Write-Host "No comment block found in $StandardsFilePath" -ForegroundColor Yellow
+ }
+}
diff --git a/openapi.json b/openapi.json
index 20a5281ec68b..9deb23f30eee 100644
--- a/openapi.json
+++ b/openapi.json
@@ -4405,46 +4405,6 @@
}
}
},
- "/ExecDisableEmailForward": {
- "post": {
- "description": "ExecDisableEmailForward",
- "summary": "ExecDisableEmailForward",
- "tags": [
- "POST"
- ],
- "parameters": [
- {
- "required": true,
- "schema": {
- "type": "string"
- },
- "name": "tenantfilter",
- "in": "body"
- },
- {
- "required": true,
- "schema": {
- "type": "string"
- },
- "name": "user",
- "in": "body"
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "properties": {},
- "type": "object"
- }
- }
- },
- "description": "Successful operation"
- }
- }
- }
- },
"/ExecEditCalendarPermissions": {
"get": {
"description": "ExecEditCalendarPermissions",
diff --git a/version_latest.txt b/version_latest.txt
index d2d714f2a990..288b2cd9a306 100644
--- a/version_latest.txt
+++ b/version_latest.txt
@@ -1 +1 @@
-5.9.4
\ No newline at end of file
+6.0.5
| | | |