Merge pull request BNWEIN#66 from BNWEIN/Dev

BNWEIN · web-flow · commit 71fca1335601 · 2025-06-12T12:14:36.000+01:00
Dev
diff --git a/CIPPAPIModule/CIPPAPIModule.psd1 b/CIPPAPIModule/CIPPAPIModule.psd1
@@ -12,7 +12,7 @@
     RootModule = 'CIPPAPIModule.psm1'
     
     # Version number of this module.
-    ModuleVersion = '1.2.7'
+    ModuleVersion = '1.2.8'
     
     # Supported PSEditions
     # CompatiblePSEditions = @()
diff --git a/CIPPAPIModule/public/CIPP/Settings/Get-CIPPTenantGroups.ps1 b/CIPPAPIModule/public/CIPP/Settings/Get-CIPPTenantGroups.ps1
@@ -0,0 +1,37 @@
+<#
+.SYNOPSIS
+Gets tenant groups from the CIPP API.
+
+.DESCRIPTION
+The Get-CIPPTenantGroups function retrieves a list of tenant groups from the CIPP API. It can optionally filter by a specific group ID.
+
+.PARAMETER GroupID
+Optional. The ID of the group to filter by.
+
+.EXAMPLE
+Get-CIPPTenantGroups
+Returns all tenant groups.
+
+.EXAMPLE
+Get-CIPPTenantGroups -GroupID "12345678-1234-1234-1234-1234567890AB"
+Returns the tenant group with the specified ID.
+
+#>
+function Get-CIPPTenantGroups {
+    [CmdletBinding()]
+    Param(
+        [Parameter(Mandatory = $false)]
+        [string]$GroupID
+    )
+
+    Write-Verbose 'Retrieving tenant groups'
+    $endpoint = '/api/ListTenantGroups'
+    $params = @{}
+
+    if ($GroupID) {
+        Write-Verbose "Filtering by group ID: $GroupID"
+        $params['groupId'] = $GroupID
+    }
+
+    Invoke-CIPPRestMethod -Endpoint $endpoint -Params $params
+}
diff --git a/CIPPAPIModule/public/Endpoint/Applications/Get-CIPPAppsRepository.ps1 b/CIPPAPIModule/public/Endpoint/Applications/Get-CIPPAppsRepository.ps1
@@ -0,0 +1,44 @@
+<#
+.SYNOPSIS
+Searches for applications in a package repository.
+
+.DESCRIPTION
+The Get-CIPPAppsRepository function searches for applications in a specified package repository (defaults to chocolatey.org). 
+It returns detailed information about found packages including package name, author, version, and description.
+
+.PARAMETER Search
+Specifies the search term to find packages. This parameter is mandatory.
+
+.PARAMETER Repository
+Specifies the repository URL to search in. If not specified, defaults to 'https://chocolatey.org/api/v2'.
+
+.EXAMPLE
+Get-CIPPAppsRepository -Search 'chrome'
+Returns a list of packages matching 'chrome' from the default Chocolatey repository.
+
+.EXAMPLE
+Get-CIPPAppsRepository -Search 'firefox' -Repository 'https://custom.repository/api/v2'
+Returns a list of packages matching 'firefox' from the specified custom repository.
+
+.NOTES
+Having this function doesn't really make sense, but hey it's here now. 
+#>
+
+function Get-CIPPAppsRepository {
+    [CmdletBinding()]
+    param (
+        [Parameter(Mandatory = $true)]
+        [string]$Search,
+        
+        [Parameter(Mandatory = $false)]
+        [string]$Repository = 'https://chocolatey.org/api/v2'
+    )
+
+    $endpoint = '/api/ListAppsRepository'
+    $body = @{
+        Search     = $Search
+        Repository = $Repository
+    }
+
+    Invoke-CIPPRestMethod -Endpoint $endpoint -Method POST -Body $body
+}
diff --git a/CIPPAPIModule/public/Endpoint/Reports/Get-CIPPDevices.ps1 b/CIPPAPIModule/public/Endpoint/Reports/Get-CIPPDevices.ps1
@@ -31,7 +31,7 @@ function Get-CIPPDevices {
     )
     
     Write-Verbose "Getting Devices for customer: $CustomerTenantID"
-    $endpoint = '/api/listdevices'
+    $endpoint = '/api/ListDevices'
     $params = @{
         tenantFilter = $CustomerTenantID
     }
diff --git a/CIPPAPIModule/public/Tenant/Administration/ApplicationApproval/Get-CIPPAppApprovalTemplates.ps1 b/CIPPAPIModule/public/Tenant/Administration/ApplicationApproval/Get-CIPPAppApprovalTemplates.ps1
@@ -0,0 +1,21 @@
+<#
+.SYNOPSIS
+Gets application approval templates from the CIPP API.
+
+.DESCRIPTION
+The Get-CIPPAppApprovalTemplates function retrieves a list of application approval templates from the CIPP API.
+
+.EXAMPLE
+Get-CIPPAppApprovalTemplates
+Returns all application approval templates.
+
+#>
+function Get-CIPPAppApprovalTemplates {
+    [CmdletBinding()]
+    Param()
+
+    Write-Verbose 'Retrieving application approval templates'
+    $endpoint = '/api/ListAppApprovalTemplates'
+    
+    Invoke-CIPPRestMethod -Endpoint $endpoint -Method GET
+}
diff --git a/CIPPAPIModule/public/Tenant/Administration/Tenant/Get-CIPPCustomVariables.ps1 b/CIPPAPIModule/public/Tenant/Administration/Tenant/Get-CIPPCustomVariables.ps1
@@ -0,0 +1,36 @@
+﻿<#
+.SYNOPSIS
+    Retrieves custom variables for a specified tenant from the CIPP system.
+
+.DESCRIPTION
+    The Get-CIPPCustomVariables function retrieves all custom variables associated with a specific
+    tenant in CIPP
+
+.PARAMETER CustomerTenantID
+    The GUID of the tenant for which to retrieve custom variables. This parameter is mandatory.
+
+.OUTPUTS
+    Returns a collection of custom variables from the CIPP system for the specified tenant.
+
+.EXAMPLE
+    PS> Get-CIPPCustomVariables -CustomerTenantID "12345678-1234-1234-1234-1234567890ab"
+    Retrieves all custom variables for the specified tenant.
+
+.NOTES
+    This function requires appropriate permissions to access the CIPP API.
+#>
+function Get-CIPPCustomVariables {
+    [CmdletBinding()]
+    Param(
+        [Parameter(Mandatory = $true)]
+        [guid]$CustomerTenantID
+    )
+    
+    Write-Verbose "Getting org $CustomerTenantID"
+    $endpoint = '/api/ExecCippReplacemap'
+    $params = @{
+        tenantId = $CustomerTenantID
+        Action   = 'List'
+    }
+    Invoke-CIPPRestMethod -Endpoint $endpoint -Params $params
+}
diff --git a/CIPPAPIModule/public/Tenant/Administration/Tenant/Get-CIPPTenants.ps1 b/CIPPAPIModule/public/Tenant/Administration/Tenant/Get-CIPPTenants.ps1
@@ -31,7 +31,7 @@ function Get-CIPPTenants {
     )
 
     Write-Verbose 'Getting Tenants'
-    $endpoint = '/api/listtenants'
+    $endpoint = '/api/ListTenants'
     $params = @{
         tenantFilter = $CustomerTenantID
     }
diff --git a/Docs/Get-CIPPAppApprovalTemplates.md b/Docs/Get-CIPPAppApprovalTemplates.md
@@ -0,0 +1,12 @@
+# Get-CIPPAppApprovalTemplates
+## SYNOPSIS
+Gets application approval templates from the CIPP API.
+## DESCRIPTION
+The Get-CIPPAppApprovalTemplates function retrieves a list of application approval templates from the CIPP API.
+# PARAMETERS
+
+#### EXAMPLE 1
+```powershell
+PS > Get-CIPPAppApprovalTemplates
+```
+
diff --git a/Docs/Get-CIPPAppsRepository.md b/Docs/Get-CIPPAppsRepository.md
@@ -0,0 +1,25 @@
+# Get-CIPPAppsRepository
+## SYNOPSIS
+Searches for applications in a package repository.
+## DESCRIPTION
+The Get-CIPPAppsRepository function searches for applications in a specified package repository (defaults to chocolatey.org). 
+It returns detailed information about found packages including package name, author, version, and description.
+# PARAMETERS
+
+## **-Search**
+> ![Foo](https://img.shields.io/badge/Type-String-Blue?) ![Foo](https://img.shields.io/badge/Mandatory-TRUE-Red?) \
+Specifies the search term to find packages. This parameter is mandatory.
+
+  ## **-Repository**
+> ![Foo](https://img.shields.io/badge/Type-String-Blue?) ![Foo](https://img.shields.io/badge/Mandatory-FALSE-Green?) ![Foo](https://img.shields.io/badge/DefaultValue-https://chocolatey.org/api/v2-Blue?color=5547a8)\
+Specifies the repository URL to search in. If not specified, defaults to 'https://chocolatey.org/api/v2'.
+
+ #### EXAMPLE 1
+```powershell
+PS > Get-CIPPAppsRepository -Search 'chrome'
+```
+ #### EXAMPLE 2
+```powershell
+PS > Get-CIPPAppsRepository -Search 'firefox' -Repository 'https://custom.repository/api/v2'
+```
+
diff --git a/Docs/Get-CIPPCustomVariables.md b/Docs/Get-CIPPCustomVariables.md
@@ -0,0 +1,17 @@
+# Get-CIPPCustomVariables
+## SYNOPSIS
+Retrieves custom variables for a specified tenant from the CIPP system.
+## DESCRIPTION
+The Get-CIPPCustomVariables function retrieves all custom variables associated with a specific
+tenant in CIPP
+# PARAMETERS
+
+## **-CustomerTenantID**
+> ![Foo](https://img.shields.io/badge/Type-Guid-Blue?) ![Foo](https://img.shields.io/badge/Mandatory-TRUE-Red?) \
+The GUID of the tenant for which to retrieve custom variables. This parameter is mandatory.
+
+ #### EXAMPLE 1
+```powershell
+PS>Get-CIPPCustomVariables -CustomerTenantID "12345678-1234-1234-1234-1234567890ab"
+```
+
diff --git a/Docs/Get-CIPPTenantGroups.md b/Docs/Get-CIPPTenantGroups.md
@@ -0,0 +1,20 @@
+# Get-CIPPTenantGroups
+## SYNOPSIS
+Gets tenant groups from the CIPP API.
+## DESCRIPTION
+The Get-CIPPTenantGroups function retrieves a list of tenant groups from the CIPP API. It can optionally filter by a specific group ID.
+# PARAMETERS
+
+## **-GroupID**
+> ![Foo](https://img.shields.io/badge/Type-String-Blue?) ![Foo](https://img.shields.io/badge/Mandatory-FALSE-Green?) \
+Optional. The ID of the group to filter by.
+
+ #### EXAMPLE 1
+```powershell
+PS > Get-CIPPTenantGroups
+```
+ #### EXAMPLE 2
+```powershell
+PS > Get-CIPPTenantGroups -GroupID "12345678-1234-1234-1234-1234567890AB"
+```
+
diff --git a/README.md b/README.md
@@ -112,6 +112,7 @@ You must enter that text exactly, otherwise the assignment does not trigger.
   - [Get-CIPPExcludedLicenses](./Docs/Get-CIPPExcludedLicenses.md)
   - [Get-CIPPExcludedTenants](./Docs/Get-CIPPExcludedTenants.md)
   - [Get-CIPPNotificationConfig](./Docs/Get-CIPPNotificationConfig.md)
+  - [Get-CIPPTenantGroups](./Docs/Get-CIPPTenantGroups.md)
   - [Get-CIPPVersion](./Docs/Get-CIPPVersion.md)
   - [Set-CIPPExcludeLicense](./Docs/Set-CIPPExcludeLicense.md)
   - [Set-CIPPExcludeTenant](./Docs/Set-CIPPExcludeTenant.md)
@@ -146,6 +147,7 @@ You must enter that text exactly, otherwise the assignment does not trigger.
 - [Get-CIPPExcludedLicenses](./Docs/Get-CIPPExcludedLicenses.md)
 - [Get-CIPPExcludedTenants](./Docs/Get-CIPPExcludedTenants.md)
 - [Get-CIPPNotificationConfig](./Docs/Get-CIPPNotificationConfig.md)
+- [Get-CIPPTenantGroups](./Docs/Get-CIPPTenantGroups.md)
 - [Get-CIPPVersion](./Docs/Get-CIPPVersion.md)
 - [Set-CIPPExcludeLicense](./Docs/Set-CIPPExcludeLicense.md)
 - [Set-CIPPExcludeTenant](./Docs/Set-CIPPExcludeTenant.md)
@@ -281,6 +283,7 @@ You must enter that text exactly, otherwise the assignment does not trigger.
 ## Endpoint
 - Applications
   - [Get-CIPPApps](./Docs/Get-CIPPApps.md)
+  - [Get-CIPPAppsRepository](./Docs/Get-CIPPAppsRepository.md)
   - [Get-CIPPAppStatus](./Docs/Get-CIPPAppStatus.md)
   - [Remove-CIPPIntuneApp](./Docs/Remove-CIPPIntuneApp.md)
   - [Remove-CIPPQueuedApp](./Docs/Remove-CIPPQueuedApp.md)
@@ -305,6 +308,7 @@ You must enter that text exactly, otherwise the assignment does not trigger.
 - Reports
   - [Get-CIPPDevices](./Docs/Get-CIPPDevices.md)
 - [Get-CIPPApps](./Docs/Get-CIPPApps.md)
+- [Get-CIPPAppsRepository](./Docs/Get-CIPPAppsRepository.md)
 - [Get-CIPPAppStatus](./Docs/Get-CIPPAppStatus.md)
 - [Remove-CIPPIntuneApp](./Docs/Remove-CIPPIntuneApp.md)
 - [Remove-CIPPQueuedApp](./Docs/Remove-CIPPQueuedApp.md)
@@ -474,6 +478,7 @@ You must enter that text exactly, otherwise the assignment does not trigger.
 ## Tenant
 - Administration
   - [Alerts](./Docs/Alerts.md)
+  - [ApplicationApproval](./Docs/ApplicationApproval.md)
   - [Licenses](./Docs/Licenses.md)
   - [Tenant](./Docs/Tenant.md)
   - [Get-CIPPAppConsentReqs](./Docs/Get-CIPPAppConsentReqs.md)
@@ -515,12 +520,15 @@ You must enter that text exactly, otherwise the assignment does not trigger.
   - [Get-CIPPAlerts](./Docs/Get-CIPPAlerts.md)
   - [Get-CIPPAuditLog](./Docs/Get-CIPPAuditLog.md)
 - Application Approval
+- ApplicationApproval
+  - [Get-CIPPAppApprovalTemplates](./Docs/Get-CIPPAppApprovalTemplates.md)
 - Licenses
   - [Get-CIPPCSPLicenses](./Docs/Get-CIPPCSPLicenses.md)
   - [Get-CIPPCSPSku](./Docs/Get-CIPPCSPSku.md)
   - [Set-CIPPCSPLicense](./Docs/Set-CIPPCSPLicense.md)
 - Tenant
   - [Get-CIPPADConnectStatus](./Docs/Get-CIPPADConnectStatus.md)
+  - [Get-CIPPCustomVariables](./Docs/Get-CIPPCustomVariables.md)
   - [Get-CIPPOrg](./Docs/Get-CIPPOrg.md)
   - [Get-CIPPPartnerRelationships](./Docs/Get-CIPPPartnerRelationships.md)
   - [Get-CIPPTenantDetails](./Docs/Get-CIPPTenantDetails.md)
@@ -531,10 +539,12 @@ You must enter that text exactly, otherwise the assignment does not trigger.
 - [Remove-CIPPTenantAllowBlockList](./Docs/Remove-CIPPTenantAllowBlockList.md)
 - [Get-CIPPAlerts](./Docs/Get-CIPPAlerts.md)
 - [Get-CIPPAuditLog](./Docs/Get-CIPPAuditLog.md)
+- [Get-CIPPAppApprovalTemplates](./Docs/Get-CIPPAppApprovalTemplates.md)
 - [Get-CIPPCSPLicenses](./Docs/Get-CIPPCSPLicenses.md)
 - [Get-CIPPCSPSku](./Docs/Get-CIPPCSPSku.md)
 - [Set-CIPPCSPLicense](./Docs/Set-CIPPCSPLicense.md)
 - [Get-CIPPADConnectStatus](./Docs/Get-CIPPADConnectStatus.md)
+- [Get-CIPPCustomVariables](./Docs/Get-CIPPCustomVariables.md)
 - [Get-CIPPOrg](./Docs/Get-CIPPOrg.md)
 - [Get-CIPPPartnerRelationships](./Docs/Get-CIPPPartnerRelationships.md)
 - [Get-CIPPTenantDetails](./Docs/Get-CIPPTenantDetails.md)

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ function Get-CIPPDevices {`
`31`	`31`	`)`
`32`	`32`
`33`	`33`	`Write-Verbose "Getting Devices for customer: $CustomerTenantID"`
`34`		`- $endpoint = '/api/listdevices'`
	`34`	`+ $endpoint = '/api/ListDevices'`
`35`	`35`	`$params = @{`
`36`	`36`	`tenantFilter = $CustomerTenantID`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ function Get-CIPPTenants {`
`31`	`31`	`)`
`32`	`32`
`33`	`33`	`Write-Verbose 'Getting Tenants'`
`34`		`- $endpoint = '/api/listtenants'`
	`34`	`+ $endpoint = '/api/ListTenants'`
`35`	`35`	`$params = @{`
`36`	`36`	`tenantFilter = $CustomerTenantID`
`37`	`37`	`}`