Skip to main content

CampaignFilterDetails

Campaign Filter Details

Properties

NameTypeDescriptionNotes
idstrThe unique ID of the campaign filter[required]
namestrCampaign filter name.[required]
descriptionstrCampaign filter description.[optional]
ownerstrOwner of the filter. This field automatically populates at creation time with the current user.[required]
modeEnum [ 'INCLUSION', 'EXCLUSION' ]Mode/type of filter, either the INCLUSION or EXCLUSION type. The INCLUSION type includes the data in generated campaigns as per specified in the criteria, whereas the EXCLUSION type excludes the data in generated campaigns as per specified in criteria.[required]
criteria_list[]CampaignFilterDetailsCriteriaListInnerList of criteria.[optional]
is_system_filterboolIf true, the filter is created by the system. If false, the filter is created by a user.[required][default to False]
}

Example

from sailpoint.v2024.models.campaign_filter_details import CampaignFilterDetails

campaign_filter_details = CampaignFilterDetails(
id='5ec18cef39020d6fd7a60ad3970aba61',
name='Identity Attribute Campaign Filter',
description='Campaign filter to certify data based on an identity attribute's specified property.',
owner='SailPoint Support',
mode=INCLUSION,
criteria_list=[{type=IDENTITY_ATTRIBUTE, property=displayName, value=support, operation=CONTAINS, negateResult=false, shortCircuit=false, recordChildMatches=false, id=null, suppressMatchedItems=false, children=null}],
is_system_filter=False
)

[Back to top]