developer.sailpoint.com/docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfSearchCampaignInfo.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-all-of-search-campaign-info	CampaignAllOfSearchCampaignInfo	CampaignAllOfSearchCampaignInfo	CampaignAllOfSearchCampaignInfo	pythonsdk	python Python sdk CampaignAllOfSearchCampaignInfo V2024CampaignAllOfSearchCampaignInfo	/tools/sdk/python/v2024/models/campaign-all-of-search-campaign-info	SDK Software Development Kit CampaignAllOfSearchCampaignInfo V2024CampaignAllOfSearchCampaignInfo

CampaignAllOfSearchCampaignInfo

Must be set only if the campaign type is SEARCH.

Properties

Name	Type	Description	Notes
type	Enum [ 'IDENTITY', 'ACCESS' ]	The type of search campaign represented.	[required]
description	str	Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available.	[optional]
reviewer	CampaignAllOfSearchCampaignInfoReviewer		[optional]
query	str	The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of query or identityIds must be set.	[optional]
identity_ids	[]str	A direct list of identities to include in this campaign. One of identityIds or query must be set.	[optional]
access_constraints	[]AccessConstraint	Further reduces the scope of the campaign by excluding identities (from query or identityIds) that do not have this access.	[optional]
}

Example

from sailpoint.v2024.models.campaign_all_of_search_campaign_info import CampaignAllOfSearchCampaignInfo

campaign_all_of_search_campaign_info = CampaignAllOfSearchCampaignInfo(
type='ACCESS',
description='Search Campaign description',
reviewer=sailpoint.v2024.models.campaign_all_of_search_campaign_info_reviewer.Campaign_allOf_searchCampaignInfo_reviewer(
                    type = 'IDENTITY', 
                    id = '2c91808568c529c60168cca6f90c1313', 
                    name = 'William Wilson', ),
query='Search Campaign query description',
identity_ids=[0fbe863c063c4c88a35fd7f17e8a3df5],
access_constraints=[
                    sailpoint.v2024.models.access_constraint.AccessConstraint(
                        type = 'ENTITLEMENT', 
                        ids = [2c90ad2a70ace7d50170acf22ca90010], 
                        operator = 'SELECTED', )
                    ]
)

[Back to top]