Functions/BloxOne/BloxOneTD/Get-B1BypassCode.ps1
|
function Get-B1BypassCode { <# .SYNOPSIS Retrieves a list of Bypass Codes from BloxOne Cloud .DESCRIPTION This function is used to query a list of Bypass Codes from BloxOne Cloud .PARAMETER Name Filter results by Name. .PARAMETER Description Filter results by Description. .PARAMETER Limit Use this parameter to limit the quantity of results. .PARAMETER Offset Use this parameter to offset the results by the value entered for the purpose of pagination .PARAMETER Fields Specify a list of fields to return. The default is to return all fields. .PARAMETER OrderBy Optionally return the list ordered by a particular value. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. Using 'asc' or 'desc' as a suffix will change the ordering, with ascending as default. .PARAMETER Strict Use strict filter matching. By default, filters are searched using wildcards where possible. Using strict matching will only return results matching exactly what is entered in the applicable parameters. .PARAMETER access_key Filter the results by access key .PARAMETER CustomFilters Accepts either an Object, ArrayList or String containing one or more custom filters. See here for usage: https://ibps.readthedocs.io/en/latest/#-customfilters .EXAMPLE PS> Get-B1BypassCode .FUNCTIONALITY Threat Defense #> [CmdletBinding(DefaultParameterSetName="Default")] param( [Parameter(ParameterSetName="Default")] [String]$Name, [Parameter(ParameterSetName="Default")] [String]$Description, [Parameter(ParameterSetName="Default")] [Int]$Limit, [Parameter(ParameterSetName="Default")] [Int]$Offset, [String[]]$Fields, [Parameter(ParameterSetName="Default")] [String]$OrderBy, [Parameter(ParameterSetName="Default")] [Switch]$Strict, [Parameter(ParameterSetName="Default")] $CustomFilters, [parameter(ParameterSetName="With ID")] [String]$access_key ) $MatchType = Match-Type $Strict [System.Collections.ArrayList]$Filters = @() [System.Collections.ArrayList]$QueryFilters = @() if ($CustomFilters) { $Filters.Add($CustomFilters) | Out-Null } if ($Name) { $Filters.Add("name$MatchType`"$Name`"") | Out-Null } if ($Description) { $Filters.Add("description$MatchType`"$Description`"") | Out-Null } if ($Filters) { $Filter = Combine-Filters $Filters $QueryFilters.Add("_filter=$Filter") | Out-Null } if ($Limit) { $QueryFilters.Add("_limit=$Limit") | Out-Null } if ($Offset) { $QueryFilters.Add("_offset=$Offset") | Out-Null } if ($Fields) { $Fields += "access_key" $QueryFilters.Add("_fields=$($Fields -join ",")") | Out-Null } if ($QueryFilters) { $QueryString = ConvertTo-QueryString $QueryFilters } Write-DebugMsg -Filters $QueryFilters if ($access_key) { $Results = Invoke-CSP -Method GET -Uri "$(Get-B1CSPUrl)/api/atcfw/v1/access_codes/$access_key" | Select-Object -ExpandProperty results -ErrorAction SilentlyContinue -WarningAction SilentlyContinue } elseif ($QueryString) { $Results = Invoke-CSP -Method GET -Uri "$(Get-B1CSPUrl)/api/atcfw/v1/access_codes$QueryString" | Select-Object -ExpandProperty results -ErrorAction SilentlyContinue -WarningAction SilentlyContinue } else { $Results = Invoke-CSP -Method GET -Uri "$(Get-B1CSPUrl)/api/atcfw/v1/access_codes" | Select-Object -ExpandProperty results -ErrorAction SilentlyContinue -WarningAction SilentlyContinue } if ($Results) { return $Results } } |