Public/Get/Entities/Get-NinjaRMMOrganisations.ps1
|
#Requires -Version 7 function Get-NinjaRMMOrganisations { <# .SYNOPSIS Gets organisations from the NinjaRMM API. .DESCRIPTION Retrieves organisations from the NinjaRMM v2 API. .OUTPUTS A powershell object containing the response. #> [CmdletBinding( DefaultParameterSetName = 'Multi' )] [OutputType([Object])] [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', '', Justification = 'Uses dynamic parameter parsing.')] Param( # Organisation ID [Parameter( ParameterSetName = 'Single', Mandatory = $True )] [Alias('organizationID')] [Int]$organisationID, # Number of results per page. [Parameter( ParameterSetName = 'Multi' )] [Int]$pageSize, # Start results from organisation ID. [Parameter( ParameterSetName = 'Multi' )] [Int]$after, # Include locations and policy mappings. [Parameter( ParameterSetName = 'Multi')] [Switch]$detailed ) $CommandName = $MyInvocation.InvocationName $Parameters = (Get-Command -Name $CommandName).Parameters # Workaround to prevent the query string processor from adding an 'organisationid=' parameter by removing it from the set parameters. if ($organisationID) { $Parameters.Remove('organisationID') | Out-Null } # Similarly we don't want a `detailed=true` parameter since we're targetting a different resource. if ($detailed) { $Parameters.Remove('detailed') | Out-Null } try { $QSCollection = New-NinjaRMMQuery -CommandName $CommandName -Parameters $Parameters if ($organisationID) { Write-Verbose "Retrieving information on organisation with ID $($organisationID)" $Resource = "v2/organization/$($organisationID)" $RequestParams = @{ Method = 'GET' Resource = $Resource QSCollection = $QSCollection } } else { if ($detailed) { Write-Verbose 'Retrieving detailed information on all organisations' $Resource = 'v2/organizations-detailed' } else { Write-Verbose 'Retrieving all organisations' $Resource = 'v2/organizations' } $RequestParams = @{ Method = 'GET' Resource = $Resource QSCollection = $QSCollection } } $OrganisationResults = New-NinjaRMMGETRequest @RequestParams Return $OrganisationResults } catch { $CommandFailedError = [ErrorRecord]::New( [System.Exception]::New( 'Failed to get organisations from NinjaRMM. You can use "Get-Error" for detailed error information.', $_.Exception ), 'NinjaCommandFailed', 'ReadError', $TargetObject ) $PSCmdlet.ThrowTerminatingError($CommandFailedError) } } |