LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 20:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to python SDK docs: 14250439109

Browse Source
This commit is contained in:
developer-relations-sp
2025-04-03 19:29:44 +00:00
parent 6180e96033
commit 3ad342a88c
22 changed files with 397 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md
View File

@@ -26,7 +26,7 @@ Name | Type | Description | Notes
from sailpoint.beta.models.account_usage import AccountUsage from sailpoint.beta.models.account_usage import AccountUsage
account_usage = AccountUsage( account_usage = AccountUsage(
var_date='Thu Apr 20 20:00:00 EDT 2023', var_date='Fri Apr 21 00:00:00 UTC 2023',
count=10 count=10
) )

2
docs/tools/sdk/python/Reference/Beta/Models/GetActiveCampaigns200ResponseInner.md
View File

@@ -25,7 +25,7 @@ Name | Type | Description | Notes
**auto_revoke_allowed** | **bool** | Allows auto revoke for this campaign | [optional] [default to False] **auto_revoke_allowed** | **bool** | Allows auto revoke for this campaign | [optional] [default to False]
**recommendations_enabled** | **bool** | 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] **recommendations_enabled** | **bool** | 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] **status** | **Enum** [ 'PENDING', 'STAGED', 'CANCELING', 'ACTIVATING', 'ACTIVE', 'COMPLETING', 'COMPLETED', 'ERROR', 'ARCHIVED' ] | The campaign's current status. | [optional] [readonly]
**correlated_status** | **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] **correlated_status** | **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** | **datetime** | Created time of the campaign | [optional] [readonly] **created** | **datetime** | Created time of the campaign | [optional] [readonly]
**total_certifications** | **int** | The total number of certifications in this campaign. | [optional] [readonly] **total_certifications** | **int** | The total number of certifications in this campaign. | [optional] [readonly]
**completed_certifications** | **int** | The number of completed certifications in this campaign. | [optional] [readonly] **completed_certifications** | **int** | The number of completed certifications in this campaign. | [optional] [readonly]

4
docs/tools/sdk/python/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md
View File

@@ -56,8 +56,8 @@ data={description=Auditing},
approval_status='APPROVED', approval_status='APPROVED',
comment='approved', comment='approved',
completion_date='2020-03-24T11:11:41.139-05:00', completion_date='2020-03-24T11:11:41.139-05:00',
start_date='Mon Mar 23 20:00:00 EDT 2020', start_date='Tue Mar 24 00:00:00 UTC 2020',
end_date='Wed Mar 24 20:00:00 EDT 2021', end_date='Thu Mar 25 00:00:00 UTC 2021',
modified='2020-03-24T11:11:41.139-05:00', modified='2020-03-24T11:11:41.139-05:00',
created='2020-03-24T11:11:41.139-05:00' created='2020-03-24T11:11:41.139-05:00'
) )

2
docs/tools/sdk/python/Reference/Beta/Models/SourceUsage.md
View File

@@ -26,7 +26,7 @@ Name | Type | Description | Notes
from sailpoint.beta.models.source_usage import SourceUsage from sailpoint.beta.models.source_usage import SourceUsage
source_usage = SourceUsage( source_usage = SourceUsage(
var_date='Thu Apr 20 20:00:00 EDT 2023', var_date='Fri Apr 21 00:00:00 UTC 2023',
count=10.45 count=10.45
) )

6
docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md
View File

@@ -789,12 +789,12 @@ Path | id | **str** | True | ID of the campaign to be retrieved.
Query | detail | **str** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. Query | detail | **str** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.
### Return type ### Return type
[**GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner) [**GetCampaign200Response**](../models/get-campaign200-response)
### Responses ### Responses
Code | Description | Data Type | Response headers | Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------| ------------- | ------------- | ------------- |------------------|
200 | Requested campaign object. | GetActiveCampaigns200ResponseInner | - | 200 | Requested campaign object. | GetCampaign200Response | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
@@ -811,7 +811,7 @@ Code | Description | Data Type | Response headers |
```python ```python
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner from sailpoint.v2024.models.get_campaign200_response import GetCampaign200Response
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()

2
docs/tools/sdk/python/Reference/V2024/Models/AccountUsage.md
View File

@@ -26,7 +26,7 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.account_usage import AccountUsage from sailpoint.v2024.models.account_usage import AccountUsage
account_usage = AccountUsage( account_usage = AccountUsage(
var_date='Thu Apr 20 20:00:00 EDT 2023', var_date='Fri Apr 21 00:00:00 UTC 2023',
count=10 count=10
) )

123
docs/tools/sdk/python/Reference/V2024/Models/GetCampaign200Response.md Normal file
View File

@@ -0,0 +1,123 @@
---
id: v2024-get-campaign200-response
title: GetCampaign200Response
pagination_label: GetCampaign200Response
sidebar_label: GetCampaign200Response
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'GetCampaign200Response', 'V2024GetCampaign200Response']
slug: /tools/sdk/python/v2024/models/get-campaign200-response
tags: ['SDK', 'Software Development Kit', 'GetCampaign200Response', 'V2024GetCampaign200Response']
---
# GetCampaign200Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Id of the campaign | [optional] [readonly]
**name** | **str** | 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** | **str** | 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** | **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]
**email_notification_enabled** | **bool** | Enables email notification for this campaign | [optional] [default to False]
**auto_revoke_allowed** | **bool** | Allows auto revoke for this campaign | [optional] [default to False]
**recommendations_enabled** | **bool** | 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]
**correlated_status** | **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** | **datetime** | Created time of the campaign | [optional] [readonly]
**total_certifications** | **int** | The total number of certifications in this campaign. | [optional] [readonly]
**completed_certifications** | **int** | The number of completed certifications in this campaign. | [optional] [readonly]
**alerts** | [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly]
**modified** | **datetime** | Modified time of the campaign | [optional] [readonly]
**filter** | [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional]
**sunset_comments_required** | **bool** | Determines if comments on sunset date changes are required. | [optional] [default to True]
**source_owner_campaign_info** | [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional]
**search_campaign_info** | [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional]
**role_composition_campaign_info** | [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional]
**machine_account_campaign_info** | [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional]
**sources_with_orphan_entitlements** | [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | 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]
**mandatory_comment_requirement** | **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]
}
## Example
```python
from sailpoint.v2024.models.get_campaign200_response import GetCampaign200Response
get_campaign200_response = GetCampaign200Response(
id='2c9079b270a266a60170a2779fcb0007',
name='Manager Campaign',
description='Everyone needs to be reviewed by their manager',
deadline='2020-03-15T10:00:01.456Z',
type='MANAGER',
email_notification_enabled=False,
auto_revoke_allowed=False,
recommendations_enabled=True,
status='ACTIVE',
correlated_status='CORRELATED',
created='2020-03-03T22:15:13.611Z',
total_certifications=100,
completed_certifications=10,
alerts=[
sailpoint.v2024.models.campaign_alert.CampaignAlert(
level = 'ERROR',
localizations = [
sailpoint.v2024.models.error_message_dto.ErrorMessageDto(
locale = 'en-US',
locale_origin = 'DEFAULT',
text = 'The request was syntactically correct but its content is semantically invalid.', )
], )
],
modified='2020-03-03T22:20:12.674Z',
filter=sailpoint.v2024.models.campaign_all_of_filter.Campaign_allOf_filter(
id = '0fbe863c063c4c88a35fd7f17e8a3df5',
type = 'CAMPAIGN_FILTER',
name = 'Test Filter', ),
sunset_comments_required=True,
source_owner_campaign_info=sailpoint.v2024.models.campaign_all_of_source_owner_campaign_info.Campaign_allOf_sourceOwnerCampaignInfo(
source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], ),
search_campaign_info=sailpoint.v2024.models.campaign_all_of_search_campaign_info.Campaign_allOf_searchCampaignInfo(
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', )
], ),
role_composition_campaign_info=sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info.Campaign_allOf_roleCompositionCampaignInfo(
reviewer_id = '2c91808568c529c60168cca6f90c1313',
reviewer = sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info_reviewer.Campaign_allOf_roleCompositionCampaignInfo_reviewer(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', ),
role_ids = [2c90ad2a70ace7d50170acf22ca90010],
remediator_ref = sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info_remediator_ref.Campaign_allOf_roleCompositionCampaignInfo_remediatorRef(
type = 'IDENTITY',
id = '2c90ad2a70ace7d50170acf22ca90010',
name = 'Role Admin', ),
query = 'Search Query',
description = 'Role Composition Description', ),
machine_account_campaign_info=sailpoint.v2024.models.campaign_all_of_machine_account_campaign_info.Campaign_allOf_machineAccountCampaignInfo(
source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5],
reviewer_type = 'ACCOUNT_OWNER', ),
sources_with_orphan_entitlements=[
sailpoint.v2024.models.campaign_all_of_sources_with_orphan_entitlements.Campaign_allOf_sourcesWithOrphanEntitlements(
id = '2c90ad2a70ace7d50170acf22ca90010',
type = 'SOURCE',
name = 'Source with orphan entitlements', )
],
mandatory_comment_requirement='NO_DECISIONS'
)
```
[[Back to top]](#)

4
docs/tools/sdk/python/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md
View File

@@ -56,8 +56,8 @@ data={description=Auditing},
approval_status='APPROVED', approval_status='APPROVED',
comment='approved', comment='approved',
completion_date='2020-03-24T11:11:41.139-05:00', completion_date='2020-03-24T11:11:41.139-05:00',
start_date='Mon Mar 23 20:00:00 EDT 2020', start_date='Tue Mar 24 00:00:00 UTC 2020',
end_date='Wed Mar 24 20:00:00 EDT 2021', end_date='Thu Mar 25 00:00:00 UTC 2021',
modified='2020-03-24T11:11:41.139-05:00', modified='2020-03-24T11:11:41.139-05:00',
created='2020-03-24T11:11:41.139-05:00' created='2020-03-24T11:11:41.139-05:00'
) )

2
docs/tools/sdk/python/Reference/V2024/Models/SourceUsage.md
View File

@@ -26,7 +26,7 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.source_usage import SourceUsage from sailpoint.v2024.models.source_usage import SourceUsage
source_usage = SourceUsage( source_usage = SourceUsage(
var_date='Thu Apr 20 20:00:00 EDT 2023', var_date='Fri Apr 21 00:00:00 UTC 2023',
count=10.45 count=10.45
) )

6
docs/tools/sdk/python/Reference/V2025/Methods/CertificationCampaignsApi.md
View File

@@ -789,12 +789,12 @@ Path | id | **str** | True | ID of the campaign to be retrieved.
Query | detail | **str** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. Query | detail | **str** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.
### Return type ### Return type
[**GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner) [**GetCampaign200Response**](../models/get-campaign200-response)
### Responses ### Responses
Code | Description | Data Type | Response headers | Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------| ------------- | ------------- | ------------- |------------------|
200 | Requested campaign object. | GetActiveCampaigns200ResponseInner | - | 200 | Requested campaign object. | GetCampaign200Response | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
@@ -811,7 +811,7 @@ Code | Description | Data Type | Response headers |
```python ```python
from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2025.api_client import ApiClient from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner from sailpoint.v2025.models.get_campaign200_response import GetCampaign200Response
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()

2
docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md
View File

@@ -26,7 +26,7 @@ Name | Type | Description | Notes
from sailpoint.v2025.models.account_usage import AccountUsage from sailpoint.v2025.models.account_usage import AccountUsage
account_usage = AccountUsage( account_usage = AccountUsage(
var_date='Thu Apr 20 20:00:00 EDT 2023', var_date='Fri Apr 21 00:00:00 UTC 2023',
count=10 count=10
) )

123
docs/tools/sdk/python/Reference/V2025/Models/GetCampaign200Response.md Normal file
View File

@@ -0,0 +1,123 @@
---
id: v2025-get-campaign200-response
title: GetCampaign200Response
pagination_label: GetCampaign200Response
sidebar_label: GetCampaign200Response
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'GetCampaign200Response', 'V2025GetCampaign200Response']
slug: /tools/sdk/python/v2025/models/get-campaign200-response
tags: ['SDK', 'Software Development Kit', 'GetCampaign200Response', 'V2025GetCampaign200Response']
---
# GetCampaign200Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Id of the campaign | [optional] [readonly]
**name** | **str** | 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** | **str** | 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** | **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]
**email_notification_enabled** | **bool** | Enables email notification for this campaign | [optional] [default to False]
**auto_revoke_allowed** | **bool** | Allows auto revoke for this campaign | [optional] [default to False]
**recommendations_enabled** | **bool** | 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]
**correlated_status** | **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** | **datetime** | Created time of the campaign | [optional] [readonly]
**total_certifications** | **int** | The total number of certifications in this campaign. | [optional] [readonly]
**completed_certifications** | **int** | The number of completed certifications in this campaign. | [optional] [readonly]
**alerts** | [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly]
**modified** | **datetime** | Modified time of the campaign | [optional] [readonly]
**filter** | [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional]
**sunset_comments_required** | **bool** | Determines if comments on sunset date changes are required. | [optional] [default to True]
**source_owner_campaign_info** | [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional]
**search_campaign_info** | [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional]
**role_composition_campaign_info** | [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional]
**machine_account_campaign_info** | [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional]
**sources_with_orphan_entitlements** | [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | 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]
**mandatory_comment_requirement** | **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]
}
## Example
```python
from sailpoint.v2025.models.get_campaign200_response import GetCampaign200Response
get_campaign200_response = GetCampaign200Response(
id='2c9079b270a266a60170a2779fcb0007',
name='Manager Campaign',
description='Everyone needs to be reviewed by their manager',
deadline='2020-03-15T10:00:01.456Z',
type='MANAGER',
email_notification_enabled=False,
auto_revoke_allowed=False,
recommendations_enabled=True,
status='ACTIVE',
correlated_status='CORRELATED',
created='2020-03-03T22:15:13.611Z',
total_certifications=100,
completed_certifications=10,
alerts=[
sailpoint.v2025.models.campaign_alert.CampaignAlert(
level = 'ERROR',
localizations = [
sailpoint.v2025.models.error_message_dto.ErrorMessageDto(
locale = 'en-US',
locale_origin = 'DEFAULT',
text = 'The request was syntactically correct but its content is semantically invalid.', )
], )
],
modified='2020-03-03T22:20:12.674Z',
filter=sailpoint.v2025.models.campaign_all_of_filter.Campaign_allOf_filter(
id = '0fbe863c063c4c88a35fd7f17e8a3df5',
type = 'CAMPAIGN_FILTER',
name = 'Test Filter', ),
sunset_comments_required=True,
source_owner_campaign_info=sailpoint.v2025.models.campaign_all_of_source_owner_campaign_info.Campaign_allOf_sourceOwnerCampaignInfo(
source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], ),
search_campaign_info=sailpoint.v2025.models.campaign_all_of_search_campaign_info.Campaign_allOf_searchCampaignInfo(
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', )
], ),
role_composition_campaign_info=sailpoint.v2025.models.campaign_all_of_role_composition_campaign_info.Campaign_allOf_roleCompositionCampaignInfo(
reviewer_id = '2c91808568c529c60168cca6f90c1313',
reviewer = sailpoint.v2025.models.campaign_all_of_role_composition_campaign_info_reviewer.Campaign_allOf_roleCompositionCampaignInfo_reviewer(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', ),
role_ids = [2c90ad2a70ace7d50170acf22ca90010],
remediator_ref = sailpoint.v2025.models.campaign_all_of_role_composition_campaign_info_remediator_ref.Campaign_allOf_roleCompositionCampaignInfo_remediatorRef(
type = 'IDENTITY',
id = '2c90ad2a70ace7d50170acf22ca90010',
name = 'Role Admin', ),
query = 'Search Query',
description = 'Role Composition Description', ),
machine_account_campaign_info=sailpoint.v2025.models.campaign_all_of_machine_account_campaign_info.Campaign_allOf_machineAccountCampaignInfo(
source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5],
reviewer_type = 'ACCOUNT_OWNER', ),
sources_with_orphan_entitlements=[
sailpoint.v2025.models.campaign_all_of_sources_with_orphan_entitlements.Campaign_allOf_sourcesWithOrphanEntitlements(
id = '2c90ad2a70ace7d50170acf22ca90010',
type = 'SOURCE',
name = 'Source with orphan entitlements', )
],
mandatory_comment_requirement='NO_DECISIONS'
)
```
[[Back to top]](#)

4
docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md
View File

@@ -56,8 +56,8 @@ data={description=Auditing},
approval_status='APPROVED', approval_status='APPROVED',
comment='approved', comment='approved',
completion_date='2020-03-24T11:11:41.139-05:00', completion_date='2020-03-24T11:11:41.139-05:00',
start_date='Mon Mar 23 20:00:00 EDT 2020', start_date='Tue Mar 24 00:00:00 UTC 2020',
end_date='Wed Mar 24 20:00:00 EDT 2021', end_date='Thu Mar 25 00:00:00 UTC 2021',
modified='2020-03-24T11:11:41.139-05:00', modified='2020-03-24T11:11:41.139-05:00',
created='2020-03-24T11:11:41.139-05:00' created='2020-03-24T11:11:41.139-05:00'
) )

2
docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md
View File

@@ -26,7 +26,7 @@ Name | Type | Description | Notes
from sailpoint.v2025.models.source_usage import SourceUsage from sailpoint.v2025.models.source_usage import SourceUsage
source_usage = SourceUsage( source_usage = SourceUsage(
var_date='Thu Apr 20 20:00:00 EDT 2023', var_date='Fri Apr 21 00:00:00 UTC 2023',
count=10.45 count=10.45
) )

6
docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignsApi.md
View File

@@ -787,12 +787,12 @@ Path | id | **str** | True | ID of the campaign to be retrieved.
Query | detail | **str** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. Query | detail | **str** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.
### Return type ### Return type
[**GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner) [**GetCampaign200Response**](../models/get-campaign200-response)
### Responses ### Responses
Code | Description | Data Type | Response headers | Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------| ------------- | ------------- | ------------- |------------------|
200 | Requested campaign object. | GetActiveCampaigns200ResponseInner | - | 200 | Requested campaign object. | GetCampaign200Response | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
@@ -809,7 +809,7 @@ Code | Description | Data Type | Response headers |
```python ```python
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner from sailpoint.v3.models.get_campaign200_response import GetCampaign200Response
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()

2
docs/tools/sdk/python/Reference/V3/Models/AccountUsage.md
View File

@@ -26,7 +26,7 @@ Name | Type | Description | Notes
from sailpoint.v3.models.account_usage import AccountUsage from sailpoint.v3.models.account_usage import AccountUsage
account_usage = AccountUsage( account_usage = AccountUsage(
var_date='Thu Apr 20 20:00:00 EDT 2023', var_date='Fri Apr 21 00:00:00 UTC 2023',
count=10 count=10
) )

122
docs/tools/sdk/python/Reference/V3/Models/GetCampaign200Response.md Normal file
View File

@@ -0,0 +1,122 @@
---
id: get-campaign200-response
title: GetCampaign200Response
pagination_label: GetCampaign200Response
sidebar_label: GetCampaign200Response
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'GetCampaign200Response', 'GetCampaign200Response']
slug: /tools/sdk/python/v3/models/get-campaign200-response
tags: ['SDK', 'Software Development Kit', 'GetCampaign200Response', 'GetCampaign200Response']
---
# GetCampaign200Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Id of the campaign | [optional] [readonly]
**name** | **str** | 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** | **str** | 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** | **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]
**email_notification_enabled** | **bool** | Enables email notification for this campaign | [optional] [default to False]
**auto_revoke_allowed** | **bool** | Allows auto revoke for this campaign | [optional] [default to False]
**recommendations_enabled** | **bool** | 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]
**correlated_status** | **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** | **datetime** | Created time of the campaign | [optional] [readonly]
**total_certifications** | **int** | The total number of certifications in this campaign. | [optional] [readonly]
**completed_certifications** | **int** | The number of completed certifications in this campaign. | [optional] [readonly]
**alerts** | [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly]
**modified** | **datetime** | Modified time of the campaign | [optional] [readonly]
**filter** | [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional]
**sunset_comments_required** | **bool** | Determines if comments on sunset date changes are required. | [optional] [default to True]
**source_owner_campaign_info** | [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional]
**search_campaign_info** | [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional]
**role_composition_campaign_info** | [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional]
**machine_account_campaign_info** | [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional]
**sources_with_orphan_entitlements** | [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | 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]
**mandatory_comment_requirement** | **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]
}
## Example
```python
from sailpoint.v3.models.get_campaign200_response import GetCampaign200Response
get_campaign200_response = GetCampaign200Response(
id='2c9079b270a266a60170a2779fcb0007',
name='Manager Campaign',
description='Everyone needs to be reviewed by their manager',
deadline='2020-03-15T10:00:01.456Z',
type='MANAGER',
email_notification_enabled=False,
auto_revoke_allowed=False,
recommendations_enabled=True,
status='ACTIVE',
correlated_status='CORRELATED',
created='2020-03-03T22:15:13.611Z',
total_certifications=100,
completed_certifications=10,
alerts=[
sailpoint.v3.models.campaign_alert.CampaignAlert(
level = 'ERROR',
localizations = [
sailpoint.v3.models.error_message_dto.ErrorMessageDto(
locale = 'en-US',
locale_origin = 'DEFAULT',
text = 'The request was syntactically correct but its content is semantically invalid.', )
], )
],
modified='2020-03-03T22:20:12.674Z',
filter=sailpoint.v3.models.campaign_all_of_filter.Campaign_allOf_filter(
id = '0fbe863c063c4c88a35fd7f17e8a3df5',
type = 'CAMPAIGN_FILTER',
name = 'Test Filter', ),
sunset_comments_required=True,
source_owner_campaign_info=sailpoint.v3.models.campaign_all_of_source_owner_campaign_info.Campaign_allOf_sourceOwnerCampaignInfo(
source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], ),
search_campaign_info=sailpoint.v3.models.campaign_all_of_search_campaign_info.Campaign_allOf_searchCampaignInfo(
type = 'ACCESS',
description = 'Search Campaign description',
reviewer = sailpoint.v3.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.v3.models.access_constraint.AccessConstraint(
type = 'ENTITLEMENT',
ids = [2c90ad2a70ace7d50170acf22ca90010],
operator = 'SELECTED', )
], ),
role_composition_campaign_info=sailpoint.v3.models.campaign_all_of_role_composition_campaign_info.Campaign_allOf_roleCompositionCampaignInfo(
reviewer = sailpoint.v3.models.campaign_all_of_search_campaign_info_reviewer.Campaign_allOf_searchCampaignInfo_reviewer(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', ),
role_ids = [2c90ad2a70ace7d50170acf22ca90010],
remediator_ref = sailpoint.v3.models.campaign_all_of_role_composition_campaign_info_remediator_ref.Campaign_allOf_roleCompositionCampaignInfo_remediatorRef(
type = 'IDENTITY',
id = '2c90ad2a70ace7d50170acf22ca90010',
name = 'Role Admin', ),
query = 'Search Query',
description = 'Role Composition Description', ),
machine_account_campaign_info=sailpoint.v3.models.campaign_all_of_machine_account_campaign_info.Campaign_allOf_machineAccountCampaignInfo(
source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5],
reviewer_type = 'ACCOUNT_OWNER', ),
sources_with_orphan_entitlements=[
sailpoint.v3.models.campaign_all_of_sources_with_orphan_entitlements.Campaign_allOf_sourcesWithOrphanEntitlements(
id = '2c90ad2a70ace7d50170acf22ca90010',
type = 'SOURCE',
name = 'Source with orphan entitlements', )
],
mandatory_comment_requirement='NO_DECISIONS'
)
```
[[Back to top]](#)

4
docs/tools/sdk/python/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md
View File

@@ -56,8 +56,8 @@ data={description=Auditing},
approval_status='APPROVED', approval_status='APPROVED',
comment='approved', comment='approved',
completion_date='2020-03-24T11:11:41.139-05:00', completion_date='2020-03-24T11:11:41.139-05:00',
start_date='Mon Mar 23 20:00:00 EDT 2020', start_date='Tue Mar 24 00:00:00 UTC 2020',
end_date='Wed Mar 24 20:00:00 EDT 2021', end_date='Thu Mar 25 00:00:00 UTC 2021',
modified='2020-03-24T11:11:41.139-05:00', modified='2020-03-24T11:11:41.139-05:00',
created='2020-03-24T11:11:41.139-05:00' created='2020-03-24T11:11:41.139-05:00'
) )

2
docs/tools/sdk/python/Reference/V3/Models/SourceUsage.md
View File

@@ -26,7 +26,7 @@ Name | Type | Description | Notes
from sailpoint.v3.models.source_usage import SourceUsage from sailpoint.v3.models.source_usage import SourceUsage
source_usage = SourceUsage( source_usage = SourceUsage(
var_date='Thu Apr 20 20:00:00 EDT 2023', var_date='Fri Apr 21 00:00:00 UTC 2023',
count=10.45 count=10.45
) )

2
static/code-examples/v2024/python_code_examples_overlay.yaml
View File

@@ -2990,7 +2990,7 @@
source: | source: |
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner from sailpoint.v2024.models.get_campaign200_response import GetCampaign200Response
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()

2
static/code-examples/v2025/python_code_examples_overlay.yaml
View File

@@ -2990,7 +2990,7 @@
source: | source: |
from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2025.api_client import ApiClient from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner from sailpoint.v2025.models.get_campaign200_response import GetCampaign200Response
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()

2
static/code-examples/v3/python_code_examples_overlay.yaml
View File

@@ -1927,7 +1927,7 @@
source: | source: |
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner from sailpoint.v3.models.get_campaign200_response import GetCampaign200Response
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()