Skip to main content

CampaignReference

Properties

NameTypeDescriptionNotes
idstrThe unique ID of the campaign.[required]
namestrThe name of the campaign.[required]
typeEnum [ 'CAMPAIGN' ]The type of object that is being referenced.[required]
campaign_typeEnum [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH' ]The type of the campaign.[required]
descriptionstrThe description of the campaign set by the admin who created it.[required]
correlated_statusEnum [ '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).[required]
mandatory_comment_requirementEnum [ '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.[required]
}

Example

from sailpoint.beta.models.campaign_reference import CampaignReference

campaign_reference = CampaignReference(
id='ef38f94347e94562b5bb8424a56397d8',
name='Campaign Name',
type='CAMPAIGN',
campaign_type='MANAGER',
description='A description of the campaign',
correlated_status='CORRELATED',
mandatory_comment_requirement='NO_DECISIONS'
)

[Back to top]