LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to powershell SDK docs: 13122455471

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-03 20:42:04 +00:00
parent aeda961e54
commit bdb088c15d
207 changed files with 3520 additions and 8694 deletions
Download Patch File Download Diff File Expand all files Collapse all files

167
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationCampaignsApi.md
View File

@@ -1,3 +1,4 @@
---
id: beta-certification-campaigns
title: CertificationCampaigns
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/certification-campaigns
tags: ['SDK', 'Software Development Kit', 'CertificationCampaigns', 'BetaCertificationCampaigns']
---
# CertificationCampaigns
Use this API to implement certification campaign functionality.
With this functionality in place, administrators can create, customize, and manage certification campaigns for their organizations' use.
@@ -106,9 +106,7 @@ Method | HTTP request | Description
[**Start-BetaGenerateCampaignTemplate**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a Campaign from Template
[**Update-BetaCampaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a Campaign
## complete-campaign
:::caution
This endpoint will run successfully for any campaigns that are **past due**.
@@ -130,7 +128,6 @@ Path | Id | **String** | True | Campaign ID.
Body | CompleteCampaignOptions | [**CompleteCampaignOptions**](../models/complete-campaign-options) | (optional) | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -145,7 +142,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -155,7 +151,9 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID.
$CompleteCampaignOptions = @"{
"autoCompleteAction" : "REVOKE"
}"@
# Complete a Campaign
try {
Complete-BetaCampaign-BetaId $Id
@@ -166,11 +164,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-campaign
Use this API to create a certification campaign with the information provided in the request body. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -182,7 +177,6 @@ Param Type | Name | Data Type | Required | Description
Body | Campaign | [**Campaign**](../models/campaign) | True |
### Return type
[**Campaign**](../models/campaign)
### Responses
@@ -196,7 +190,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -311,7 +304,9 @@ $Campaign = @"{
"status" : "ACTIVE",
"correlatedStatus" : "CORRELATED"
}"@
# Create Campaign
try {
$Result = ConvertFrom-JsonToCampaign -Json $Campaign
New-BetaCampaign-BetaCampaign $Result
@@ -323,11 +318,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-campaign-template
Use this API to create a campaign template based on campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign-template).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -339,7 +331,6 @@ Param Type | Name | Data Type | Required | Description
Body | CampaignTemplate | [**CampaignTemplate**](../models/campaign-template) | True |
### Return type
[**CampaignTemplate**](../models/campaign-template)
### Responses
@@ -353,7 +344,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -483,7 +473,9 @@ $CampaignTemplate = @"{
},
"id" : "2c9079b270a266a60170a277bb960008"
}"@
# Create a Campaign Template
try {
$Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate
New-BetaCampaignTemplate-BetaCampaignTemplate $Result
@@ -495,11 +487,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-campaign-template
Use this API to delete a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -511,7 +500,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the campaign template being deleted.
### Return type
(empty response body)
### Responses
@@ -526,14 +514,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted.
# Delete a Campaign Template
try {
Remove-BetaCampaignTemplate-BetaId $Id
@@ -544,11 +533,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-campaign-template-schedule
Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template-schedule).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -560,7 +546,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the campaign template whose schedule is being deleted.
### Return type
(empty response body)
### Responses
@@ -575,14 +560,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted.
# Delete Campaign Template Schedule
try {
Remove-BetaCampaignTemplateSchedule-BetaId $Id
@@ -593,11 +579,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-campaigns
Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaigns).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -609,7 +592,6 @@ Param Type | Name | Data Type | Required | Description
Body | DeleteCampaignsRequest | [**DeleteCampaignsRequest**](../models/delete-campaigns-request) | True | IDs of the campaigns to delete.
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -624,7 +606,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -633,7 +614,9 @@ Code | Description | Data Type
$DeleteCampaignsRequest = @"{
"ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ]
}"@
# Delete Campaigns
try {
$Result = ConvertFrom-JsonToDeleteCampaignsRequest -Json $DeleteCampaignsRequest
Remove-BetaCampaigns-BetaDeleteCampaignsRequest $Result
@@ -645,11 +628,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-active-campaigns
Use this API to get a list of campaigns. The API can provide increased level of detail for each campaign for the correct provided query. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-active-campaigns).
A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
@@ -666,7 +646,6 @@ Param Type | Name | Data Type | Required | Description
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created**
### Return type
[**GetActiveCampaigns200ResponseInner[]**](../models/get-active-campaigns200-response-inner)
### Responses
@@ -680,7 +659,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -692,7 +670,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'name eq "Manager Campaign"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional)
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional)
# List Campaigns
try {
Get-BetaActiveCampaigns
@@ -703,11 +683,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-campaign
Use this API to get information for an existing certification campaign by the campaign's ID. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -719,7 +696,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the campaign to be retrieved.
### Return type
[**Slimcampaign**](../models/slimcampaign)
### Responses
@@ -734,14 +710,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved.
# Get Campaign
try {
Get-BetaCampaign-BetaId $Id
@@ -752,11 +729,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-campaign-reports
Use this API to fetch all reports for a certification campaign by campaign ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports).
A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
@@ -768,7 +742,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the campaign whose reports are being fetched.
### Return type
[**CampaignReport[]**](../models/campaign-report)
### Responses
@@ -783,14 +756,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched.
# Get Campaign Reports
try {
Get-BetaCampaignReports-BetaId $Id
@@ -801,11 +775,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-campaign-reports-config
Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports-config).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -816,7 +787,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**CampaignReportsConfig**](../models/campaign-reports-config)
### Responses
@@ -830,13 +800,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# Get Campaign Reports Configuration
try {
Get-BetaCampaignReportsConfig
@@ -847,11 +818,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-campaign-template
Use this API to fetch a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -863,7 +831,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Requested campaign template's ID.
### Return type
[**CampaignTemplate**](../models/campaign-template)
### Responses
@@ -878,14 +845,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID.
# Get a Campaign Template
try {
Get-BetaCampaignTemplate-BetaId $Id
@@ -896,11 +864,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-campaign-template-schedule
Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template-schedule).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -912,7 +877,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the campaign template whose schedule is being fetched.
### Return type
[**Schedule**](../models/schedule)
### Responses
@@ -927,14 +891,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched.
# Get Campaign Template Schedule
try {
Get-BetaCampaignTemplateSchedule-BetaId $Id
@@ -945,11 +910,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-campaign-templates
Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/list-campaign-templates).
The endpoint returns all campaign templates matching the query parameters.
@@ -967,7 +929,6 @@ Param Type | Name | Data Type | Required | Description
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw*
### Return type
[**CampaignTemplate[]**](../models/campaign-template)
### Responses
@@ -981,7 +942,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -992,7 +952,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional)
$Filters = 'name eq "manager template"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional)
# List Campaign Templates
try {
Get-BetaCampaignTemplates
@@ -1003,11 +965,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## move
This API reassigns the specified certifications from one identity to another. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/move).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -1020,7 +979,6 @@ Path | Id | **String** | True | The certification campaign ID
Body | AdminReviewReassign | [**AdminReviewReassign**](../models/admin-review-reassign) | True |
### Return type
[**CertificationTask**](../models/certification-task)
### Responses
@@ -1035,7 +993,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -1050,7 +1007,9 @@ $AdminReviewReassign = @"{
"type" : "IDENTITY"
}
}"@
# Reassign Certifications
try {
$Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign
Move-Beta-BetaId $Id -BetaAdminReviewReassign $Result
@@ -1062,11 +1021,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-campaign-template
Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/patch-campaign-template).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -1079,7 +1035,6 @@ Path | Id | **String** | True | ID of the campaign template being modified.
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create)
### Return type
[**CampaignTemplate**](../models/campaign-template)
### Responses
@@ -1094,21 +1049,21 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified.
# JsonPatchOperation[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create)
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create)
# Update a Campaign Template
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-BetaCampaignTemplate-BetaId $Id -BetaJsonPatchOperation $Result
@@ -1120,11 +1075,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-campaign-reports-config
Use this API to overwrite the configuration for campaign reports. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-reports-config).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -1136,7 +1088,6 @@ Param Type | Name | Data Type | Required | Description
Body | CampaignReportsConfig | [**CampaignReportsConfig**](../models/campaign-reports-config) | True | Campaign report configuration.
### Return type
[**CampaignReportsConfig**](../models/campaign-reports-config)
### Responses
@@ -1150,7 +1101,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -1159,7 +1109,9 @@ Code | Description | Data Type
$CampaignReportsConfig = @"{
"identityAttributeColumns" : [ "firstname", "lastname" ]
}"@
# Set Campaign Reports Configuration
try {
$Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig
Set-BetaCampaignReportsConfig-BetaCampaignReportsConfig $Result
@@ -1171,11 +1123,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-campaign-template-schedule
Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one.
Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule).
@@ -1189,7 +1138,6 @@ Path | Id | **String** | True | ID of the campaign template being scheduled.
Body | Schedule | [**Schedule**](../models/schedule) | (optional) |
### Return type
(empty response body)
### Responses
@@ -1204,7 +1152,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -1231,7 +1178,9 @@ $Schedule = @"{
"expiration" : "2000-01-23T04:56:07.000+00:00",
"type" : "WEEKLY"
}"@
# Set Campaign Template Schedule
try {
Set-BetaCampaignTemplateSchedule-BetaId $Id
@@ -1242,11 +1191,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-campaign
Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -1259,7 +1205,6 @@ Path | Id | **String** | True | Campaign ID.
Body | ActivateCampaignOptions | [**ActivateCampaignOptions**](../models/activate-campaign-options) | (optional) | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format.
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -1274,7 +1219,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -1284,7 +1228,9 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID.
$ActivateCampaignOptions = @"{
"timeZone" : "-05:00"
}"@
# Activate a Campaign
try {
Start-BetaCampaign-BetaId $Id
@@ -1295,11 +1241,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-campaign-remediation-scan
Use this API to run a remediation scan task for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-remediation-scan).
A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
@@ -1311,7 +1254,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the campaign the remediation scan is being run for.
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -1326,14 +1268,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for.
# Run Campaign Remediation Scan
try {
Start-BetaCampaignRemediationScan-BetaId $Id
@@ -1344,11 +1287,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-campaign-report
Use this API to run a report for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-report).
A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
@@ -1361,7 +1301,6 @@ Path | Id | **String** | True | ID of the campaign the report is being run fo
Path | Type | [**ReportType**](../models/report-type) | True | Type of report to run.
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -1376,7 +1315,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -1384,7 +1322,9 @@ Code | Description | Data Type
```powershell
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for.
$Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of report to run.
# Run Campaign Report
try {
Start-BetaCampaignReport-BetaId $Id -BetaType $Type
@@ -1395,11 +1335,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-generate-campaign-template
Use this API to generate a new certification campaign from a campaign template.
The campaign object contained in the template has special formatting applied to its name and description
@@ -1423,7 +1360,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the campaign template to use for generation.
### Return type
[**CampaignReference**](../models/campaign-reference)
### Responses
@@ -1437,14 +1373,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation.
# Generate a Campaign from Template
try {
Start-BetaGenerateCampaignTemplate-BetaId $Id
@@ -1455,11 +1392,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-campaign
Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/update-campaign).
A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
@@ -1468,11 +1402,10 @@ A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | ID of the campaign template being modified.
Path | Id | **String** | True | ID of the campaign being modified.
Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | True | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline
### Return type
[**Slimcampaign**](../models/slimcampaign)
### Responses
@@ -1487,17 +1420,18 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template being modified.
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign being modified.
$RequestBody = # SystemCollectionsHashtable[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline
$RequestBody = @"[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]"@
$RequestBody = @"[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]"@ # SystemCollectionsHashtable[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline
# Update a Campaign
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Update-BetaCampaign-BetaId $Id -BetaRequestBody $Result
@@ -1509,7 +1443,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)