diff --git a/PSSailpoint/PSSailpoint.psd1 b/PSSailpoint/PSSailpoint.psd1 index d5a20fc33..7c45296d0 100644 --- a/PSSailpoint/PSSailpoint.psd1 +++ b/PSSailpoint/PSSailpoint.psd1 @@ -85,11 +85,12 @@ FunctionsToExport = 'New-AccessProfile', 'Remove-AccessProfilesInBulk', 'Complete-Campaign', 'New-Campaign', 'New-CampaignTemplate', 'Remove-Campaigns', 'Get-ActiveCampaigns', 'Get-Campaign', 'Get-CampaignReports', 'Get-CampaignReportsConfig', - 'Get-CampaignTemplates', 'Move-', 'Update-CampaignTemplate', - 'Set-CampaignReportsConfig', 'Start-Campaign', - 'Start-CampaignRemediationScan', 'Start-CampaignReport', - 'Start-GenerateCampaignTemplate', 'Update-Campaign', - 'Get-CertificationTask', 'Get-IdentityCertification', + 'Get-CampaignTemplate', 'Get-CampaignTemplates', 'Move-', + 'Update-CampaignTemplate', 'Set-CampaignReportsConfig', + 'Start-Campaign', 'Start-CampaignRemediationScan', + 'Start-CampaignReport', 'Start-GenerateCampaignTemplate', + 'Update-Campaign', 'Get-CertificationTask', + 'Get-IdentityCertification', 'Get-IdentityCertificationItemPermissions', 'Get-PendingCertificationTasks', 'Get-CertificationReviewers', 'Get-IdentityAccessReviewItems', 'Get-IdentityCertifications', diff --git a/PSSailpoint/v3/README.md b/PSSailpoint/v3/README.md index 95d6e0def..4f22e9c6e 100644 --- a/PSSailpoint/v3/README.md +++ b/PSSailpoint/v3/README.md @@ -93,6 +93,7 @@ Class | Method | HTTP request | Description *CertificationCampaignsApi* | [**Get-Campaign**](docs/CertificationCampaignsApi.md#Get-Campaign) | **GET** /campaigns/{id} | Get a campaign *CertificationCampaignsApi* | [**Get-CampaignReports**](docs/CertificationCampaignsApi.md#Get-CampaignReports) | **GET** /campaigns/{id}/reports | Get Campaign Reports *CertificationCampaignsApi* | [**Get-CampaignReportsConfig**](docs/CertificationCampaignsApi.md#Get-CampaignReportsConfig) | **GET** /campaigns/reports-configuration | Get Campaign Reports Configuration +*CertificationCampaignsApi* | [**Get-CampaignTemplate**](docs/CertificationCampaignsApi.md#Get-CampaignTemplate) | **GET** /campaign-templates/{id} | Get a Campaign Template *CertificationCampaignsApi* | [**Get-CampaignTemplates**](docs/CertificationCampaignsApi.md#Get-CampaignTemplates) | **GET** /campaign-templates | List Campaign Templates *CertificationCampaignsApi* | [**Move-**](docs/CertificationCampaignsApi.md#Move-) | **POST** /campaigns/{id}/reassign | Reassign Certifications *CertificationCampaignsApi* | [**Update-CampaignTemplate**](docs/CertificationCampaignsApi.md#Update-CampaignTemplate) | **PATCH** /campaign-templates/{id} | Update a Campaign Template diff --git a/PSSailpoint/v3/docs/CertificationCampaignsApi.md b/PSSailpoint/v3/docs/CertificationCampaignsApi.md index 09ddf96f5..a260d8a27 100644 --- a/PSSailpoint/v3/docs/CertificationCampaignsApi.md +++ b/PSSailpoint/v3/docs/CertificationCampaignsApi.md @@ -12,6 +12,7 @@ Method | HTTP request | Description [**Get-Campaign**](CertificationCampaignsApi.md#Get-Campaign) | **GET** /campaigns/{id} | Get a campaign [**Get-CampaignReports**](CertificationCampaignsApi.md#Get-CampaignReports) | **GET** /campaigns/{id}/reports | Get Campaign Reports [**Get-CampaignReportsConfig**](CertificationCampaignsApi.md#Get-CampaignReportsConfig) | **GET** /campaigns/reports-configuration | Get Campaign Reports Configuration +[**Get-CampaignTemplate**](CertificationCampaignsApi.md#Get-CampaignTemplate) | **GET** /campaign-templates/{id} | Get a Campaign Template [**Get-CampaignTemplates**](CertificationCampaignsApi.md#Get-CampaignTemplates) | **GET** /campaign-templates | List Campaign Templates [**Move-**](CertificationCampaignsApi.md#Move-) | **POST** /campaigns/{id}/reassign | Reassign Certifications [**Update-CampaignTemplate**](CertificationCampaignsApi.md#Update-CampaignTemplate) | **PATCH** /campaign-templates/{id} | Update a Campaign Template @@ -459,6 +460,57 @@ This endpoint does not need any parameter. [[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-CampaignTemplate** +> CampaignTemplate Get-CampaignTemplate
+>         [-Id]
+ +Get a Campaign Template + +Fetches a campaign template by ID. + +### 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" + +$Id = "2c9180835d191a86015d28455b4a2329" # String | The desired campaign template's ID. + +# Get a Campaign Template +try { + $Result = Get-CampaignTemplate -Id $Id +} catch { + Write-Host ("Exception occurred when calling Get-CampaignTemplate: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **Id** | **String**| The desired campaign template's ID. | + +### Return type + +[**CampaignTemplate**](CampaignTemplate.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) + # **Get-CampaignTemplates** > CampaignTemplate[] Get-CampaignTemplates
diff --git a/PSSailpoint/v3/src/PSSailpoint/Api/CertificationCampaignsApi.ps1 b/PSSailpoint/v3/src/PSSailpoint/Api/CertificationCampaignsApi.ps1 index a97702404..8cbf31751 100644 --- a/PSSailpoint/v3/src/PSSailpoint/Api/CertificationCampaignsApi.ps1 +++ b/PSSailpoint/v3/src/PSSailpoint/Api/CertificationCampaignsApi.ps1 @@ -711,6 +711,80 @@ function Get-CampaignReportsConfig { <# .SYNOPSIS +Get a Campaign Template + +.DESCRIPTION + +Fetches a campaign template by ID. + +.PARAMETER Id +The desired campaign template's ID. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +CampaignTemplate +#> +function Get-CampaignTemplate { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String] + ${Id}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Get-CampaignTemplate' | 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-templates/{id}' + if (!$Id) { + throw "Error! The required parameter `Id` missing when calling getCampaignTemplate." + } + $LocalVarUri = $LocalVarUri.replace('{id}', [System.Web.HTTPUtility]::UrlEncode($Id)) + + + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "CampaignTemplate" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + List Campaign Templates .DESCRIPTION diff --git a/PSSailpoint/v3/tests/Api/CertificationCampaignsApi.Tests.ps1 b/PSSailpoint/v3/tests/Api/CertificationCampaignsApi.Tests.ps1 index 8571ba4de..a1c677f30 100644 --- a/PSSailpoint/v3/tests/Api/CertificationCampaignsApi.Tests.ps1 +++ b/PSSailpoint/v3/tests/Api/CertificationCampaignsApi.Tests.ps1 @@ -70,6 +70,14 @@ Describe -tag 'PSSailpoint' -name 'CertificationCampaignsApi' { } } + Context 'Get-CampaignTemplate' { + It 'Test Get-CampaignTemplate' { + #$TestResult = Get-CampaignTemplate -Id "TEST_VALUE" + #$TestResult | Should -BeOfType TODO + #$TestResult.property | Should -Be 0 + } + } + Context 'Get-CampaignTemplates' { It 'Test Get-CampaignTemplates' { #$TestResult = Get-CampaignTemplates -Limit "TEST_VALUE" -Offset "TEST_VALUE" -Count "TEST_VALUE" -Sorters "TEST_VALUE" -Filters "TEST_VALUE"