Add Invoke-RemoveDeletedObject function for permanently deleting directory items

Author: kris6673

Modules/CIPPCore/Public/Entrypoints/HTTP Functions/Identity/Administration/Users/Invoke-RemoveDeletedObject.ps1

@@ -0,0 +1,48 @@
+using namespace System.Net
+
+Function Invoke-RemoveDeletedObject {
+    <#
+    .FUNCTIONALITY
+        Entrypoint
+    .ROLE
+        Tenant.Directory.ReadWrite
+    #>
+    [CmdletBinding()]
+    param($Request, $TriggerMetadata)
+
+    $APIName = $Request.Params.CIPPEndpoint
+    $Headers = $Request.Headers
+    Write-LogMessage -headers $Headers -API $APIName -message 'Accessed this API' -Sev 'Debug'
+
+    # Interact with query parameters or the body of the request.
+    $TenantFilter = $Request.Query.tenantFilter ?? $Request.Body.tenantFilter
+    $RequestID = $Request.Query.ID ?? $Request.Body.ID
+    $UserPrincipalName = $Request.Body.userPrincipalName
+    $DisplayName = $Request.Body.displayName
+
+    try {
+        $null = New-GraphPostRequest -uri "https://graph.microsoft.com/v1.0/directory/deletedItems/$($RequestID)" -tenantid $TenantFilter -type DELETE -body '{}' -Verbose
+        $Result = "Successfully permanently deleted item with ID: '$($RequestID)'"
+        if ($UserPrincipalName) { $Result += " User Principal Name: '$($UserPrincipalName)'" }
+        if ($DisplayName) { $Result += " Display Name: '$($DisplayName)'" }
+
+        Write-LogMessage -headers $Headers -tenant $TenantFilter -API $APIName -message $Result -Sev 'Info'
+        $StatusCode = [HttpStatusCode]::OK
+    } catch {
+        $ErrorMessage = Get-CippException -Exception $_
+        $Result = "Failed to permanently delete item with ID: $($RequestID). Error: $($ErrorMessage.NormalizedError)"
+        if ($UserPrincipalName) { $Result += " User Principal Name: '$($UserPrincipalName)'" }
+        if ($DisplayName) { $Result += " Display Name: '$($DisplayName)'" }
+
+        Write-LogMessage -headers $Headers -tenant $TenantFilter -API $APIName -message $Result -Sev 'Error' -LogData $ErrorMessage
+        $StatusCode = [HttpStatusCode]::InternalServerError
+    }
+
+    $Results = [pscustomobject]@{'Results' = $Result }
+    # Associate values to output bindings by calling 'Push-OutputBinding'.
+    Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
+            StatusCode = $StatusCode
+            Body       = $Results
+        })
+
+}