diff --git a/PSSailpoint/PSSailpoint.psd1 b/PSSailpoint/PSSailpoint.psd1 index e578c3a8e..c9fa54357 100644 --- a/PSSailpoint/PSSailpoint.psd1 +++ b/PSSailpoint/PSSailpoint.psd1 @@ -3,7 +3,7 @@ # # Generated by: Sailpoint Developer Relations # -# Generated on: 10/30/2023 +# Generated on: 10/31/2023 # @{ @@ -83,7 +83,7 @@ FunctionsToExport = 'New-AccessProfile', 'Remove-AccessProfile', 'Get-AccountEntitlements', 'Get-Accounts', 'Send-Account', 'Invoke-ReloadAccount', 'Unlock-Account', 'Update-Account', 'Get-UsagesByAccountId', 'Get-AuthUser', 'Update-AuthUser', - 'New-CampaignFilter', 'Get-CampaignFilterById', + 'New-CampaignFilter', 'Get-CampaignFilterById', 'Get-CampaignFilters', 'Update-CampaignFilter', 'Complete-Campaign', 'New-Campaign', 'New-CampaignTemplate', 'Remove-CampaignTemplate', 'Remove-Campaigns', 'Get-ActiveCampaigns', 'Get-Campaign', 'Get-CampaignReports', diff --git a/PSSailpoint/v3/README.md b/PSSailpoint/v3/README.md index 014b3bf7d..e44fe835c 100644 --- a/PSSailpoint/v3/README.md +++ b/PSSailpoint/v3/README.md @@ -88,6 +88,7 @@ Class | Method | HTTP request | Description *AuthUserApi* | [**Update-AuthUser**](docs/AuthUserApi.md#Update-AuthUser) | **PATCH** /auth-users/{id} | Auth User Update *CertificationCampaignFiltersApi* | [**New-CampaignFilter**](docs/CertificationCampaignFiltersApi.md#New-CampaignFilter) | **POST** /campaign-filters | Create a Campaign Filter *CertificationCampaignFiltersApi* | [**Get-CampaignFilterById**](docs/CertificationCampaignFiltersApi.md#Get-CampaignFilterById) | **GET** /campaign-filters/{id} | Get Campaign Filter by ID +*CertificationCampaignFiltersApi* | [**Get-CampaignFilters**](docs/CertificationCampaignFiltersApi.md#Get-CampaignFilters) | **GET** /campaign-filters | List Campaign Filters *CertificationCampaignFiltersApi* | [**Update-CampaignFilter**](docs/CertificationCampaignFiltersApi.md#Update-CampaignFilter) | **POST** /campaign-filters/{id} | Updates a Campaign Filter *CertificationCampaignsApi* | [**Complete-Campaign**](docs/CertificationCampaignsApi.md#Complete-Campaign) | **POST** /campaigns/{id}/complete | Complete a Campaign *CertificationCampaignsApi* | [**New-Campaign**](docs/CertificationCampaignsApi.md#New-Campaign) | **POST** /campaigns | Create a campaign diff --git a/PSSailpoint/v3/docs/CertificationCampaignFiltersApi.md b/PSSailpoint/v3/docs/CertificationCampaignFiltersApi.md index 9e53d6427..a94017541 100644 --- a/PSSailpoint/v3/docs/CertificationCampaignFiltersApi.md +++ b/PSSailpoint/v3/docs/CertificationCampaignFiltersApi.md @@ -6,6 +6,7 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**New-CampaignFilter**](CertificationCampaignFiltersApi.md#New-CampaignFilter) | **POST** /campaign-filters | Create a Campaign Filter [**Get-CampaignFilterById**](CertificationCampaignFiltersApi.md#Get-CampaignFilterById) | **GET** /campaign-filters/{id} | Get Campaign Filter by ID +[**Get-CampaignFilters**](CertificationCampaignFiltersApi.md#Get-CampaignFilters) | **GET** /campaign-filters | List Campaign Filters [**Update-CampaignFilter**](CertificationCampaignFiltersApi.md#Update-CampaignFilter) | **POST** /campaign-filters/{id} | Updates a Campaign Filter @@ -112,6 +113,63 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **Get-CampaignFilters** +> CampaignFilterDetails[] Get-CampaignFilters
+>         [-Limit]
+>         [-Start]
+>         [-IncludeSystemFilters]
+ +List Campaign Filters + +Lists all Campaign Filters. Scope can be reduced via standard V3 query params. All Campaign Filters matching the query params + +### Example +```powershell +# general setting of the PowerShell module, e.g. base URL, authentication, etc +$Configuration = Get-Configuration +# Configure OAuth2 access token for authorization: UserContextAuth +$Configuration.AccessToken = "YOUR_ACCESS_TOKEN" + +# Configure OAuth2 access token for authorization: UserContextAuth +$Configuration.AccessToken = "YOUR_ACCESS_TOKEN" + +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$IncludeSystemFilters = $true # Boolean | If true, include system filters in the count and results, exclude them otherwise. If not provided any value for it then by default it is true. (optional) (default to $true) + +# List Campaign Filters +try { + $Result = Get-CampaignFilters -Limit $Limit -Start $Start -IncludeSystemFilters $IncludeSystemFilters +} catch { + Write-Host ("Exception occurred when calling Get-CampaignFilters: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Limit** | **Int32**| Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] + **Start** | **Int32**| Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] + **IncludeSystemFilters** | **Boolean**| If true, include system filters in the count and results, exclude them otherwise. If not provided any value for it then by default it is true. | [optional] [default to $true] + +### Return type + +[**CampaignFilterDetails[]**](CampaignFilterDetails.md) (PSCustomObject) + +### Authorization + +[UserContextAuth](../README.md#UserContextAuth), [UserContextAuth](../README.md#UserContextAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **Update-CampaignFilter** > CampaignFilterDetails Update-CampaignFilter
diff --git a/PSSailpoint/v3/src/PSSailpoint/Api/CertificationCampaignFiltersApi.ps1 b/PSSailpoint/v3/src/PSSailpoint/Api/CertificationCampaignFiltersApi.ps1 index e41048d99..d8680155c 100644 --- a/PSSailpoint/v3/src/PSSailpoint/Api/CertificationCampaignFiltersApi.ps1 +++ b/PSSailpoint/v3/src/PSSailpoint/Api/CertificationCampaignFiltersApi.ps1 @@ -149,6 +149,100 @@ function Get-CampaignFilterById { + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "CampaignFilterDetails[]" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +List Campaign Filters + +.DESCRIPTION + +Lists all Campaign Filters. Scope can be reduced via standard V3 query params. All Campaign Filters matching the query params + +.PARAMETER Limit +Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +.PARAMETER Start +Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +.PARAMETER IncludeSystemFilters +If true, include system filters in the count and results, exclude them otherwise. If not provided any value for it then by default it is true. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +CampaignFilterDetails[] +#> +function Get-CampaignFilters { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Limit}, + [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32]] + ${Start}, + [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Boolean]] + ${IncludeSystemFilters}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-CampaignFilters' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('application/json') + + $LocalVarUri = '/campaign-filters' + + if ($Limit) { + $LocalVarQueryParameters['limit'] = $Limit + } + + if ($Start) { + $LocalVarQueryParameters['start'] = $Start + } + + if ($IncludeSystemFilters) { + $LocalVarQueryParameters['includeSystemFilters'] = $IncludeSystemFilters + } + + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` diff --git a/PSSailpoint/v3/tests/Api/CertificationCampaignFiltersApi.Tests.ps1 b/PSSailpoint/v3/tests/Api/CertificationCampaignFiltersApi.Tests.ps1 index 72704a464..34e00d5b7 100644 --- a/PSSailpoint/v3/tests/Api/CertificationCampaignFiltersApi.Tests.ps1 +++ b/PSSailpoint/v3/tests/Api/CertificationCampaignFiltersApi.Tests.ps1 @@ -22,6 +22,14 @@ Describe -tag 'PSSailpoint' -name 'CertificationCampaignFiltersApi' { } } + Context 'Get-CampaignFilters' { + It 'Test Get-CampaignFilters' { + #$TestResult = Get-CampaignFilters -Limit "TEST_VALUE" -Start "TEST_VALUE" -IncludeSystemFilters "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + Context 'Update-CampaignFilter' { It 'Test Update-CampaignFilter' { #$TestResult = Update-CampaignFilter -FilterId "TEST_VALUE" -CampaignFilterDetails "TEST_VALUE"