developer.sailpoint.com/docs/tools/sdk/powershell/Reference/V2024/Models/Campaign.md

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags

id	title	pagination_label	sidebar_label	sidebar_class_name	keywords	slug	tags
v2024-campaign	Campaign	Campaign	Campaign	powershellsdk	powershell PowerShell sdk Campaign V2024Campaign	/tools/sdk/powershell/v2024/models/campaign	SDK Software Development Kit Campaign V2024Campaign

Campaign

Properties

Name	Type	Description	Notes
Id	String	Id of the campaign	[optional] [readonly]
Name	String	The campaign name. If this object is part of a template, special formatting applies; see the /campaign-templates/{id}/generate endpoint documentation for details.	[required]
Description	String	The campaign description. If this object is part of a template, special formatting applies; see the /campaign-templates/{id}/generate endpoint documentation for details.	[required]
Deadline	System.DateTime	The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response.	[optional]
Type	Enum [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ]	The type of campaign. Could be extended in the future.	[required]
EmailNotificationEnabled	Boolean	Enables email notification for this campaign	[optional] [default to $false]
AutoRevokeAllowed	Boolean	Allows auto revoke for this campaign	[optional] [default to $false]
RecommendationsEnabled	Boolean	Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.	[optional] [default to $false]
Status	Enum [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ]	The campaign's current status.	[optional] [readonly]
CorrelatedStatus	Enum [ "CORRELATED", "UNCORRELATED" ]	The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).	[optional]
Created	System.DateTime	Created time of the campaign	[optional] [readonly]
TotalCertifications	Int32	The total number of certifications in this campaign.	[optional] [readonly]
CompletedCertifications	Int32	The number of completed certifications in this campaign.	[optional] [readonly]
Alerts	[]CampaignAlert	A list of errors and warnings that have accumulated.	[optional] [readonly]
Modified	System.DateTime	Modified time of the campaign	[optional] [readonly]
VarFilter	CampaignAllOfFilter		[optional]
SunsetCommentsRequired	Boolean	Determines if comments on sunset date changes are required.	[optional] [default to $true]
SourceOwnerCampaignInfo	CampaignAllOfSourceOwnerCampaignInfo		[optional]
SearchCampaignInfo	CampaignAllOfSearchCampaignInfo		[optional]
RoleCompositionCampaignInfo	CampaignAllOfRoleCompositionCampaignInfo		[optional]
MachineAccountCampaignInfo	CampaignAllOfMachineAccountCampaignInfo		[optional]
SourcesWithOrphanEntitlements	[]CampaignAllOfSourcesWithOrphanEntitlements	A list of sources in the campaign that contain ""orphan entitlements"" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented).	[optional] [readonly]
MandatoryCommentRequirement	Enum [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ]	Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.	[optional]

Examples

• Prepare the resource

$Campaign = Initialize-PSSailpoint.V2024Campaign  -Id 2c9079b270a266a60170a2779fcb0007 `
 -Name Manager Campaign `
 -Description Everyone needs to be reviewed by their manager `
 -Deadline 2020-03-15T10:00:01.456Z `
 -Type MANAGER `
 -EmailNotificationEnabled false `
 -AutoRevokeAllowed false `
 -RecommendationsEnabled true `
 -Status ACTIVE `
 -CorrelatedStatus CORRELATED `
 -Created 2020-03-03T22:15:13.611Z `
 -TotalCertifications 100 `
 -CompletedCertifications 10 `
 -Alerts null `
 -Modified 2020-03-03T22:20:12.674Z `
 -VarFilter null `
 -SunsetCommentsRequired true `
 -SourceOwnerCampaignInfo null `
 -SearchCampaignInfo null `
 -RoleCompositionCampaignInfo null `
 -MachineAccountCampaignInfo null `
 -SourcesWithOrphanEntitlements null `
 -MandatoryCommentRequirement NO_DECISIONS

• Convert the resource to JSON

$Campaign | ConvertTo-JSON

[Back to top]