mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 20:37:47 +00:00
add method and model docs for powershell and python v2025
This commit is contained in:
@@ -0,0 +1,52 @@
|
||||
---
|
||||
id: v2025-campaign-all-of-search-campaign-info
|
||||
title: CampaignAllOfSearchCampaignInfo
|
||||
pagination_label: CampaignAllOfSearchCampaignInfo
|
||||
sidebar_label: CampaignAllOfSearchCampaignInfo
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'CampaignAllOfSearchCampaignInfo', 'V2025CampaignAllOfSearchCampaignInfo']
|
||||
slug: /tools/sdk/python/v2025/models/campaign-all-of-search-campaign-info
|
||||
tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSearchCampaignInfo', 'V2025CampaignAllOfSearchCampaignInfo']
|
||||
---
|
||||
|
||||
# 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**](campaign-all-of-search-campaign-info-reviewer) | | [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**](access-constraint) | Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2025.models.campaign_all_of_search_campaign_info import CampaignAllOfSearchCampaignInfo
|
||||
|
||||
campaign_all_of_search_campaign_info = CampaignAllOfSearchCampaignInfo(
|
||||
type='ACCESS',
|
||||
description='Search Campaign description',
|
||||
reviewer=sailpoint.v2025.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.v2025.models.access_constraint.AccessConstraint(
|
||||
type = 'ENTITLEMENT',
|
||||
ids = [2c90ad2a70ace7d50170acf22ca90010],
|
||||
operator = 'SELECTED', )
|
||||
]
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
Reference in New Issue
Block a user