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

merge changes from main and pull the latest from python docs

Browse Source
This commit is contained in:
darrell-thobe-sp
2025-03-10 11:34:32 -04:00
parent 6f7d1983fd 8c3bd4fe6f
commit 340c9bb8cd
3122 changed files with 95404 additions and 24060 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -19,8 +19,7 @@ Name | Type | Description | Notes
**id** | **str** | The unique ID of the referenced object. | [optional]
**name** | **str** | The human readable name of the referenced object. | [optional]
**display_name** | **str** | | [optional]
**type** | [**DtoType**](dto-type) | | [optional]
**description** | **str** | | [optional]
**description** | **str** | Description of access item. | [optional]
}
## Example
@@ -32,7 +31,6 @@ access = Access(
id='2c91808568c529c60168cca6f90c1313',
name='John Doe',
display_name='John Q. Doe',
type='IDENTITY',
description=''
)

43
docs/tools/sdk/python/Reference/V2024/Models/AccessApps.md Normal file
View File

@@ -0,0 +1,43 @@
---
id: v2024-access-apps
title: AccessApps
pagination_label: AccessApps
sidebar_label: AccessApps
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessApps', 'V2024AccessApps']
slug: /tools/sdk/python/v2024/models/access-apps
tags: ['SDK', 'Software Development Kit', 'AccessApps', 'V2024AccessApps']
---
# AccessApps
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique ID of the referenced object. | [optional]
**name** | **str** | Name of application | [optional]
**description** | **str** | Description of application. | [optional]
**owner** | [**AccessAppsOwner**](access-apps-owner) | | [optional]
}
## Example
```python
from sailpoint.v2024.models.access_apps import AccessApps
access_apps = AccessApps(
id='2c91808568c529c60168cca6f90c1313',
name='Travel and Expense',
description='Travel and Expense Application',
owner=sailpoint.v2024.models.access_apps_owner.AccessApps_owner(
type = 'IDENTITY',
id = '2c9180a46faadee4016fb4e018c20639',
name = 'John Doe',
email = 'john.doe@sailpoint.com', )
)
```
[[Back to top]](#)

40
docs/tools/sdk/python/Reference/V2024/Models/AccessAppsOwner.md Normal file
View File

@@ -0,0 +1,40 @@
---
id: v2024-access-apps-owner
title: AccessAppsOwner
pagination_label: AccessAppsOwner
sidebar_label: AccessAppsOwner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessAppsOwner', 'V2024AccessAppsOwner']
slug: /tools/sdk/python/v2024/models/access-apps-owner
tags: ['SDK', 'Software Development Kit', 'AccessAppsOwner', 'V2024AccessAppsOwner']
---
# AccessAppsOwner
Owner's identity.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | Owner's DTO type. | [optional]
**id** | **str** | Owner's identity ID. | [optional]
**name** | **str** | Owner's display name. | [optional]
**email** | **str** | Owner's email. | [optional]
}
## Example
```python
from sailpoint.v2024.models.access_apps_owner import AccessAppsOwner
access_apps_owner = AccessAppsOwner(
type='IDENTITY',
id='2c9180a46faadee4016fb4e018c20639',
name='John Doe',
email='john.doe@sailpoint.com'
)
```
[[Back to top]](#)

55
docs/tools/sdk/python/Reference/V2024/Models/AccessModelMetadata.md Normal file
View File

@@ -0,0 +1,55 @@
---
id: v2024-access-model-metadata
title: AccessModelMetadata
pagination_label: AccessModelMetadata
sidebar_label: AccessModelMetadata
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessModelMetadata', 'V2024AccessModelMetadata']
slug: /tools/sdk/python/v2024/models/access-model-metadata
tags: ['SDK', 'Software Development Kit', 'AccessModelMetadata', 'V2024AccessModelMetadata']
---
# AccessModelMetadata
Metadata that describes an access item
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**key** | **str** | Unique identifier for the metadata type | [optional]
**name** | **str** | Human readable name of the metadata type | [optional]
**multiselect** | **bool** | Allows selecting multiple values | [optional] [default to False]
**status** | **str** | The state of the metadata item | [optional]
**type** | **str** | The type of the metadata item | [optional]
**object_types** | **[]str** | The types of objects | [optional]
**description** | **str** | Describes the metadata item | [optional]
**values** | [**[]AccessModelMetadataValuesInner**](access-model-metadata-values-inner) | The value to assign to the metadata item | [optional]
}
## Example
```python
from sailpoint.v2024.models.access_model_metadata import AccessModelMetadata
access_model_metadata = AccessModelMetadata(
key='iscCsp',
name='CSP',
multiselect=True,
status='active',
type='governance',
object_types=[
'general'
],
description='Indicates the type of deployment environment of an access item.',
values=[
sailpoint.v2024.models.access_model_metadata_values_inner.AccessModelMetadata_values_inner(
value = 'development',
name = 'Development',
status = 'active', )
]
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/V2024/Models/AccessModelMetadataValuesInner.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: v2024-access-model-metadata-values-inner
title: AccessModelMetadataValuesInner
pagination_label: AccessModelMetadataValuesInner
sidebar_label: AccessModelMetadataValuesInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessModelMetadataValuesInner', 'V2024AccessModelMetadataValuesInner']
slug: /tools/sdk/python/v2024/models/access-model-metadata-values-inner
tags: ['SDK', 'Software Development Kit', 'AccessModelMetadataValuesInner', 'V2024AccessModelMetadataValuesInner']
---
# AccessModelMetadataValuesInner
An individual value to assign to the metadata item
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | **str** | The value to assign to the metdata item | [optional]
**name** | **str** | Display name of the value | [optional]
**status** | **str** | The status of the individual value | [optional]
}
## Example
```python
from sailpoint.v2024.models.access_model_metadata_values_inner import AccessModelMetadataValuesInner
access_model_metadata_values_inner = AccessModelMetadataValuesInner(
value='development',
name='Development',
status='active'
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/V2024/Models/AccessProfileDocument.md
View File

@@ -17,8 +17,6 @@ More complete representation of an access profile.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Access profile's ID. | [required]
**name** | **str** | Access profile's name. | [required]
**description** | **str** | Access item's description. | [optional]
**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**modified** | **datetime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
@@ -26,12 +24,16 @@ Name | Type | Description | Notes
**enabled** | **bool** | Indicates whether the access item is currently enabled. | [optional] [default to False]
**requestable** | **bool** | Indicates whether the access item can be requested. | [optional] [default to True]
**request_comments_required** | **bool** | Indicates whether comments are required for requests to access the item. | [optional] [default to False]
**owner** | [**BaseAccessAllOfOwner**](base-access-all-of-owner) | | [optional]
**type** | **Enum** [ 'accessprofile', 'accountactivity', 'account', 'aggregation', 'entitlement', 'event', 'identity', 'role' ] | Access profile's document type. This enum represents the currently supported document types. Additional values may be added in the future without notice. | [required]
**owner** | [**BaseAccessOwner**](base-access-owner) | | [optional]
**id** | **str** | Access profile's ID. | [required]
**name** | **str** | Access profile's name. | [required]
**source** | [**AccessProfileDocumentAllOfSource**](access-profile-document-all-of-source) | | [optional]
**entitlements** | [**[]BaseEntitlement**](base-entitlement) | Entitlements the access profile has access to. | [optional]
**entitlement_count** | **int** | Number of entitlements. | [optional]
**segments** | [**[]BaseSegment**](base-segment) | Segments with the access profile. | [optional]
**segment_count** | **int** | Number of segments with the access profile. | [optional]
**tags** | **[]str** | Tags that have been applied to the object. | [optional]
**apps** | [**[]AccessApps**](access-apps) | Applications with the access profile | [optional]
}
## Example
@@ -40,21 +42,20 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.access_profile_document import AccessProfileDocument
access_profile_document = AccessProfileDocument(
id='2c9180825a6c1adc015a71c9023f0818',
name='Cloud Eng',
description='The admin role',
description='Admin access',
created='2018-06-25T20:22:28.104Z',
modified='2018-06-25T20:22:28.104Z',
synced='2018-06-25T20:22:33.104Z',
enabled=True,
requestable=True,
request_comments_required=False,
owner=sailpoint.v2024.models.base_access_all_of_owner.BaseAccess_allOf_owner(
owner=sailpoint.v2024.models.base_access_owner.BaseAccess_owner(
type = 'IDENTITY',
id = '2c9180a46faadee4016fb4e018c20639',
name = 'Support',
email = 'cloud-support@sailpoint.com', ),
type='accessprofile',
id='2c9180825a6c1adc015a71c9023f0818',
name='Cloud Eng',
source=sailpoint.v2024.models.access_profile_document_all_of_source.AccessProfileDocument_allOf_source(
id = 'ff8081815757d4fb0157588f3d9d008f',
name = 'Employees', ),
@@ -70,7 +71,24 @@ entitlements=[
name = 'CN=Cloud Engineering,DC=sailpoint,DC=COM', )
],
entitlement_count=5,
tags=[TAG_1, TAG_2]
segments=[
sailpoint.v2024.models.base_segment.BaseSegment(
id = 'b009b6e3-b56d-41d9-8735-cb532ea0b017',
name = 'Test Segment', )
],
segment_count=1,
tags=[TAG_1, TAG_2],
apps=[
sailpoint.v2024.models.access_apps.AccessApps(
id = '2c91808568c529c60168cca6f90c1313',
name = 'Travel and Expense',
description = 'Travel and Expense Application',
owner = sailpoint.v2024.models.access_apps_owner.AccessApps_owner(
type = 'IDENTITY',
id = '2c9180a46faadee4016fb4e018c20639',
name = 'John Doe',
email = 'john.doe@sailpoint.com', ), )
]
)
```

6
docs/tools/sdk/python/Reference/V2024/Models/AccessProfileEntitlement.md
View File

@@ -20,9 +20,9 @@ Name | Type | Description | Notes
**id** | **str** | The unique ID of the referenced object. | [optional]
**name** | **str** | The human readable name of the referenced object. | [optional]
**display_name** | **str** | | [optional]
**type** | [**DtoType**](dto-type) | | [optional]
**description** | **str** | | [optional]
**description** | **str** | Description of access item. | [optional]
**source** | [**Reference**](reference) | | [optional]
**type** | **str** | Type of the access item. | [optional]
**privileged** | **bool** | | [optional]
**attribute** | **str** | | [optional]
**value** | **str** | | [optional]
@@ -38,11 +38,11 @@ access_profile_entitlement = AccessProfileEntitlement(
id='2c91808568c529c60168cca6f90c1313',
name='John Doe',
display_name='John Q. Doe',
type='IDENTITY',
description='',
source=sailpoint.v2024.models.reference.Reference(
id = '2c91808568c529c60168cca6f90c1313',
name = 'John Doe', ),
type='ENTITLEMENT',
privileged=False,
attribute='memberOf',
value='CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com',

6
docs/tools/sdk/python/Reference/V2024/Models/AccessProfileRole.md
View File

@@ -20,8 +20,8 @@ Name | Type | Description | Notes
**id** | **str** | The unique ID of the referenced object. | [optional]
**name** | **str** | The human readable name of the referenced object. | [optional]
**display_name** | **str** | | [optional]
**type** | [**DtoType**](dto-type) | | [optional]
**description** | **str** | | [optional]
**description** | **str** | Description of access item. | [optional]
**type** | **str** | Type of the access item. | [optional]
**owner** | [**DisplayReference**](display-reference) | | [optional]
**disabled** | **bool** | | [optional]
**revocable** | **bool** | | [optional]
@@ -36,8 +36,8 @@ access_profile_role = AccessProfileRole(
id='2c91808568c529c60168cca6f90c1313',
name='John Doe',
display_name='John Q. Doe',
type='IDENTITY',
description='',
type='ROLE',
owner=,
disabled=True,
revocable=True

6
docs/tools/sdk/python/Reference/V2024/Models/AccessProfileSummary.md
View File

@@ -20,8 +20,8 @@ Name | Type | Description | Notes
**id** | **str** | The unique ID of the referenced object. | [optional]
**name** | **str** | The human readable name of the referenced object. | [optional]
**display_name** | **str** | | [optional]
**type** | [**DtoType**](dto-type) | | [optional]
**description** | **str** | | [optional]
**description** | **str** | Description of access item. | [optional]
**type** | **str** | Type of the access item. | [optional]
**source** | [**Reference**](reference) | | [optional]
**owner** | [**DisplayReference**](display-reference) | | [optional]
**revocable** | **bool** | | [optional]
@@ -36,8 +36,8 @@ access_profile_summary = AccessProfileSummary(
id='2c91808568c529c60168cca6f90c1313',
name='John Doe',
display_name='John Q. Doe',
type='IDENTITY',
description='',
type='ACCESS_PROFILE',
source=sailpoint.v2024.models.reference.Reference(
id = '2c91808568c529c60168cca6f90c1313',
name = 'John Doe', ),

20
docs/tools/sdk/python/Reference/V2024/Models/AccessRequestAdminItemStatus.md
View File

@@ -16,13 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestAdminItemStatus', 'V2024
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | ID of the access request. This is a new property as of 2025. Older access requests may not have an ID. | [optional]
**name** | **str** | Human-readable display name of the item being requested. | [optional]
**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | Type of requested object. | [optional]
**cancelled_request_details** | [**AccessRequestAdminItemStatusCancelledRequestDetails**](access-request-admin-item-status-cancelled-request-details) | | [optional]
**error_messages** | [**[]List[ErrorMessageDto1]**](error-message-dto) | List of localized error messages, if any, encountered during the approval/provisioning process. | [optional]
**cancelled_request_details** | [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional]
**error_messages** | [**[]List[ErrorMessageDto]**](error-message-dto) | List of localized error messages, if any, encountered during the approval/provisioning process. | [optional]
**state** | [**RequestedItemStatusRequestState**](requested-item-status-request-state) | | [optional]
**approval_details** | [**[]ApprovalStatusDto1**](approval-status-dto1) | Approval details for each item. | [optional]
**manual_work_item_details** | [**[]ManualWorkItemDetails1**](manual-work-item-details1) | Manual work items created for provisioning the item. | [optional]
**approval_details** | [**[]ApprovalStatusDto**](approval-status-dto) | Approval details for each item. | [optional]
**manual_work_item_details** | [**[]ManualWorkItemDetails**](manual-work-item-details) | Manual work items created for provisioning the item. | [optional]
**account_activity_item_id** | **str** | Id of associated account activity item. | [optional]
**request_type** | [**AccessRequestType**](access-request-type) | | [optional]
**modified** | **datetime** | When the request was last modified. | [optional]
@@ -30,7 +31,7 @@ Name | Type | Description | Notes
**requester** | [**AccessItemRequester**](access-item-requester) | | [optional]
**requested_for** | [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional]
**requester_comment** | [**RequestedItemStatusRequesterComment**](requested-item-status-requester-comment) | | [optional]
**sod_violation_context** | [**AccessRequestAdminItemStatusSodViolationContext**](access-request-admin-item-status-sod-violation-context) | | [optional]
**sod_violation_context** | [**RequestedItemStatusSodViolationContext**](requested-item-status-sod-violation-context) | | [optional]
**provisioning_details** | [**RequestedItemStatusProvisioningDetails**](requested-item-status-provisioning-details) | | [optional]
**pre_approval_trigger_details** | [**RequestedItemStatusPreApprovalTriggerDetails**](requested-item-status-pre-approval-trigger-details) | | [optional]
**access_request_phases** | [**[]AccessRequestPhases**](access-request-phases) | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [optional]
@@ -48,6 +49,7 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.access_request_admin_item_status import AccessRequestAdminItemStatus
access_request_admin_item_status = AccessRequestAdminItemStatus(
id='2c9180926cbfbddd016cbfc7c3b10010',
name='AccessProfile1',
type='ACCESS_PROFILE',
cancelled_request_details=,
@@ -56,7 +58,7 @@ error_messages=[
],
state='EXECUTING',
approval_details=[
sailpoint.v2024.models.approval_status_dto_1.ApprovalStatusDto_1(
sailpoint.v2024.models.approval_status_dto.ApprovalStatusDto(
forwarded = False,
original_owner = sailpoint.v2024.models.approval_status_dto_original_owner.ApprovalStatusDto_originalOwner(
type = 'IDENTITY',
@@ -67,7 +69,7 @@ approval_details=[
status = 'PENDING',
scheme = 'MANAGER',
error_messages = [
sailpoint.v2024.models.error_message_dto_1.ErrorMessageDto_1(
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.', )
@@ -76,7 +78,7 @@ approval_details=[
remove_date = '2020-07-11T00:00Z', )
],
manual_work_item_details=[
sailpoint.v2024.models.manual_work_item_details_1.ManualWorkItemDetails_1(
sailpoint.v2024.models.manual_work_item_details.ManualWorkItemDetails(
forwarded = True,
original_owner = sailpoint.v2024.models.manual_work_item_details_original_owner.ManualWorkItemDetails_originalOwner(
type = 'IDENTITY',
@@ -89,7 +91,7 @@ manual_work_item_details=[
modified = '2019-08-23T18:52:57.398Z',
status = 'PENDING',
forward_history = [
sailpoint.v2024.models.approval_forward_history_1.ApprovalForwardHistory_1(
sailpoint.v2024.models.approval_forward_history.ApprovalForwardHistory(
old_approver_name = 'Frank Mir',
new_approver_name = 'Al Volta',
comment = 'Forwarding from Frank to Al',

40
docs/tools/sdk/python/Reference/V2024/Models/AccessRequestAdminItemStatusCancelledRequestDetails.md
View File

@@ -1,40 +0,0 @@
---
id: v2024-access-request-admin-item-status-cancelled-request-details
title: AccessRequestAdminItemStatusCancelledRequestDetails
pagination_label: AccessRequestAdminItemStatusCancelledRequestDetails
sidebar_label: AccessRequestAdminItemStatusCancelledRequestDetails
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestAdminItemStatusCancelledRequestDetails', 'V2024AccessRequestAdminItemStatusCancelledRequestDetails']
slug: /tools/sdk/python/v2024/models/access-request-admin-item-status-cancelled-request-details
tags: ['SDK', 'Software Development Kit', 'AccessRequestAdminItemStatusCancelledRequestDetails', 'V2024AccessRequestAdminItemStatusCancelledRequestDetails']
---
# AccessRequestAdminItemStatusCancelledRequestDetails
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**comment** | **str** | Comment made by the owner when cancelling the associated request. | [optional]
**owner** | [**OwnerDto**](owner-dto) | | [optional]
**modified** | **datetime** | Date comment was added by the owner when cancelling the associated request. | [optional]
}
## Example
```python
from sailpoint.v2024.models.access_request_admin_item_status_cancelled_request_details import AccessRequestAdminItemStatusCancelledRequestDetails
access_request_admin_item_status_cancelled_request_details = AccessRequestAdminItemStatusCancelledRequestDetails(
comment='This request must be cancelled.',
owner=sailpoint.v2024.models.owner_dto.OwnerDto(
type = 'IDENTITY',
id = '2c9180a46faadee4016fb4e018c20639',
name = 'Support', ),
modified='2019-12-20T09:17:12.192Z'
)
```
[[Back to top]](#)

64
docs/tools/sdk/python/Reference/V2024/Models/AccessRequestAdminItemStatusSodViolationContext.md
View File

@@ -1,64 +0,0 @@
---
id: v2024-access-request-admin-item-status-sod-violation-context
title: AccessRequestAdminItemStatusSodViolationContext
pagination_label: AccessRequestAdminItemStatusSodViolationContext
sidebar_label: AccessRequestAdminItemStatusSodViolationContext
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestAdminItemStatusSodViolationContext', 'V2024AccessRequestAdminItemStatusSodViolationContext']
slug: /tools/sdk/python/v2024/models/access-request-admin-item-status-sod-violation-context
tags: ['SDK', 'Software Development Kit', 'AccessRequestAdminItemStatusSodViolationContext', 'V2024AccessRequestAdminItemStatusSodViolationContext']
---
# AccessRequestAdminItemStatusSodViolationContext
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**state** | **Enum** [ 'SUCCESS', 'ERROR' ] | The status of SOD violation check | [optional]
**uuid** | **str** | The id of the Violation check event | [optional]
**violation_check_result** | [**SodViolationCheckResult1**](sod-violation-check-result1) | | [optional]
}
## Example
```python
from sailpoint.v2024.models.access_request_admin_item_status_sod_violation_context import AccessRequestAdminItemStatusSodViolationContext
access_request_admin_item_status_sod_violation_context = AccessRequestAdminItemStatusSodViolationContext(
state='SUCCESS',
uuid='f73d16e9-a038-46c5-b217-1246e15fdbdd',
violation_check_result=sailpoint.v2024.models.sod_violation_check_result_1.SodViolationCheckResult_1(
message = sailpoint.v2024.models.error_message_dto_1.ErrorMessageDto_1(
locale = 'en-US',
locale_origin = 'DEFAULT',
text = 'The request was syntactically correct but its content is semantically invalid.', ),
client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1},
violation_contexts = [
sailpoint.v2024.models.sod_violation_context_1.SodViolationContext_1(
policy = sailpoint.v2024.models.sod_policy_dto.SodPolicyDto(
type = 'SOD_POLICY',
id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde',
name = 'Business SOD Policy', ),
conflicting_access_criteria = sailpoint.v2024.models.sod_violation_context_1_conflicting_access_criteria.SodViolationContext_1_conflictingAccessCriteria(
left_criteria = sailpoint.v2024.models.sod_violation_context_1_conflicting_access_criteria_left_criteria.SodViolationContext_1_conflictingAccessCriteria_leftCriteria(
criteria_list = [
sailpoint.v2024.models.sod_exempt_criteria_1.SodExemptCriteria_1(
existing = True,
type = 'IDENTITY',
id = '2c918085771e9d3301773b3cb66f6398',
name = 'My HR Entitlement', )
], ),
right_criteria = sailpoint.v2024.models.sod_violation_context_1_conflicting_access_criteria_left_criteria.SodViolationContext_1_conflictingAccessCriteria_leftCriteria(), ), )
],
violated_policies = [
sailpoint.v2024.models.sod_policy_dto.SodPolicyDto(
id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde',
name = 'Business SOD Policy', )
], )
)
```
[[Back to top]](#)

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

@@ -21,7 +21,7 @@ Name | Type | Description | Notes
**reauthorization_enabled** | **bool** | If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. | [optional] [default to False]
**request_on_behalf_of_config** | [**RequestOnBehalfOfConfig**](request-on-behalf-of-config) | | [optional]
**approval_reminder_and_escalation_config** | [**ApprovalReminderAndEscalationConfig**](approval-reminder-and-escalation-config) | | [optional]
**entitlement_request_config** | [**EntitlementRequestConfig1**](entitlement-request-config1) | | [optional]
**entitlement_request_config** | [**EntitlementRequestConfig**](entitlement-request-config) | | [optional]
}
## Example
@@ -45,7 +45,7 @@ approval_reminder_and_escalation_config=sailpoint.v2024.models.approval_reminder
id = '5168015d32f890ca15812c9180835d2e',
name = 'Alison Ferguso',
email = 'alison.ferguso@identitysoon.com', ), ),
entitlement_request_config=sailpoint.v2024.models.entitlement_request_config_1.EntitlementRequestConfig_1(
entitlement_request_config=sailpoint.v2024.models.entitlement_request_config.EntitlementRequestConfig(
allow_entitlement_request = True,
request_comments_required = False,
denied_comments_required = False,

43
docs/tools/sdk/python/Reference/V2024/Models/AccessRequestRecommendationConfigDto.md Normal file
View File

@@ -0,0 +1,43 @@
---
id: v2024-access-request-recommendation-config-dto
title: AccessRequestRecommendationConfigDto
pagination_label: AccessRequestRecommendationConfigDto
sidebar_label: AccessRequestRecommendationConfigDto
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestRecommendationConfigDto', 'V2024AccessRequestRecommendationConfigDto']
slug: /tools/sdk/python/v2024/models/access-request-recommendation-config-dto
tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationConfigDto', 'V2024AccessRequestRecommendationConfigDto']
---
# AccessRequestRecommendationConfigDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**score_threshold** | **float** | The value that internal calculations need to exceed for recommendations to be made. | [required]
**start_date_attribute** | **str** | Use to map an attribute name for determining identities' start date. | [optional]
**restriction_attribute** | **str** | Use to only give recommendations based on this attribute. | [optional]
**mover_attribute** | **str** | Use to map an attribute name for determining whether identities are movers. | [optional]
**joiner_attribute** | **str** | Use to map an attribute name for determining whether identities are joiners. | [optional]
**use_restriction_attribute** | **bool** | Use only the attribute named in restrictionAttribute to make recommendations. | [optional] [default to False]
}
## Example
```python
from sailpoint.v2024.models.access_request_recommendation_config_dto import AccessRequestRecommendationConfigDto
access_request_recommendation_config_dto = AccessRequestRecommendationConfigDto(
score_threshold=0.5,
start_date_attribute='startDate',
restriction_attribute='location',
mover_attribute='isMover',
joiner_attribute='isJoiner',
use_restriction_attribute=True
)
```
[[Back to top]](#)

29
docs/tools/sdk/python/Reference/V2024/Models/Account.md
View File

@@ -27,7 +27,7 @@ Name | Type | Description | Notes
**identity_state** | **str** | The identity state of the identity this account is correlated to | [optional]
**connection_type** | **str** | The connection type of the source this account is from | [optional]
**is_machine** | **bool** | Indicates if the account is of machine type | [optional] [default to False]
**recommendation** | [**Recommendation**](recommendation) | | [optional]
**recommendation** | [**AccountAllOfRecommendation**](account-all-of-recommendation) | | [optional]
**attributes** | **map[string]object** | The account attributes that are aggregated | [required]
**authoritative** | **bool** | Indicates if this account is from an authoritative source | [required]
**description** | **str** | A description of the account | [optional]
@@ -39,11 +39,11 @@ Name | Type | Description | Notes
**uuid** | **str** | The unique ID of the account as determined by the account schema | [optional]
**manually_correlated** | **bool** | Indicates if the account has been manually correlated to an identity | [required]
**has_entitlements** | **bool** | Indicates if the account has entitlements | [required]
**identity** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
**source_owner** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
**identity** | [**AccountAllOfIdentity**](account-all-of-identity) | | [optional]
**source_owner** | [**AccountAllOfSourceOwner**](account-all-of-source-owner) | | [optional]
**features** | **str** | A string list containing the owning source's features | [optional]
**origin** | **Enum** [ 'AGGREGATED', 'PROVISIONED' ] | The origin of the account either aggregated or provisioned | [optional]
**owner_identity** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
**owner_identity** | [**AccountAllOfOwnerIdentity**](account-all-of-owner-identity) | | [optional]
}
## Example
@@ -63,9 +63,7 @@ cloud_lifecycle_state='active',
identity_state='ACTIVE',
connection_type='direct',
is_machine=True,
recommendation=sailpoint.v2024.models.recommendation.Recommendation(
type = 'MACHINE',
method = 'DISCOVERY', ),
recommendation=,
attributes={firstName=SailPoint, lastName=Support, displayName=SailPoint Support},
authoritative=False,
description='',
@@ -77,20 +75,17 @@ uncorrelated=False,
uuid='{b0dce506-d6d4-44d2-8a32-d9a5b21fb175}',
manually_correlated=False,
has_entitlements=True,
identity=sailpoint.v2024.models.base_reference_dto.BaseReferenceDto(
identity=sailpoint.v2024.models.account_all_of_identity.Account_allOf_identity(
id = '2c918084660f45d6016617daa9210584',
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', ),
source_owner=sailpoint.v2024.models.base_reference_dto.BaseReferenceDto(
name = 'John Doe', ),
source_owner=sailpoint.v2024.models.account_all_of_source_owner.Account_allOf_sourceOwner(
id = '2c918084660f45d6016617daa9210584',
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', ),
name = 'Adam Kennedy', ),
features='ENABLE',
origin='AGGREGATED',
owner_identity=sailpoint.v2024.models.base_reference_dto.BaseReferenceDto(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', )
owner_identity=
)
```

41
docs/tools/sdk/python/Reference/V2024/Models/AccountActivityDocument.md
View File

@@ -17,17 +17,15 @@ AccountActivity
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | | [required]
**name** | **str** | | [required]
**type** | [**DocumentType**](document-type) | | [required]
**id** | **str** | ID of account activity. | [optional]
**action** | **str** | Type of action performed in the activity. | [optional]
**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**modified** | **datetime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
**synced** | **str** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional]
**stage** | **str** | Activity's current stage. | [optional]
**origin** | **str** | Activity's origin. | [optional]
**status** | **str** | Activity's current status. | [optional]
**requester** | [**AccountSource**](account-source) | | [optional]
**recipient** | [**AccountSource**](account-source) | | [optional]
**requester** | [**ActivityIdentity**](activity-identity) | | [optional]
**recipient** | [**ActivityIdentity**](activity-identity) | | [optional]
**tracking_number** | **str** | Account activity's tracking number. | [optional]
**errors** | **[]str** | Errors provided by the source while completing account actions. | [optional]
**warnings** | **[]str** | Warnings provided by the source while completing account actions. | [optional]
@@ -45,13 +43,11 @@ from sailpoint.v2024.models.account_activity_document import AccountActivityDocu
account_activity_document = AccountActivityDocument(
id='2c91808375d8e80a0175e1f88a575222',
name='john.doe',
type='identity',
action='Identity Refresh.',
created='2018-06-25T20:22:28.104Z',
modified='2018-06-25T20:22:28.104Z',
synced='2018-06-25T20:22:28.104Z',
stage='Completed',
origin='',
status='Complete',
requester=,
recipient=,
@@ -70,20 +66,25 @@ approvals=[
commenter = 'Automated AR Approval',
date = '2018-06-25T20:22:28.104Z', )
],
created = '2018-06-25T20:22:28.104Z',
modified = '2018-06-25T20:22:28.104Z',
owner = null,
result = 'Finished',
type = '', )
attribute_request = sailpoint.v2024.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = null, ),
source = null, )
],
original_requests=[
sailpoint.v2024.models.original_request.OriginalRequest(
account_id = 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com',
result = sailpoint.v2024.models.result.Result(
status = 'Manual Task Created', ),
attribute_requests = [
sailpoint.v2024.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = '3203537556531076', )
value = null, )
],
op = 'add',
source = null, )
@@ -93,13 +94,13 @@ expansion_items=[
account_id = '2c91808981f58ea601821c3e93482e6f',
cause = 'Role',
name = 'smartsheet-role',
attribute_requests = [
sailpoint.v2024.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = '3203537556531076', )
],
source = null, )
attribute_request = sailpoint.v2024.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = null, ),
source = null,
id = 'ac2887ffe0e7435a8c18c73f7ae94c7b',
state = 'EXECUTING', )
],
account_requests=[
sailpoint.v2024.models.account_request.AccountRequest(
@@ -108,7 +109,7 @@ account_requests=[
sailpoint.v2024.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = '3203537556531076', )
value = null, )
],
op = 'Modify',
provisioning_target = null,

41
docs/tools/sdk/python/Reference/V2024/Models/AccountActivitySearchedItem.md
View File

@@ -17,17 +17,15 @@ AccountActivity
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | | [required]
**name** | **str** | | [required]
**type** | [**DocumentType**](document-type) | | [required]
**id** | **str** | ID of account activity. | [optional]
**action** | **str** | Type of action performed in the activity. | [optional]
**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**modified** | **datetime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
**synced** | **str** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional]
**stage** | **str** | Activity's current stage. | [optional]
**origin** | **str** | Activity's origin. | [optional]
**status** | **str** | Activity's current status. | [optional]
**requester** | [**AccountSource**](account-source) | | [optional]
**recipient** | [**AccountSource**](account-source) | | [optional]
**requester** | [**ActivityIdentity**](activity-identity) | | [optional]
**recipient** | [**ActivityIdentity**](activity-identity) | | [optional]
**tracking_number** | **str** | Account activity's tracking number. | [optional]
**errors** | **[]str** | Errors provided by the source while completing account actions. | [optional]
**warnings** | **[]str** | Warnings provided by the source while completing account actions. | [optional]
@@ -45,13 +43,11 @@ from sailpoint.v2024.models.account_activity_searched_item import AccountActivit
account_activity_searched_item = AccountActivitySearchedItem(
id='2c91808375d8e80a0175e1f88a575222',
name='john.doe',
type='identity',
action='Identity Refresh.',
created='2018-06-25T20:22:28.104Z',
modified='2018-06-25T20:22:28.104Z',
synced='2018-06-25T20:22:28.104Z',
stage='Completed',
origin='',
status='Complete',
requester=,
recipient=,
@@ -70,20 +66,25 @@ approvals=[
commenter = 'Automated AR Approval',
date = '2018-06-25T20:22:28.104Z', )
],
created = '2018-06-25T20:22:28.104Z',
modified = '2018-06-25T20:22:28.104Z',
owner = null,
result = 'Finished',
type = '', )
attribute_request = sailpoint.v2024.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = null, ),
source = null, )
],
original_requests=[
sailpoint.v2024.models.original_request.OriginalRequest(
account_id = 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com',
result = sailpoint.v2024.models.result.Result(
status = 'Manual Task Created', ),
attribute_requests = [
sailpoint.v2024.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = '3203537556531076', )
value = null, )
],
op = 'add',
source = null, )
@@ -93,13 +94,13 @@ expansion_items=[
account_id = '2c91808981f58ea601821c3e93482e6f',
cause = 'Role',
name = 'smartsheet-role',
attribute_requests = [
sailpoint.v2024.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = '3203537556531076', )
],
source = null, )
attribute_request = sailpoint.v2024.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = null, ),
source = null,
id = 'ac2887ffe0e7435a8c18c73f7ae94c7b',
state = 'EXECUTING', )
],
account_requests=[
sailpoint.v2024.models.account_request.AccountRequest(
@@ -108,7 +109,7 @@ account_requests=[
sailpoint.v2024.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = '3203537556531076', )
value = null, )
],
op = 'Modify',
provisioning_target = null,

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

@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'AccountAggregationStatus', 'V2024Acco
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**start** | **datetime** | When the aggregation started. | [optional]
**status** | **Enum** [ 'STARTED', 'ACCOUNTS_COLLECTED', 'COMPLETED', 'CANCELLED', 'RETRIED', 'TERMINATED' ] | STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. | [optional]
**status** | **Enum** [ 'STARTED', 'ACCOUNTS_COLLECTED', 'COMPLETED', 'CANCELLED', 'RETRIED', 'TERMINATED', 'NOT_FOUND' ] | STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. | [optional]
**total_accounts** | **int** | The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
**processed_accounts** | **int** | The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
}

38
docs/tools/sdk/python/Reference/V2024/Models/AccountAllOfIdentity.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: v2024-account-all-of-identity
title: AccountAllOfIdentity
pagination_label: AccountAllOfIdentity
sidebar_label: AccountAllOfIdentity
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAllOfIdentity', 'V2024AccountAllOfIdentity']
slug: /tools/sdk/python/v2024/models/account-all-of-identity
tags: ['SDK', 'Software Development Kit', 'AccountAllOfIdentity', 'V2024AccountAllOfIdentity']
---
# AccountAllOfIdentity
The identity this account is correlated to
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The ID of the identity | [optional]
**type** | **Enum** [ 'IDENTITY' ] | The type of object being referenced | [optional]
**name** | **str** | display name of identity | [optional]
}
## Example
```python
from sailpoint.v2024.models.account_all_of_identity import AccountAllOfIdentity
account_all_of_identity = AccountAllOfIdentity(
id='2c918084660f45d6016617daa9210584',
type='IDENTITY',
name='John Doe'
)
```
[[Back to top]](#)

37
docs/tools/sdk/python/Reference/V2024/Models/AccountAllOfOwnerIdentity.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: v2024-account-all-of-owner-identity
title: AccountAllOfOwnerIdentity
pagination_label: AccountAllOfOwnerIdentity
sidebar_label: AccountAllOfOwnerIdentity
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAllOfOwnerIdentity', 'V2024AccountAllOfOwnerIdentity']
slug: /tools/sdk/python/v2024/models/account-all-of-owner-identity
tags: ['SDK', 'Software Development Kit', 'AccountAllOfOwnerIdentity', 'V2024AccountAllOfOwnerIdentity']
---
# AccountAllOfOwnerIdentity
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | [**DtoType**](dto-type) | | [optional]
**id** | **str** | ID of the object to which this reference applies | [optional]
**name** | **str** | Human-readable display name of the object to which this reference applies | [optional]
}
## Example
```python
from sailpoint.v2024.models.account_all_of_owner_identity import AccountAllOfOwnerIdentity
account_all_of_owner_identity = AccountAllOfOwnerIdentity(
type='IDENTITY',
id='2c91808568c529c60168cca6f90c1313',
name='William Wilson'
)
```
[[Back to top]](#)

35
docs/tools/sdk/python/Reference/V2024/Models/AccountAllOfRecommendation.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: v2024-account-all-of-recommendation
title: AccountAllOfRecommendation
pagination_label: AccountAllOfRecommendation
sidebar_label: AccountAllOfRecommendation
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAllOfRecommendation', 'V2024AccountAllOfRecommendation']
slug: /tools/sdk/python/v2024/models/account-all-of-recommendation
tags: ['SDK', 'Software Development Kit', 'AccountAllOfRecommendation', 'V2024AccountAllOfRecommendation']
---
# AccountAllOfRecommendation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'HUMAN', 'MACHINE' ] | Recommended type of account. | [required]
**method** | **Enum** [ 'DISCOVERY', 'SOURCE', 'CRITERIA' ] | Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. | [required]
}
## Example
```python
from sailpoint.v2024.models.account_all_of_recommendation import AccountAllOfRecommendation
account_all_of_recommendation = AccountAllOfRecommendation(
type='MACHINE',
method='DISCOVERY'
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/V2024/Models/AccountAllOfSourceOwner.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: v2024-account-all-of-source-owner
title: AccountAllOfSourceOwner
pagination_label: AccountAllOfSourceOwner
sidebar_label: AccountAllOfSourceOwner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAllOfSourceOwner', 'V2024AccountAllOfSourceOwner']
slug: /tools/sdk/python/v2024/models/account-all-of-source-owner
tags: ['SDK', 'Software Development Kit', 'AccountAllOfSourceOwner', 'V2024AccountAllOfSourceOwner']
---
# AccountAllOfSourceOwner
The owner of the source this account belongs to.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The ID of the identity | [optional]
**type** | **Enum** [ 'IDENTITY' ] | The type of object being referenced | [optional]
**name** | **str** | display name of identity | [optional]
}
## Example
```python
from sailpoint.v2024.models.account_all_of_source_owner import AccountAllOfSourceOwner
account_all_of_source_owner = AccountAllOfSourceOwner(
id='2c918084660f45d6016617daa9210584',
type='IDENTITY',
name='Adam Kennedy'
)
```
[[Back to top]](#)

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

@@ -35,7 +35,7 @@ attribute_requests=[
sailpoint.v2024.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = '3203537556531076', )
value = null, )
],
op='Modify',
provisioning_target=,

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

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountRequestResult', 'V2024AccountR
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**errors** | **[]str** | | [optional]
**errors** | **[]str** | Error message. | [optional]
**status** | **str** | The status of the account request | [optional]
**ticket_id** | **str** | | [optional]
**ticket_id** | **str** | ID of associated ticket. | [optional]
}
## Example

37
docs/tools/sdk/python/Reference/V2024/Models/ActivityIdentity.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: v2024-activity-identity
title: ActivityIdentity
pagination_label: ActivityIdentity
sidebar_label: ActivityIdentity
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ActivityIdentity', 'V2024ActivityIdentity']
slug: /tools/sdk/python/v2024/models/activity-identity
tags: ['SDK', 'Software Development Kit', 'ActivityIdentity', 'V2024ActivityIdentity']
---
# ActivityIdentity
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique ID of the referenced object. | [optional]
**name** | **str** | The human readable name of the referenced object. | [optional]
**type** | **str** | Type of object | [optional]
}
## Example
```python
from sailpoint.v2024.models.activity_identity import ActivityIdentity
activity_identity = ActivityIdentity(
id='2c91808568c529c60168cca6f90c1313',
name='John Doe',
type='Identity'
)
```
[[Back to top]](#)

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

@@ -28,7 +28,7 @@ from sailpoint.v2024.models.aggregation_result import AggregationResult
aggregation_result = AggregationResult(
aggregations={Identity Locations={buckets=[{key=Austin, doc_count=109}, {key=London, doc_count=64}, {key=San Jose, doc_count=27}, {key=Brussels, doc_count=26}, {key=Sao Paulo, doc_count=24}, {key=Munich, doc_count=23}, {key=Singapore, doc_count=22}, {key=Tokyo, doc_count=20}, {key=Taipei, doc_count=16}]}},
hits=[
sailpoint.v2024.models.search_document.SearchDocument()
sailpoint.v2024.models.search_documents.SearchDocuments()
]
)

13
docs/tools/sdk/python/Reference/V2024/Models/Approval1.md
View File

@@ -17,11 +17,11 @@ tags: ['SDK', 'Software Development Kit', 'Approval1', 'V2024Approval1']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**comments** | [**[]ApprovalComment2**](approval-comment2) | | [optional]
**created** | **datetime** | A date-time in ISO-8601 format | [optional]
**modified** | **datetime** | A date-time in ISO-8601 format | [optional]
**owner** | [**AccountSource**](account-source) | | [optional]
**owner** | [**ActivityIdentity**](activity-identity) | | [optional]
**result** | **str** | The result of the approval | [optional]
**type** | **str** | | [optional]
**attribute_request** | [**AttributeRequest**](attribute-request) | | [optional]
**source** | [**AccountSource**](account-source) | | [optional]
}
## Example
@@ -36,11 +36,14 @@ comments=[
commenter = 'Automated AR Approval',
date = '2018-06-25T20:22:28.104Z', )
],
created='2018-06-25T20:22:28.104Z',
modified='2018-06-25T20:22:28.104Z',
owner=,
result='Finished',
type=''
attribute_request=sailpoint.v2024.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = null, ),
source=
)
```

43
docs/tools/sdk/python/Reference/V2024/Models/ApprovalForwardHistory1.md
View File

@@ -1,43 +0,0 @@
---
id: v2024-approval-forward-history1
title: ApprovalForwardHistory1
pagination_label: ApprovalForwardHistory1
sidebar_label: ApprovalForwardHistory1
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ApprovalForwardHistory1', 'V2024ApprovalForwardHistory1']
slug: /tools/sdk/python/v2024/models/approval-forward-history1
tags: ['SDK', 'Software Development Kit', 'ApprovalForwardHistory1', 'V2024ApprovalForwardHistory1']
---
# ApprovalForwardHistory1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**old_approver_name** | **str** | Display name of approver from whom the approval was forwarded. | [optional]
**new_approver_name** | **str** | Display name of approver to whom the approval was forwarded. | [optional]
**comment** | **str** | Comment made while forwarding. | [optional]
**modified** | **datetime** | Time at which approval was forwarded. | [optional]
**forwarder_name** | **str** | Display name of forwarder who forwarded the approval. | [optional]
**reassignment_type** | [**ReassignmentType**](reassignment-type) | | [optional]
}
## Example
```python
from sailpoint.v2024.models.approval_forward_history1 import ApprovalForwardHistory1
approval_forward_history1 = ApprovalForwardHistory1(
old_approver_name='Frank Mir',
new_approver_name='Al Volta',
comment='Forwarding from Frank to Al',
modified='2019-08-23T18:52:57.398Z',
forwarder_name='William Wilson',
reassignment_type='AUTOMATIC_REASSIGNMENT'
)
```
[[Back to top]](#)

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

@@ -16,7 +16,6 @@ tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDto', 'V2024ApprovalSta
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**approval_id** | **str** | Unique identifier for the approval. | [optional]
**forwarded** | **bool** | True if the request for this item was forwarded from one owner to another. | [optional] [default to False]
**original_owner** | [**ApprovalStatusDtoOriginalOwner**](approval-status-dto-original-owner) | | [optional]
**current_owner** | [**ApprovalStatusDtoCurrentOwner**](approval-status-dto-current-owner) | | [optional]
@@ -34,7 +33,6 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.approval_status_dto import ApprovalStatusDto
approval_status_dto = ApprovalStatusDto(
approval_id='2c9180877b2b6ea4017b2c545f971429',
forwarded=False,
original_owner=sailpoint.v2024.models.approval_status_dto_original_owner.ApprovalStatusDto_originalOwner(
type = 'IDENTITY',

57
docs/tools/sdk/python/Reference/V2024/Models/ApprovalStatusDto1.md
View File

@@ -1,57 +0,0 @@
---
id: v2024-approval-status-dto1
title: ApprovalStatusDto1
pagination_label: ApprovalStatusDto1
sidebar_label: ApprovalStatusDto1
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ApprovalStatusDto1', 'V2024ApprovalStatusDto1']
slug: /tools/sdk/python/v2024/models/approval-status-dto1
tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDto1', 'V2024ApprovalStatusDto1']
---
# ApprovalStatusDto1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**forwarded** | **bool** | True if the request for this item was forwarded from one owner to another. | [optional] [default to False]
**original_owner** | [**ApprovalStatusDtoOriginalOwner**](approval-status-dto-original-owner) | | [optional]
**current_owner** | [**ApprovalStatusDtoCurrentOwner**](approval-status-dto-current-owner) | | [optional]
**modified** | **datetime** | Time at which item was modified. | [optional]
**status** | [**ManualWorkItemState**](manual-work-item-state) | | [optional]
**scheme** | [**ApprovalScheme**](approval-scheme) | | [optional]
**error_messages** | [**[]ErrorMessageDto1**](error-message-dto1) | If the request failed, includes any error messages that were generated. | [optional]
**comment** | **str** | Comment, if any, provided by the approver. | [optional]
**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional]
}
## Example
```python
from sailpoint.v2024.models.approval_status_dto1 import ApprovalStatusDto1
approval_status_dto1 = ApprovalStatusDto1(
forwarded=False,
original_owner=sailpoint.v2024.models.approval_status_dto_original_owner.ApprovalStatusDto_originalOwner(
type = 'IDENTITY',
id = '2c7180a46faadee4016fb4e018c20642',
name = 'Michael Michaels', ),
current_owner=,
modified='2019-08-23T18:52:57.398Z',
status='PENDING',
scheme='MANAGER',
error_messages=[
sailpoint.v2024.models.error_message_dto_1.ErrorMessageDto_1(
locale = 'en-US',
locale_origin = 'DEFAULT',
text = 'The request was syntactically correct but its content is semantically invalid.', )
],
comment='I approve this request',
remove_date='2020-07-11T00:00Z'
)
```
[[Back to top]](#)

7
docs/tools/sdk/python/Reference/V2024/Models/AssignmentContextDto.md
View File

@@ -36,9 +36,10 @@ requested=sailpoint.v2024.models.access_request_context.AccessRequestContext(
], ),
matched=[
sailpoint.v2024.models.role_match_dto.RoleMatchDto(
role_ref = sailpoint.v2024.models.base_reference_dto_1.BaseReferenceDto_1(
id = 'ff8081814d977c21014da056804a0af3',
name = 'Github', ),
role_ref = sailpoint.v2024.models.base_reference_dto.BaseReferenceDto(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', ),
matched_attributes = [
sailpoint.v2024.models.context_attribute_dto.ContextAttributeDto(
attribute = 'location',

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

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Attribute name. | [optional]
**op** | **str** | Operation to perform on attribute. | [optional]
**value** | **str** | Value of attribute. | [optional]
**value** | [**AttributeRequestValue**](attribute-request-value) | | [optional]
}
## Example
@@ -29,7 +29,7 @@ from sailpoint.v2024.models.attribute_request import AttributeRequest
attribute_request = AttributeRequest(
name='groups',
op='Add',
value='3203537556531076'
value=
)
```

32
docs/tools/sdk/python/Reference/V2024/Models/AttributeRequestValue.md Normal file
View File

@@ -0,0 +1,32 @@
---
id: v2024-attribute-request-value
title: AttributeRequestValue
pagination_label: AttributeRequestValue
sidebar_label: AttributeRequestValue
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AttributeRequestValue', 'V2024AttributeRequestValue']
slug: /tools/sdk/python/v2024/models/attribute-request-value
tags: ['SDK', 'Software Development Kit', 'AttributeRequestValue', 'V2024AttributeRequestValue']
---
# AttributeRequestValue
Value of attribute.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
}
## Example
```python
from sailpoint.v2024.models.attribute_request_value import AttributeRequestValue
attribute_request_value = AttributeRequestValue(
)
```
[[Back to top]](#)

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

@@ -29,9 +29,10 @@ Name | Type | Description | Notes
**lastname** | **str** | Auth user's last name. | [optional]
**display_name** | **str** | Auth user's name in displayed format. | [optional]
**alias** | **str** | Auth user's alias. | [optional]
**last_password_change_date** | **str** | Date of last password change. | [optional]
**last_password_change_date** | **datetime** | Date of last password change. | [optional]
**last_login_timestamp** | **int** | Timestamp of the last login (long type value). | [optional]
**current_login_timestamp** | **int** | Timestamp of the current login (long type value). | [optional]
**last_unlock_timestamp** | **datetime** | The date and time when the user was last unlocked. | [optional]
**capabilities** | **[]str** | Array of the auth user's capabilities. | [optional]
}
@@ -57,6 +58,7 @@ alias='will.smith',
last_password_change_date='2021-03-08T22:37:33.901Z',
last_login_timestamp=1656327185832,
current_login_timestamp=1656327185832,
last_unlock_timestamp='2021-03-08T22:37:33.901Z',
capabilities=[
'ORG_ADMIN'
]

10
docs/tools/sdk/python/Reference/V2024/Models/BaseAccess.md
View File

@@ -16,8 +16,6 @@ tags: ['SDK', 'Software Development Kit', 'BaseAccess', 'V2024BaseAccess']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique ID of the referenced object. | [optional]
**name** | **str** | The human readable name of the referenced object. | [optional]
**description** | **str** | Access item's description. | [optional]
**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**modified** | **datetime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
@@ -25,7 +23,7 @@ Name | Type | Description | Notes
**enabled** | **bool** | Indicates whether the access item is currently enabled. | [optional] [default to False]
**requestable** | **bool** | Indicates whether the access item can be requested. | [optional] [default to True]
**request_comments_required** | **bool** | Indicates whether comments are required for requests to access the item. | [optional] [default to False]
**owner** | [**BaseAccessAllOfOwner**](base-access-all-of-owner) | | [optional]
**owner** | [**BaseAccessOwner**](base-access-owner) | | [optional]
}
## Example
@@ -34,16 +32,14 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.base_access import BaseAccess
base_access = BaseAccess(
id='2c91808568c529c60168cca6f90c1313',
name='John Doe',
description='The admin role',
description='Admin access',
created='2018-06-25T20:22:28.104Z',
modified='2018-06-25T20:22:28.104Z',
synced='2018-06-25T20:22:33.104Z',
enabled=True,
requestable=True,
request_comments_required=False,
owner=sailpoint.v2024.models.base_access_all_of_owner.BaseAccess_allOf_owner(
owner=sailpoint.v2024.models.base_access_owner.BaseAccess_owner(
type = 'IDENTITY',
id = '2c9180a46faadee4016fb4e018c20639',
name = 'Support',

20
docs/tools/sdk/python/Reference/V2024/Models/BaseAccessAllOfOwner.md → docs/tools/sdk/python/Reference/V2024/Models/BaseAccessOwner.md
View File

@@ -1,15 +1,15 @@
---
id: v2024-base-access-all-of-owner
title: BaseAccessAllOfOwner
pagination_label: BaseAccessAllOfOwner
sidebar_label: BaseAccessAllOfOwner
id: v2024-base-access-owner
title: BaseAccessOwner
pagination_label: BaseAccessOwner
sidebar_label: BaseAccessOwner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'BaseAccessAllOfOwner', 'V2024BaseAccessAllOfOwner']
slug: /tools/sdk/python/v2024/models/base-access-all-of-owner
tags: ['SDK', 'Software Development Kit', 'BaseAccessAllOfOwner', 'V2024BaseAccessAllOfOwner']
keywords: ['python', 'Python', 'sdk', 'BaseAccessOwner', 'V2024BaseAccessOwner']
slug: /tools/sdk/python/v2024/models/base-access-owner
tags: ['SDK', 'Software Development Kit', 'BaseAccessOwner', 'V2024BaseAccessOwner']
---
# BaseAccessAllOfOwner
# BaseAccessOwner
Owner's identity.
@@ -26,9 +26,9 @@ Name | Type | Description | Notes
## Example
```python
from sailpoint.v2024.models.base_access_all_of_owner import BaseAccessAllOfOwner
from sailpoint.v2024.models.base_access_owner import BaseAccessOwner
base_access_all_of_owner = BaseAccessAllOfOwner(
base_access_owner = BaseAccessOwner(
type='IDENTITY',
id='2c9180a46faadee4016fb4e018c20639',
name='Support',

6
docs/tools/sdk/python/Reference/V2024/Models/BaseAccount.md
View File

@@ -27,6 +27,8 @@ Name | Type | Description | Notes
**password_last_set** | **datetime** | A date-time in ISO-8601 format | [optional]
**entitlement_attributes** | **map[string]object** | Map or dictionary of key/value pairs. | [optional]
**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**supports_password_change** | **bool** | Indicates whether the account supports password change. | [optional] [default to False]
**account_attributes** | **map[string]object** | Map or dictionary of key/value pairs. | [optional]
}
## Example
@@ -45,7 +47,9 @@ privileged=False,
manually_correlated=False,
password_last_set='2018-06-25T20:22:28.104Z',
entitlement_attributes={moderator=true, admin=true, trust_level=4},
created='2018-06-25T20:22:28.104Z'
created='2018-06-25T20:22:28.104Z',
supports_password_change=False,
account_attributes={type=global, admin=true, trust_level=4}
)
```

39
docs/tools/sdk/python/Reference/V2024/Models/BaseCommonDto1.md
View File

@@ -1,39 +0,0 @@
---
id: v2024-base-common-dto1
title: BaseCommonDto1
pagination_label: BaseCommonDto1
sidebar_label: BaseCommonDto1
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'BaseCommonDto1', 'V2024BaseCommonDto1']
slug: /tools/sdk/python/v2024/models/base-common-dto1
tags: ['SDK', 'Software Development Kit', 'BaseCommonDto1', 'V2024BaseCommonDto1']
---
# BaseCommonDto1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | System-generated unique ID of the Object | [optional] [readonly]
**name** | **str** | Name of the Object | [required]
**created** | **datetime** | Creation date of the Object | [optional] [readonly]
**modified** | **datetime** | Last modification date of the Object | [optional] [readonly]
}
## Example
```python
from sailpoint.v2024.models.base_common_dto1 import BaseCommonDto1
base_common_dto1 = BaseCommonDto1(
id='id12345',
name='aName',
created='2023-01-03T21:16:22.432Z',
modified='2023-01-03T21:16:22.432Z'
)
```
[[Back to top]](#)

8
docs/tools/sdk/python/Reference/V2024/Models/BaseDocument.md
View File

@@ -16,9 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'BaseDocument', 'V2024BaseDocument']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | | [required]
**name** | **str** | | [required]
**type** | [**DocumentType**](document-type) | | [required]
**id** | **str** | ID of the referenced object. | [required]
**name** | **str** | The human readable name of the referenced object. | [required]
}
## Example
@@ -28,8 +27,7 @@ from sailpoint.v2024.models.base_document import BaseDocument
base_document = BaseDocument(
id='2c91808375d8e80a0175e1f88a575222',
name='john.doe',
type='identity'
name='john.doe'
)
```

35
docs/tools/sdk/python/Reference/V2024/Models/BaseReferenceDto1.md
View File

@@ -1,35 +0,0 @@
---
id: v2024-base-reference-dto1
title: BaseReferenceDto1
pagination_label: BaseReferenceDto1
sidebar_label: BaseReferenceDto1
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'BaseReferenceDto1', 'V2024BaseReferenceDto1']
slug: /tools/sdk/python/v2024/models/base-reference-dto1
tags: ['SDK', 'Software Development Kit', 'BaseReferenceDto1', 'V2024BaseReferenceDto1']
---
# BaseReferenceDto1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | the application ID | [optional]
**name** | **str** | the application name | [optional]
}
## Example
```python
from sailpoint.v2024.models.base_reference_dto1 import BaseReferenceDto1
base_reference_dto1 = BaseReferenceDto1(
id='ff8081814d977c21014da056804a0af3',
name='Github'
)
```
[[Back to top]](#)

3
docs/tools/sdk/python/Reference/V2024/Models/Campaign.md
View File

@@ -94,7 +94,8 @@ search_campaign_info=sailpoint.v2024.models.campaign_all_of_search_campaign_info
operator = 'SELECTED', )
], ),
role_composition_campaign_info=sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info.Campaign_allOf_roleCompositionCampaignInfo(
reviewer = sailpoint.v2024.models.campaign_all_of_search_campaign_info_reviewer.Campaign_allOf_searchCampaignInfo_reviewer(
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', ),

6
docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfRoleCompositionCampaignInfo.md
View File

@@ -17,7 +17,8 @@ Optional configuration options for role composition campaigns.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**reviewer** | [**CampaignAllOfSearchCampaignInfoReviewer**](campaign-all-of-search-campaign-info-reviewer) | | [optional]
**reviewer_id** | **str** | The ID of the identity or governance group reviewing this campaign. Deprecated in favor of the \"reviewer\" object. | [optional]
**reviewer** | [**CampaignAllOfRoleCompositionCampaignInfoReviewer**](campaign-all-of-role-composition-campaign-info-reviewer) | | [optional]
**role_ids** | **[]str** | Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [optional]
**remediator_ref** | [**CampaignAllOfRoleCompositionCampaignInfoRemediatorRef**](campaign-all-of-role-composition-campaign-info-remediator-ref) | | [required]
**query** | **str** | Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [optional]
@@ -30,7 +31,8 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info import CampaignAllOfRoleCompositionCampaignInfo
campaign_all_of_role_composition_campaign_info = CampaignAllOfRoleCompositionCampaignInfo(
reviewer=sailpoint.v2024.models.campaign_all_of_search_campaign_info_reviewer.Campaign_allOf_searchCampaignInfo_reviewer(
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', ),

38
docs/tools/sdk/python/Reference/V2024/Models/CampaignAllOfRoleCompositionCampaignInfoReviewer.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: v2024-campaign-all-of-role-composition-campaign-info-reviewer
title: CampaignAllOfRoleCompositionCampaignInfoReviewer
pagination_label: CampaignAllOfRoleCompositionCampaignInfoReviewer
sidebar_label: CampaignAllOfRoleCompositionCampaignInfoReviewer
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'CampaignAllOfRoleCompositionCampaignInfoReviewer', 'V2024CampaignAllOfRoleCompositionCampaignInfoReviewer']
slug: /tools/sdk/python/v2024/models/campaign-all-of-role-composition-campaign-info-reviewer
tags: ['SDK', 'Software Development Kit', 'CampaignAllOfRoleCompositionCampaignInfoReviewer', 'V2024CampaignAllOfRoleCompositionCampaignInfoReviewer']
---
# CampaignAllOfRoleCompositionCampaignInfoReviewer
If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'GOVERNANCE_GROUP', 'IDENTITY' ] | The reviewer's DTO type. | [optional]
**id** | **str** | The reviewer's ID. | [optional]
**name** | **str** | The reviewer's name. | [optional]
}
## Example
```python
from sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info_reviewer import CampaignAllOfRoleCompositionCampaignInfoReviewer
campaign_all_of_role_composition_campaign_info_reviewer = CampaignAllOfRoleCompositionCampaignInfoReviewer(
type='IDENTITY',
id='2c91808568c529c60168cca6f90c1313',
name='William Wilson'
)
```
[[Back to top]](#)

41
docs/tools/sdk/python/Reference/V2024/Models/CancelledRequestDetails1.md
View File

@@ -1,41 +0,0 @@
---
id: v2024-cancelled-request-details1
title: CancelledRequestDetails1
pagination_label: CancelledRequestDetails1
sidebar_label: CancelledRequestDetails1
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'CancelledRequestDetails1', 'V2024CancelledRequestDetails1']
slug: /tools/sdk/python/v2024/models/cancelled-request-details1
tags: ['SDK', 'Software Development Kit', 'CancelledRequestDetails1', 'V2024CancelledRequestDetails1']
---
# CancelledRequestDetails1
Provides additional details for a request that has been cancelled.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**comment** | **str** | Comment made by the owner when cancelling the associated request. | [optional]
**owner** | [**OwnerDto**](owner-dto) | | [optional]
**modified** | **datetime** | Date comment was added by the owner when cancelling the associated request. | [optional]
}
## Example
```python
from sailpoint.v2024.models.cancelled_request_details1 import CancelledRequestDetails1
cancelled_request_details1 = CancelledRequestDetails1(
comment='This request must be cancelled.',
owner=sailpoint.v2024.models.owner_dto.OwnerDto(
type = 'IDENTITY',
id = '2c9180a46faadee4016fb4e018c20639',
name = 'Support', ),
modified='2019-12-20T09:17:12.192Z'
)
```
[[Back to top]](#)

30
docs/tools/sdk/python/Reference/V2024/Models/CertificationDto.md
View File

@@ -20,8 +20,8 @@ Name | Type | Description | Notes
**phase** | [**CertificationPhase**](certification-phase) | | [required]
**due** | **datetime** | The due date of the certification. | [required]
**signed** | **datetime** | The date the reviewer signed off on the certification. | [required]
**reviewer** | [**Reviewer1**](reviewer1) | | [required]
**reassignment** | [**Reassignment1**](reassignment1) | | [optional]
**reviewer** | [**Reviewer**](reviewer) | | [required]
**reassignment** | [**Reassignment**](reassignment) | | [optional]
**has_errors** | **bool** | Indicates it the certification has any errors. | [required]
**error_message** | **str** | A message indicating what the error is. | [optional]
**completed** | **bool** | Indicates if all certification decisions have been made. | [required]
@@ -48,14 +48,26 @@ campaign_ref=sailpoint.v2024.models.campaign_reference.CampaignReference(
phase='ACTIVE',
due='2018-10-19T13:49:37.385Z',
signed='2018-10-19T13:49:37.385Z',
reviewer=sailpoint.v2024.models.reviewer_1.Reviewer_1(
reviewer=sailpoint.v2024.models.reviewer.Reviewer(
id = 'ef38f94347e94562b5bb8424a56397d8',
name = 'Reviewer Name',
email = 'reviewer@test.com',
type = 'IDENTITY',
id = '2c7180a46faadee4016fb4e018c20642',
name = 'Michael Michaels',
email = 'reviewer@test.com', ),
reassignment=sailpoint.v2024.models.reassignment_1.Reassignment_1(
from = sailpoint.v2024.models.certification_reference_1.CertificationReference_1(),
comment = 'Please review', ),
created = '2018-06-25T20:22:28.104Z',
modified = '2018-06-25T20:22:28.104Z', ),
reassignment=sailpoint.v2024.models.reassignment.Reassignment(
from = sailpoint.v2024.models.certification_reference.CertificationReference(
id = 'ef38f94347e94562b5bb8424a56397d8',
name = 'Certification Name',
type = 'CERTIFICATION',
reviewer = sailpoint.v2024.models.reviewer.Reviewer(
id = 'ef38f94347e94562b5bb8424a56397d8',
name = 'Reviewer Name',
email = 'reviewer@test.com',
type = 'IDENTITY',
created = '2018-06-25T20:22:28.104Z',
modified = '2018-06-25T20:22:28.104Z', ), ),
comment = 'Reassigned for a reason', ),
has_errors=False,
error_message='The certification has an error',
completed=False,

44
docs/tools/sdk/python/Reference/V2024/Models/CertificationReference1.md
View File

@@ -1,44 +0,0 @@
---
id: v2024-certification-reference1
title: CertificationReference1
pagination_label: CertificationReference1
sidebar_label: CertificationReference1
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'CertificationReference1', 'V2024CertificationReference1']
slug: /tools/sdk/python/v2024/models/certification-reference1
tags: ['SDK', 'Software Development Kit', 'CertificationReference1', 'V2024CertificationReference1']
---
# CertificationReference1
Previous certification.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'CERTIFICATION' ] | DTO type of certification for review. | [optional]
**id** | **str** | ID of certification for review. | [optional]
**name** | **str** | Display name of certification for review. | [optional]
**reviewer** | [**Reviewer1**](reviewer1) | | [optional]
}
## Example
```python
from sailpoint.v2024.models.certification_reference1 import CertificationReference1
certification_reference1 = CertificationReference1(
type='IDENTITY',
id='7589a83cec4b4f138ce56c1a5ef0756d',
name='Manager Access for Michael Michaels',
reviewer=sailpoint.v2024.models.reviewer_1.Reviewer_1(
type = 'IDENTITY',
id = '2c7180a46faadee4016fb4e018c20642',
name = 'Michael Michaels',
email = 'reviewer@test.com', )
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/V2024/Models/CertificationReferenceDto.md
View File

@@ -1,38 +0,0 @@
---
id: v2024-certification-reference-dto
title: CertificationReferenceDto
pagination_label: CertificationReferenceDto
sidebar_label: CertificationReferenceDto
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'CertificationReferenceDto', 'V2024CertificationReferenceDto']
slug: /tools/sdk/python/v2024/models/certification-reference-dto
tags: ['SDK', 'Software Development Kit', 'CertificationReferenceDto', 'V2024CertificationReferenceDto']
---
# CertificationReferenceDto
Certification for review.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'CERTIFICATION' ] | DTO type of certification for review. | [optional]
**id** | **str** | ID of certification for review. | [optional]
**name** | **str** | Display name of certification for review. | [optional]
}
## Example
```python
from sailpoint.v2024.models.certification_reference_dto import CertificationReferenceDto
certification_reference_dto = CertificationReferenceDto(
type='IDENTITY',
id='7589a83cec4b4f138ce56c1a5ef0756d',
name='Manager Access for Michael Michaels'
)
```
[[Back to top]](#)

30
docs/tools/sdk/python/Reference/V2024/Models/CertificationSignedOffCertification.md
View File

@@ -25,8 +25,8 @@ Name | Type | Description | Notes
**phase** | [**CertificationPhase**](certification-phase) | | [required]
**due** | **datetime** | The due date of the certification. | [required]
**signed** | **datetime** | The date the reviewer signed off on the certification. | [required]
**reviewer** | [**Reviewer1**](reviewer1) | | [required]
**reassignment** | [**Reassignment1**](reassignment1) | | [optional]
**reviewer** | [**Reviewer**](reviewer) | | [required]
**reassignment** | [**Reassignment**](reassignment) | | [optional]
**has_errors** | **bool** | Indicates it the certification has any errors. | [required]
**error_message** | **str** | A message indicating what the error is. | [optional]
**completed** | **bool** | Indicates if all certification decisions have been made. | [required]
@@ -57,14 +57,26 @@ campaign_ref=sailpoint.v2024.models.campaign_reference.CampaignReference(
phase='ACTIVE',
due='2018-10-19T13:49:37.385Z',
signed='2018-10-19T13:49:37.385Z',
reviewer=sailpoint.v2024.models.reviewer_1.Reviewer_1(
reviewer=sailpoint.v2024.models.reviewer.Reviewer(
id = 'ef38f94347e94562b5bb8424a56397d8',
name = 'Reviewer Name',
email = 'reviewer@test.com',
type = 'IDENTITY',
id = '2c7180a46faadee4016fb4e018c20642',
name = 'Michael Michaels',
email = 'reviewer@test.com', ),
reassignment=sailpoint.v2024.models.reassignment_1.Reassignment_1(
from = sailpoint.v2024.models.certification_reference_1.CertificationReference_1(),
comment = 'Please review', ),
created = '2018-06-25T20:22:28.104Z',
modified = '2018-06-25T20:22:28.104Z', ),
reassignment=sailpoint.v2024.models.reassignment.Reassignment(
from = sailpoint.v2024.models.certification_reference.CertificationReference(
id = 'ef38f94347e94562b5bb8424a56397d8',
name = 'Certification Name',
type = 'CERTIFICATION',
reviewer = sailpoint.v2024.models.reviewer.Reviewer(
id = 'ef38f94347e94562b5bb8424a56397d8',
name = 'Reviewer Name',
email = 'reviewer@test.com',
type = 'IDENTITY',
created = '2018-06-25T20:22:28.104Z',
modified = '2018-06-25T20:22:28.104Z', ), ),
comment = 'Reassigned for a reason', ),
has_errors=False,
error_message='The certification has an error',
completed=False,

9
docs/tools/sdk/python/Reference/V2024/Models/CertificationTask.md
View File

@@ -21,7 +21,7 @@ Name | Type | Description | Notes
**target_type** | **Enum** [ 'CERTIFICATION', 'CAMPAIGN' ] | The type of item that is being operated on by this task whose ID is stored in the targetId field. | [optional]
**target_id** | **str** | The ID of the item being operated on by this task. | [optional]
**status** | **Enum** [ 'QUEUED', 'IN_PROGRESS', 'SUCCESS', 'ERROR' ] | The status of the task. | [optional]
**errors** | [**[]ErrorMessageDto**](error-message-dto) | | [optional]
**errors** | [**[]ErrorMessageDto**](error-message-dto) | List of error messages | [optional]
**reassignment_trail_dtos** | [**[]ReassignmentTrailDTO**](reassignment-trail-dto) | Reassignment trails that lead to self certification identity | [optional]
**created** | **datetime** | The date and time on which this task was created. | [optional]
}
@@ -37,12 +37,7 @@ type='ADMIN_REASSIGN',
target_type='CAMPAIGN',
target_id='2c918086719eec070171a7e3355a834c',
status='QUEUED',
errors=[
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.', )
],
errors={locale=en-US, localeOrigin=DEFAULT, text=Error Message},
reassignment_trail_dtos={previousOwner=ef38f94347e94562b5bb8424a56397d8, newOwner=ef38f94347e94562b5bb8424a56397a3, reassignmentType=AUTOMATIC_REASSIGNMENT},
created='2020-09-24T18:10:47.693Z'
)

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

@@ -28,7 +28,7 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.connected_object import ConnectedObject
connected_object = ConnectedObject(
type='ACCESS_PROFILE',
type=,
id='2c91808568c529c60168cca6f90c1313',
name='Employee-database-read-write',
description='Collection of entitlements to read/write the employee database.'

46
docs/tools/sdk/python/Reference/V2024/Models/ConnectorDetail1.md
View File

@@ -1,46 +0,0 @@
---
id: v2024-connector-detail1
title: ConnectorDetail1
pagination_label: ConnectorDetail1
sidebar_label: ConnectorDetail1
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ConnectorDetail1', 'V2024ConnectorDetail1']
slug: /tools/sdk/python/v2024/models/connector-detail1
tags: ['SDK', 'Software Development Kit', 'ConnectorDetail1', 'V2024ConnectorDetail1']
---
# ConnectorDetail1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | The connector name | [optional]
**source_config_xml** | **str** | XML representation of the source config data | [optional]
**source_config** | **str** | JSON representation of the source config data | [optional]
**direct_connect** | **bool** | true if the source is a direct connect source | [optional]
**file_upload** | **bool** | Connector config's file upload attribute, false if not there | [optional]
**uploaded_files** | **str** | List of uploaded file strings for the connector | [optional]
**connector_metadata** | **object** | Object containing metadata pertinent to the UI to be used | [optional]
}
## Example
```python
from sailpoint.v2024.models.connector_detail1 import ConnectorDetail1
connector_detail1 = ConnectorDetail1(
name='JDBC',
source_config_xml='<Form connectorName='Active Directory - Direct' directConnect='true' name='Active Directory' status='released' type='SourceConfig' xmlns='http://www.sailpoint.com/xsd/sailpoint_form_1_0.xsd'>
<Field defaultValue='true' hidden='true' name='cloudAuthEnabled' type='boolean' value='true'> </Field> </Form>',
source_config='{Form={Field={_defaultValue=true, _hidden=true, _name=cloudAuthEnabled, _type=boolean, _value=true}, _xmlns=http://www.sailpoint.com/xsd/sailpoint_form_1_0.xsd, _connectorName=Active Directory - Direct, _directConnect=true, _name=Active Directory, _status=released, _type=SourceConfig, __text=\n\t}}',
direct_connect=True,
file_upload=False,
uploaded_files='[]',
connector_metadata={supportedUI=EXTJS}
)
```
[[Back to top]](#)

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

@@ -19,7 +19,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | the name of the rule | [required]
**description** | **str** | a description of the rule's purpose | [optional]
**type** | **Enum** [ 'BuildMap', 'ConnectorAfterCreate', 'ConnectorAfterDelete', 'ConnectorAfterModify', 'ConnectorBeforeCreate', 'ConnectorBeforeDelete', 'ConnectorBeforeModify', 'JDBCBuildMap', 'JDBCOperationProvisioning', 'JDBCProvision', 'PeopleSoftHRMSBuildMap', 'PeopleSoftHRMSOperationProvisioning', 'PeopleSoftHRMSProvision', 'RACFPermissionCustomization', 'SAPBuildMap', 'SapHrManagerRule', 'SapHrOperationProvisioning', 'SapHrProvision', 'SuccessFactorsOperationProvisioning', 'WebServiceAfterOperationRule', 'WebServiceBeforeOperationRule' ] | the type of rule | [required]
**type** | **Enum** [ 'BuildMap', 'ConnectorAfterCreate', 'ConnectorAfterDelete', 'ConnectorAfterModify', 'ConnectorBeforeCreate', 'ConnectorBeforeDelete', 'ConnectorBeforeModify', 'JDBCBuildMap', 'JDBCOperationProvisioning', 'JDBCProvision', 'PeopleSoftHRMSBuildMap', 'PeopleSoftHRMSOperationProvisioning', 'PeopleSoftHRMSProvision', 'RACFPermissionCustomization', 'ResourceObjectCustomization', 'SAPBuildMap', 'SapHrManagerRule', 'SapHrOperationProvisioning', 'SapHrProvision', 'SuccessFactorsOperationProvisioning', 'WebServiceAfterOperationRule', 'WebServiceBeforeOperationRule' ] | the type of rule | [required]
**signature** | [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional]
**source_code** | [**SourceCode**](source-code) | | [required]
**attributes** | **object** | a map of string to objects | [optional]

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

@@ -19,7 +19,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | the name of the rule | [required]
**description** | **str** | a description of the rule's purpose | [optional]
**type** | **Enum** [ 'BuildMap', 'ConnectorAfterCreate', 'ConnectorAfterDelete', 'ConnectorAfterModify', 'ConnectorBeforeCreate', 'ConnectorBeforeDelete', 'ConnectorBeforeModify', 'JDBCBuildMap', 'JDBCOperationProvisioning', 'JDBCProvision', 'PeopleSoftHRMSBuildMap', 'PeopleSoftHRMSOperationProvisioning', 'PeopleSoftHRMSProvision', 'RACFPermissionCustomization', 'SAPBuildMap', 'SapHrManagerRule', 'SapHrOperationProvisioning', 'SapHrProvision', 'SuccessFactorsOperationProvisioning', 'WebServiceAfterOperationRule', 'WebServiceBeforeOperationRule' ] | the type of rule | [required]
**type** | **Enum** [ 'BuildMap', 'ConnectorAfterCreate', 'ConnectorAfterDelete', 'ConnectorAfterModify', 'ConnectorBeforeCreate', 'ConnectorBeforeDelete', 'ConnectorBeforeModify', 'JDBCBuildMap', 'JDBCOperationProvisioning', 'JDBCProvision', 'PeopleSoftHRMSBuildMap', 'PeopleSoftHRMSOperationProvisioning', 'PeopleSoftHRMSProvision', 'RACFPermissionCustomization', 'ResourceObjectCustomization', 'SAPBuildMap', 'SapHrManagerRule', 'SapHrOperationProvisioning', 'SapHrProvision', 'SuccessFactorsOperationProvisioning', 'WebServiceAfterOperationRule', 'WebServiceBeforeOperationRule' ] | the type of rule | [required]
**signature** | [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional]
**source_code** | [**SourceCode**](source-code) | | [required]
**attributes** | **object** | a map of string to objects | [optional]

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

@@ -19,7 +19,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | the name of the rule | [required]
**description** | **str** | a description of the rule's purpose | [optional]
**type** | **Enum** [ 'BuildMap', 'ConnectorAfterCreate', 'ConnectorAfterDelete', 'ConnectorAfterModify', 'ConnectorBeforeCreate', 'ConnectorBeforeDelete', 'ConnectorBeforeModify', 'JDBCBuildMap', 'JDBCOperationProvisioning', 'JDBCProvision', 'PeopleSoftHRMSBuildMap', 'PeopleSoftHRMSOperationProvisioning', 'PeopleSoftHRMSProvision', 'RACFPermissionCustomization', 'SAPBuildMap', 'SapHrManagerRule', 'SapHrOperationProvisioning', 'SapHrProvision', 'SuccessFactorsOperationProvisioning', 'WebServiceAfterOperationRule', 'WebServiceBeforeOperationRule' ] | the type of rule | [required]
**type** | **Enum** [ 'BuildMap', 'ConnectorAfterCreate', 'ConnectorAfterDelete', 'ConnectorAfterModify', 'ConnectorBeforeCreate', 'ConnectorBeforeDelete', 'ConnectorBeforeModify', 'JDBCBuildMap', 'JDBCOperationProvisioning', 'JDBCProvision', 'PeopleSoftHRMSBuildMap', 'PeopleSoftHRMSOperationProvisioning', 'PeopleSoftHRMSProvision', 'RACFPermissionCustomization', 'ResourceObjectCustomization', 'SAPBuildMap', 'SapHrManagerRule', 'SapHrOperationProvisioning', 'SapHrProvision', 'SuccessFactorsOperationProvisioning', 'WebServiceAfterOperationRule', 'WebServiceBeforeOperationRule' ] | the type of rule | [required]
**signature** | [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional]
**source_code** | [**SourceCode**](source-code) | | [required]
**attributes** | **object** | a map of string to objects | [optional]

35
docs/tools/sdk/python/Reference/V2024/Models/DocumentType.md
View File

@@ -1,35 +0,0 @@
---
id: v2024-document-type
title: DocumentType
pagination_label: DocumentType
sidebar_label: DocumentType
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'DocumentType', 'V2024DocumentType']
slug: /tools/sdk/python/v2024/models/document-type
tags: ['SDK', 'Software Development Kit', 'DocumentType', 'V2024DocumentType']
---
# DocumentType
Enum representing the currently supported document types. Additional values may be added in the future without notice.
## Enum
* `ACCESSPROFILE` (value: `'accessprofile'`)
* `ACCOUNTACTIVITY` (value: `'accountactivity'`)
* `ACCOUNT` (value: `'account'`)
* `AGGREGATION` (value: `'aggregation'`)
* `ENTITLEMENT` (value: `'entitlement'`)
* `EVENT` (value: `'event'`)
* `IDENTITY` (value: `'identity'`)
* `ROLE` (value: `'role'`)
[[Back to top]](#)

29
docs/tools/sdk/python/Reference/V2024/Models/Entitlement.md
View File

@@ -24,6 +24,10 @@ Name | Type | Description | Notes
**description** | **str** | The description of the entitlement | [optional]
**privileged** | **bool** | True if the entitlement is privileged | [optional]
**cloud_governed** | **bool** | True if the entitlement is cloud governed | [optional]
**requestable** | **bool** | True if the entitlement is able to be directly requested | [optional] [default to False]
**owner** | [**EntitlementOwner**](entitlement-owner) | | [optional]
**manually_updated_fields** | **map[string]object** | A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. | [optional]
**access_model_metadata** | [**EntitlementAccessModelMetadata**](entitlement-access-model-metadata) | | [optional]
**created** | **datetime** | Time when the entitlement was created | [optional]
**modified** | **datetime** | Time when the entitlement was last modified | [optional]
**source** | [**EntitlementSource**](entitlement-source) | | [optional]
@@ -46,6 +50,31 @@ source_schema_object_type='group',
description='CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local',
privileged=True,
cloud_governed=True,
requestable=True,
owner=sailpoint.v2024.models.entitlement_owner.Entitlement_owner(
id = '2c9180827ca885d7017ca8ce28a000eb',
type = 'IDENTITY',
name = 'john.doe', ),
manually_updated_fields={DISPLAY_NAME=true, DESCRIPTION=true},
access_model_metadata=sailpoint.v2024.models.entitlement_access_model_metadata.Entitlement_accessModelMetadata(
attributes = [
sailpoint.v2024.models.access_model_metadata.AccessModelMetadata(
key = 'iscCsp',
name = 'CSP',
multiselect = True,
status = 'active',
type = 'governance',
object_types = [
'general'
],
description = 'Indicates the type of deployment environment of an access item.',
values = [
sailpoint.v2024.models.access_model_metadata_values_inner.AccessModelMetadata_values_inner(
value = 'development',
name = 'Development',
status = 'active', )
], )
], ),
created='2020-10-08T18:33:52.029Z',
modified='2020-10-08T18:33:52.029Z',
source=sailpoint.v2024.models.entitlement_source.Entitlement_source(

76
docs/tools/sdk/python/Reference/V2024/Models/Entitlement1.md
View File

@@ -1,76 +0,0 @@
---
id: v2024-entitlement1
title: Entitlement1
pagination_label: Entitlement1
sidebar_label: Entitlement1
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'Entitlement1', 'V2024Entitlement1']
slug: /tools/sdk/python/v2024/models/entitlement1
tags: ['SDK', 'Software Development Kit', 'Entitlement1', 'V2024Entitlement1']
---
# Entitlement1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The entitlement id | [optional]
**name** | **str** | The entitlement name | [optional]
**created** | **datetime** | Time when the entitlement was created | [optional]
**modified** | **datetime** | Time when the entitlement was last modified | [optional]
**attribute** | **str** | The entitlement attribute name | [optional]
**value** | **str** | The value of the entitlement | [optional]
**source_schema_object_type** | **str** | The object type of the entitlement from the source schema | [optional]
**privileged** | **bool** | True if the entitlement is privileged | [optional] [default to False]
**cloud_governed** | **bool** | True if the entitlement is cloud governed | [optional] [default to False]
**description** | **str** | The description of the entitlement | [optional]
**requestable** | **bool** | True if the entitlement is requestable | [optional] [default to False]
**attributes** | **map[string]object** | A map of free-form key-value pairs from the source system | [optional]
**source** | [**Entitlement1Source**](entitlement1-source) | | [optional]
**owner** | [**Entitlement1Owner**](entitlement1-owner) | | [optional]
**direct_permissions** | [**[]PermissionDto**](permission-dto) | | [optional]
**segments** | **[]str** | List of IDs of segments, if any, to which this Entitlement is assigned. | [optional]
**manually_updated_fields** | [**Entitlement1ManuallyUpdatedFields**](entitlement1-manually-updated-fields) | | [optional]
**access_model_metadata** | [**Entitlement1AccessModelMetadata**](entitlement1-access-model-metadata) | | [optional]
}
## Example
```python
from sailpoint.v2024.models.entitlement1 import Entitlement1
entitlement1 = Entitlement1(
id='2c91808874ff91550175097daaec161c',
name='LauncherTest2',
created='2020-10-08T18:33:52.029Z',
modified='2020-10-08T18:33:52.029Z',
attribute='memberOf',
value='CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local',
source_schema_object_type='group',
privileged=True,
cloud_governed=True,
description='CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local',
requestable=True,
attributes={fieldName=fieldValue},
source=sailpoint.v2024.models.entitlement_1_source.Entitlement_1_source(
id = '2c9180827ca885d7017ca8ce28a000eb',
type = 'SOURCE',
name = 'ODS-AD-Source', ),
owner=,
direct_permissions=[
sailpoint.v2024.models.permission_dto.PermissionDto(
rights = [
'SELECT'
],
target = 'SYS.GV_$TRANSACTION', )
],
segments=[f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a],
manually_updated_fields=,
access_model_metadata=
)
```
[[Back to top]](#)

33
docs/tools/sdk/python/Reference/V2024/Models/Entitlement1AccessModelMetadata.md
View File

@@ -1,33 +0,0 @@
---
id: v2024-entitlement1-access-model-metadata
title: Entitlement1AccessModelMetadata
pagination_label: Entitlement1AccessModelMetadata
sidebar_label: Entitlement1AccessModelMetadata
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'Entitlement1AccessModelMetadata', 'V2024Entitlement1AccessModelMetadata']
slug: /tools/sdk/python/v2024/models/entitlement1-access-model-metadata
tags: ['SDK', 'Software Development Kit', 'Entitlement1AccessModelMetadata', 'V2024Entitlement1AccessModelMetadata']
---
# Entitlement1AccessModelMetadata
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attributes** | [**[]AttributeDTO**](attribute-dto) | | [optional]
}
## Example
```python
from sailpoint.v2024.models.entitlement1_access_model_metadata import Entitlement1AccessModelMetadata
entitlement1_access_model_metadata = Entitlement1AccessModelMetadata(
attributes=[{key=iscPrivacy, name=Privacy, multiselect=false, status=active, type=governance, objectTypes=[all], description=Specifies the level of privacy associated with an access item., values=[{value=public, name=Public, status=active}]}]
)
```
[[Back to top]](#)

35
docs/tools/sdk/python/Reference/V2024/Models/Entitlement1ManuallyUpdatedFields.md
View File

@@ -1,35 +0,0 @@
---
id: v2024-entitlement1-manually-updated-fields
title: Entitlement1ManuallyUpdatedFields
pagination_label: Entitlement1ManuallyUpdatedFields
sidebar_label: Entitlement1ManuallyUpdatedFields
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'Entitlement1ManuallyUpdatedFields', 'V2024Entitlement1ManuallyUpdatedFields']
slug: /tools/sdk/python/v2024/models/entitlement1-manually-updated-fields
tags: ['SDK', 'Software Development Kit', 'Entitlement1ManuallyUpdatedFields', 'V2024Entitlement1ManuallyUpdatedFields']
---
# Entitlement1ManuallyUpdatedFields
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**display_name** | **bool** | True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property. | [optional] [default to False]
**description** | **bool** | True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property. | [optional] [default to False]
}
## Example
```python
from sailpoint.v2024.models.entitlement1_manually_updated_fields import Entitlement1ManuallyUpdatedFields
entitlement1_manually_updated_fields = Entitlement1ManuallyUpdatedFields(
display_name=True,
description=True
)
```
[[Back to top]](#)

37
docs/tools/sdk/python/Reference/V2024/Models/Entitlement1Owner.md
View File

@@ -1,37 +0,0 @@
---
id: v2024-entitlement1-owner
title: Entitlement1Owner
pagination_label: Entitlement1Owner
sidebar_label: Entitlement1Owner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'Entitlement1Owner', 'V2024Entitlement1Owner']
slug: /tools/sdk/python/v2024/models/entitlement1-owner
tags: ['SDK', 'Software Development Kit', 'Entitlement1Owner', 'V2024Entitlement1Owner']
---
# Entitlement1Owner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The owner id for the entitlement | [optional]
**name** | **str** | The owner name for the entitlement | [optional]
**type** | **Enum** [ 'IDENTITY' ] | The type of the owner. Initially only type IDENTITY is supported | [optional]
}
## Example
```python
from sailpoint.v2024.models.entitlement1_owner import Entitlement1Owner
entitlement1_owner = Entitlement1Owner(
id='2a2fdacca5e345f18bf7970cfbb8fec2',
name='identity 1',
type='IDENTITY'
)
```
[[Back to top]](#)

37
docs/tools/sdk/python/Reference/V2024/Models/Entitlement1Source.md
View File

@@ -1,37 +0,0 @@
---
id: v2024-entitlement1-source
title: Entitlement1Source
pagination_label: Entitlement1Source
sidebar_label: Entitlement1Source
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'Entitlement1Source', 'V2024Entitlement1Source']
slug: /tools/sdk/python/v2024/models/entitlement1-source
tags: ['SDK', 'Software Development Kit', 'Entitlement1Source', 'V2024Entitlement1Source']
---
# Entitlement1Source
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The source ID | [optional]
**type** | **str** | The source type, will always be \"SOURCE\" | [optional]
**name** | **str** | The source name | [optional]
}
## Example
```python
from sailpoint.v2024.models.entitlement1_source import Entitlement1Source
entitlement1_source = Entitlement1Source(
id='2c9180827ca885d7017ca8ce28a000eb',
type='SOURCE',
name='ODS-AD-Source'
)
```
[[Back to top]](#)

51
docs/tools/sdk/python/Reference/V2024/Models/EntitlementAccessModelMetadata.md Normal file
View File

@@ -0,0 +1,51 @@
---
id: v2024-entitlement-access-model-metadata
title: EntitlementAccessModelMetadata
pagination_label: EntitlementAccessModelMetadata
sidebar_label: EntitlementAccessModelMetadata
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'EntitlementAccessModelMetadata', 'V2024EntitlementAccessModelMetadata']
slug: /tools/sdk/python/v2024/models/entitlement-access-model-metadata
tags: ['SDK', 'Software Development Kit', 'EntitlementAccessModelMetadata', 'V2024EntitlementAccessModelMetadata']
---
# EntitlementAccessModelMetadata
Additional data to classify the entitlement
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attributes** | [**[]AccessModelMetadata**](access-model-metadata) | | [optional]
}
## Example
```python
from sailpoint.v2024.models.entitlement_access_model_metadata import EntitlementAccessModelMetadata
entitlement_access_model_metadata = EntitlementAccessModelMetadata(
attributes=[
sailpoint.v2024.models.access_model_metadata.AccessModelMetadata(
key = 'iscCsp',
name = 'CSP',
multiselect = True,
status = 'active',
type = 'governance',
object_types = [
'general'
],
description = 'Indicates the type of deployment environment of an access item.',
values = [
sailpoint.v2024.models.access_model_metadata_values_inner.AccessModelMetadata_values_inner(
value = 'development',
name = 'Development',
status = 'active', )
], )
]
)
```
[[Back to top]](#)

45
docs/tools/sdk/python/Reference/V2024/Models/EntitlementDocument.md
View File

@@ -17,21 +17,29 @@ Entitlement
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | | [required]
**name** | **str** | | [required]
**type** | [**DocumentType**](document-type) | | [required]
**id** | **str** | ID of the referenced object. | [required]
**name** | **str** | The human readable name of the referenced object. | [required]
**modified** | **datetime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
**synced** | **str** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional]
**display_name** | **str** | Entitlement's display name. | [optional]
**source** | [**EntitlementDocumentAllOfSource**](entitlement-document-all-of-source) | | [optional]
**segments** | [**[]BaseSegment**](base-segment) | Segments with the role. | [optional]
**segments** | [**[]BaseSegment**](base-segment) | Segments with the entitlement. | [optional]
**segment_count** | **int** | Number of segments with the role. | [optional]
**requestable** | **bool** | Indicates whether the entitlement is requestable. | [optional] [default to False]
**cloud_governed** | **bool** | Indicates whether the entitlement is cloud governed. | [optional] [default to False]
**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**privileged** | **bool** | Indicates whether the entitlement is privileged. | [optional] [default to False]
**identity_count** | **int** | Number of identities who have access to the entitlement. | [optional]
**tags** | **[]str** | Tags that have been applied to the object. | [optional]
**attribute** | **str** | Attribute information for the entitlement. | [optional]
**value** | **str** | Value of the entitlement. | [optional]
**source_schema_object_type** | **str** | Source schema object type of the entitlement. | [optional]
**var_schema** | **str** | Schema type of the entitlement. | [optional]
**hash** | **str** | Read-only calculated hash value of an entitlement. | [optional]
**attributes** | **map[string]object** | Attributes of the entitlement. | [optional]
**truncated_attributes** | **[]str** | Truncated attributes of the entitlement. | [optional]
**contains_data_access** | **bool** | Indicates whether the entitlement contains data access. | [optional] [default to False]
**manually_updated_fields** | [**EntitlementDocumentAllOfManuallyUpdatedFields**](entitlement-document-all-of-manually-updated-fields) | | [optional]
**permissions** | [**[]EntitlementDocumentAllOfPermissions**](entitlement-document-all-of-permissions) | | [optional]
}
## Example
@@ -42,13 +50,13 @@ from sailpoint.v2024.models.entitlement_document import EntitlementDocument
entitlement_document = EntitlementDocument(
id='2c91808375d8e80a0175e1f88a575222',
name='john.doe',
type='identity',
modified='2018-06-25T20:22:28.104Z',
synced='',
display_name='Admin',
source=sailpoint.v2024.models.entitlement_document_all_of_source.EntitlementDocument_allOf_source(
id = '2c91808b6e9e6fb8016eec1a2b6f7b5f',
name = 'ODS-HR-Employees', ),
name = 'ODS-HR-Employees',
type = 'SOURCE', ),
segments=[
sailpoint.v2024.models.base_segment.BaseSegment(
id = 'b009b6e3-b56d-41d9-8735-cb532ea0b017',
@@ -59,8 +67,27 @@ requestable=False,
cloud_governed=False,
created='2018-06-25T20:22:28.104Z',
privileged=False,
identity_count=3,
tags=[TAG_1, TAG_2]
tags=[TAG_1, TAG_2],
attribute='groups',
value='1733ff75-441e-4327-9bfc-3ac445fd8cd1',
source_schema_object_type='group',
var_schema='group',
hash='c6fab95235584cca98a454a2f51e5683bc77d6a0',
attributes={ },
truncated_attributes=[
''
],
contains_data_access=True,
manually_updated_fields=sailpoint.v2024.models.entitlement_document_all_of_manually_updated_fields.EntitlementDocument_allOf_manuallyUpdatedFields(
description = False,
display_name = False, ),
permissions=[
sailpoint.v2024.models.entitlement_document_all_of_permissions.EntitlementDocument_allOf_permissions(
target = 'SYS.GV_$TRANSACTION',
rights = [
'SELECT'
], )
]
)
```

36
docs/tools/sdk/python/Reference/V2024/Models/EntitlementDocumentAllOfManuallyUpdatedFields.md Normal file
View File

@@ -0,0 +1,36 @@
---
id: v2024-entitlement-document-all-of-manually-updated-fields
title: EntitlementDocumentAllOfManuallyUpdatedFields
pagination_label: EntitlementDocumentAllOfManuallyUpdatedFields
sidebar_label: EntitlementDocumentAllOfManuallyUpdatedFields
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'EntitlementDocumentAllOfManuallyUpdatedFields', 'V2024EntitlementDocumentAllOfManuallyUpdatedFields']
slug: /tools/sdk/python/v2024/models/entitlement-document-all-of-manually-updated-fields
tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfManuallyUpdatedFields', 'V2024EntitlementDocumentAllOfManuallyUpdatedFields']
---
# EntitlementDocumentAllOfManuallyUpdatedFields
Indicates whether the entitlement's display name and/or description have been manually updated.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **bool** | | [optional] [default to False]
**display_name** | **bool** | | [optional] [default to False]
}
## Example
```python
from sailpoint.v2024.models.entitlement_document_all_of_manually_updated_fields import EntitlementDocumentAllOfManuallyUpdatedFields
entitlement_document_all_of_manually_updated_fields = EntitlementDocumentAllOfManuallyUpdatedFields(
description=False,
display_name=False
)
```
[[Back to top]](#)

37
docs/tools/sdk/python/Reference/V2024/Models/EntitlementDocumentAllOfPermissions.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: v2024-entitlement-document-all-of-permissions
title: EntitlementDocumentAllOfPermissions
pagination_label: EntitlementDocumentAllOfPermissions
sidebar_label: EntitlementDocumentAllOfPermissions
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'EntitlementDocumentAllOfPermissions', 'V2024EntitlementDocumentAllOfPermissions']
slug: /tools/sdk/python/v2024/models/entitlement-document-all-of-permissions
tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfPermissions', 'V2024EntitlementDocumentAllOfPermissions']
---
# EntitlementDocumentAllOfPermissions
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**target** | **str** | The target the permission would grants rights on. | [optional]
**rights** | **[]str** | All the rights (e.g. actions) that this permission allows on the target | [optional]
}
## Example
```python
from sailpoint.v2024.models.entitlement_document_all_of_permissions import EntitlementDocumentAllOfPermissions
entitlement_document_all_of_permissions = EntitlementDocumentAllOfPermissions(
target='SYS.GV_$TRANSACTION',
rights=[
'SELECT'
]
)
```
[[Back to top]](#)

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

@@ -19,6 +19,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | ID of entitlement's source. | [optional]
**name** | **str** | Display name of entitlement's source. | [optional]
**type** | **str** | Type of object. | [optional]
}
## Example
@@ -28,7 +29,8 @@ from sailpoint.v2024.models.entitlement_document_all_of_source import Entitlemen
entitlement_document_all_of_source = EntitlementDocumentAllOfSource(
id='2c91808b6e9e6fb8016eec1a2b6f7b5f',
name='ODS-HR-Employees'
name='ODS-HR-Employees',
type='SOURCE'
)
```

58
docs/tools/sdk/python/Reference/V2024/Models/EntitlementDto.md
View File

@@ -1,58 +0,0 @@
---
id: v2024-entitlement-dto
title: EntitlementDto
pagination_label: EntitlementDto
sidebar_label: EntitlementDto
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'EntitlementDto', 'V2024EntitlementDto']
slug: /tools/sdk/python/v2024/models/entitlement-dto
tags: ['SDK', 'Software Development Kit', 'EntitlementDto', 'V2024EntitlementDto']
---
# EntitlementDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | System-generated unique ID of the Object | [optional] [readonly]
**name** | **str** | Name of the Object | [required]
**created** | **datetime** | Creation date of the Object | [optional] [readonly]
**modified** | **datetime** | Last modification date of the Object | [optional] [readonly]
**attribute** | **str** | Name of the entitlement attribute | [optional]
**value** | **str** | Raw value of the entitlement | [optional]
**description** | **str** | Entitlment description | [optional]
**attributes** | **map[string]object** | Entitlement attributes | [optional]
**source_schema_object_type** | **str** | Schema objectType on the given application that maps to an Account Group | [optional]
**privileged** | **bool** | Determines if this Entitlement is privileged. | [optional]
**cloud_governed** | **bool** | Determines if this Entitlement is goverened in the cloud. | [optional]
**source** | [**EntitlementSource**](entitlement-source) | | [optional]
}
## Example
```python
from sailpoint.v2024.models.entitlement_dto import EntitlementDto
entitlement_dto = EntitlementDto(
id='id12345',
name='aName',
created='2015-05-28T14:07:17Z',
modified='2015-05-28T14:07:17Z',
attribute='authorizationType',
value='CN=Users,dc=sailpoint,dc=com',
description='Active Directory DC',
attributes={GroupType=Security, sAMAccountName=Buyer},
source_schema_object_type='group',
privileged=False,
cloud_governed=False,
source=sailpoint.v2024.models.entitlement_source.EntitlementSource(
type = 'SOURCE',
id = '2c9180835d191a86015d28455b4b232a',
name = 'HR Active Directory', )
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/V2024/Models/EntitlementOwner.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: v2024-entitlement-owner
title: EntitlementOwner
pagination_label: EntitlementOwner
sidebar_label: EntitlementOwner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'EntitlementOwner', 'V2024EntitlementOwner']
slug: /tools/sdk/python/v2024/models/entitlement-owner
tags: ['SDK', 'Software Development Kit', 'EntitlementOwner', 'V2024EntitlementOwner']
---
# EntitlementOwner
The identity that owns the entitlement
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The identity ID | [optional]
**type** | **Enum** [ 'IDENTITY' ] | The type of object | [optional]
**name** | **str** | The display name of the identity | [optional]
}
## Example
```python
from sailpoint.v2024.models.entitlement_owner import EntitlementOwner
entitlement_owner = EntitlementOwner(
id='2c9180827ca885d7017ca8ce28a000eb',
type='IDENTITY',
name='john.doe'
)
```
[[Back to top]](#)

17
docs/tools/sdk/python/Reference/V2024/Models/EntitlementRequestConfig.md
View File

@@ -16,7 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig', 'V2024Enti
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_request_config** | [**EntitlementAccessRequestConfig**](entitlement-access-request-config) | | [optional]
**allow_entitlement_request** | **bool** | If this is true, entitlement requests are allowed. | [optional] [default to False]
**request_comments_required** | **bool** | If this is true, comments are required to submit entitlement requests. | [optional] [default to False]
**denied_comments_required** | **bool** | If this is true, comments are required to reject entitlement requests. | [optional] [default to False]
**grant_request_approval_schemes** | **str** | Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are \"entitlementOwner\", \"sourceOwner\", \"manager\" and \"`workgroup:{id}`\". You can use multiple governance groups (workgroups). | [optional] [default to 'sourceOwner']
}
## Example
@@ -25,14 +28,10 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.entitlement_request_config import EntitlementRequestConfig
entitlement_request_config = EntitlementRequestConfig(
access_request_config=sailpoint.v2024.models.entitlement_access_request_config.EntitlementAccessRequestConfig(
approval_schemes = [
sailpoint.v2024.models.entitlement_approval_scheme.EntitlementApprovalScheme(
approver_type = 'GOVERNANCE_GROUP',
approver_id = 'e3eab852-8315-467f-9de7-70eda97f63c8', )
],
request_comment_required = True,
denial_comment_required = False, )
allow_entitlement_request=True,
request_comments_required=False,
denied_comments_required=False,
grant_request_approval_schemes='sourceOwner'
)
```

39
docs/tools/sdk/python/Reference/V2024/Models/EntitlementRequestConfig1.md
View File

@@ -1,39 +0,0 @@
---
id: v2024-entitlement-request-config1
title: EntitlementRequestConfig1
pagination_label: EntitlementRequestConfig1
sidebar_label: EntitlementRequestConfig1
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'EntitlementRequestConfig1', 'V2024EntitlementRequestConfig1']
slug: /tools/sdk/python/v2024/models/entitlement-request-config1
tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig1', 'V2024EntitlementRequestConfig1']
---
# EntitlementRequestConfig1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**allow_entitlement_request** | **bool** | If this is true, entitlement requests are allowed. | [optional] [default to False]
**request_comments_required** | **bool** | If this is true, comments are required to submit entitlement requests. | [optional] [default to False]
**denied_comments_required** | **bool** | If this is true, comments are required to reject entitlement requests. | [optional] [default to False]
**grant_request_approval_schemes** | **str** | Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are \"entitlementOwner\", \"sourceOwner\", \"manager\" and \"`workgroup:{id}`\". You can use multiple governance groups (workgroups). | [optional] [default to 'sourceOwner']
}
## Example
```python
from sailpoint.v2024.models.entitlement_request_config1 import EntitlementRequestConfig1
entitlement_request_config1 = EntitlementRequestConfig1(
allow_entitlement_request=True,
request_comments_required=False,
denied_comments_required=False,
grant_request_approval_schemes='sourceOwner'
)
```
[[Back to top]](#)

6
docs/tools/sdk/python/Reference/V2024/Models/EntitlementSummary.md
View File

@@ -20,9 +20,9 @@ Name | Type | Description | Notes
**id** | **str** | The unique ID of the referenced object. | [optional]
**name** | **str** | The human readable name of the referenced object. | [optional]
**display_name** | **str** | | [optional]
**type** | [**DtoType**](dto-type) | | [optional]
**description** | **str** | | [optional]
**description** | **str** | Description of access item. | [optional]
**source** | [**Reference**](reference) | | [optional]
**type** | **str** | Type of the access item. | [optional]
**privileged** | **bool** | | [optional]
**attribute** | **str** | | [optional]
**value** | **str** | | [optional]
@@ -38,11 +38,11 @@ entitlement_summary = EntitlementSummary(
id='2c91808568c529c60168cca6f90c1313',
name='John Doe',
display_name='John Q. Doe',
type='IDENTITY',
description='',
source=sailpoint.v2024.models.reference.Reference(
id = '2c91808568c529c60168cca6f90c1313',
name = 'John Doe', ),
type='ENTITLEMENT',
privileged=False,
attribute='memberOf',
value='CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com',

37
docs/tools/sdk/python/Reference/V2024/Models/ErrorMessageDto1.md
View File

@@ -1,37 +0,0 @@
---
id: v2024-error-message-dto1
title: ErrorMessageDto1
pagination_label: ErrorMessageDto1
sidebar_label: ErrorMessageDto1
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ErrorMessageDto1', 'V2024ErrorMessageDto1']
slug: /tools/sdk/python/v2024/models/error-message-dto1
tags: ['SDK', 'Software Development Kit', 'ErrorMessageDto1', 'V2024ErrorMessageDto1']
---
# ErrorMessageDto1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**locale** | **str** | The locale for the message text, a BCP 47 language tag. | [optional]
**locale_origin** | [**LocaleOrigin**](locale-origin) | | [optional]
**text** | **str** | Actual text of the error message in the indicated locale. | [optional]
}
## Example
```python
from sailpoint.v2024.models.error_message_dto1 import ErrorMessageDto1
error_message_dto1 = ErrorMessageDto1(
locale='en-US',
locale_origin='DEFAULT',
text='The request was syntactically correct but its content is semantically invalid.'
)
```
[[Back to top]](#)

28
docs/tools/sdk/python/Reference/V2024/Models/Event.md
View File

@@ -17,15 +17,14 @@ Event
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | | [required]
**name** | **str** | | [required]
**type** | [**DocumentType**](document-type) | | [required]
**id** | **str** | ID of the entitlement. | [optional]
**name** | **str** | Name of the entitlement. | [optional]
**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**synced** | **str** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional]
**action** | **str** | Name of the event as it's displayed in audit reports. | [optional]
**type** | **str** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional]
**actor** | **str** | Name of the actor that generated the event. | [optional]
**target** | **str** | Name of the target, or recipient, of the event. | [optional]
**actor** | [**EventActor**](event-actor) | | [optional]
**target** | [**EventTarget**](event-target) | | [optional]
**stack** | **str** | The event's stack. | [optional]
**tracking_number** | **str** | ID of the group of events. | [optional]
**ip_address** | **str** | Target system's IP address. | [optional]
@@ -44,14 +43,15 @@ from sailpoint.v2024.models.event import Event
event = Event(
id='2c91808375d8e80a0175e1f88a575222',
name='john.doe',
type='identity',
name='Add Entitlement Passed',
created='2018-06-25T20:22:28.104Z',
synced='',
action='update',
type='SYSTEM_CONFIG',
actor='System',
target='Carol.Adams',
synced='2018-06-25T20:22:28.104Z',
action='AddEntitlement',
type='ACCESS_ITEM',
actor=sailpoint.v2024.models.event_actor.Event_actor(
name = 'System', ),
target=sailpoint.v2024.models.event_target.Event_target(
name = 'Carol.Adams', ),
stack='tpe',
tracking_number='63f891e0735f4cc8bf1968144a1e7440',
ip_address='52.52.97.85',
@@ -60,9 +60,9 @@ attributes={pod=stg03-useast1, org=acme, sourceName=SailPoint},
objects=[
'AUTHENTICATION'
],
operation='REQUEST',
operation='ADD',
status='PASSED',
technical_name='AUTHENTICATION_REQUEST_PASSED'
technical_name='ENTITLEMENT_ADD_PASSED'
)
```

33
docs/tools/sdk/python/Reference/V2024/Models/EventActor.md Normal file
View File

@@ -0,0 +1,33 @@
---
id: v2024-event-actor
title: EventActor
pagination_label: EventActor
sidebar_label: EventActor
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'EventActor', 'V2024EventActor']
slug: /tools/sdk/python/v2024/models/event-actor
tags: ['SDK', 'Software Development Kit', 'EventActor', 'V2024EventActor']
---
# EventActor
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Name of the actor that generated the event. | [optional]
}
## Example
```python
from sailpoint.v2024.models.event_actor import EventActor
event_actor = EventActor(
name='System'
)
```
[[Back to top]](#)

28
docs/tools/sdk/python/Reference/V2024/Models/EventDocument.md
View File

@@ -17,15 +17,14 @@ Event
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | | [required]
**name** | **str** | | [required]
**type** | [**DocumentType**](document-type) | | [required]
**id** | **str** | ID of the entitlement. | [optional]
**name** | **str** | Name of the entitlement. | [optional]
**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**synced** | **str** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional]
**action** | **str** | Name of the event as it's displayed in audit reports. | [optional]
**type** | **str** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional]
**actor** | **str** | Name of the actor that generated the event. | [optional]
**target** | **str** | Name of the target, or recipient, of the event. | [optional]
**actor** | [**EventActor**](event-actor) | | [optional]
**target** | [**EventTarget**](event-target) | | [optional]
**stack** | **str** | The event's stack. | [optional]
**tracking_number** | **str** | ID of the group of events. | [optional]
**ip_address** | **str** | Target system's IP address. | [optional]
@@ -44,14 +43,15 @@ from sailpoint.v2024.models.event_document import EventDocument
event_document = EventDocument(
id='2c91808375d8e80a0175e1f88a575222',
name='john.doe',
type='identity',
name='Add Entitlement Passed',
created='2018-06-25T20:22:28.104Z',
synced='',
action='update',
type='SYSTEM_CONFIG',
actor='System',
target='Carol.Adams',
synced='2018-06-25T20:22:28.104Z',
action='AddEntitlement',
type='ACCESS_ITEM',
actor=sailpoint.v2024.models.event_actor.Event_actor(
name = 'System', ),
target=sailpoint.v2024.models.event_target.Event_target(
name = 'Carol.Adams', ),
stack='tpe',
tracking_number='63f891e0735f4cc8bf1968144a1e7440',
ip_address='52.52.97.85',
@@ -60,9 +60,9 @@ attributes={pod=stg03-useast1, org=acme, sourceName=SailPoint},
objects=[
'AUTHENTICATION'
],
operation='REQUEST',
operation='ADD',
status='PASSED',
technical_name='AUTHENTICATION_REQUEST_PASSED'
technical_name='ENTITLEMENT_ADD_PASSED'
)
```

33
docs/tools/sdk/python/Reference/V2024/Models/EventTarget.md Normal file
View File

@@ -0,0 +1,33 @@
---
id: v2024-event-target
title: EventTarget
pagination_label: EventTarget
sidebar_label: EventTarget
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'EventTarget', 'V2024EventTarget']
slug: /tools/sdk/python/v2024/models/event-target
tags: ['SDK', 'Software Development Kit', 'EventTarget', 'V2024EventTarget']
---
# EventTarget
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Name of the target, or recipient, of the event. | [optional]
}
## Example
```python
from sailpoint.v2024.models.event_target import EventTarget
event_target = EventTarget(
name='Carol.Adams'
)
```
[[Back to top]](#)

20
docs/tools/sdk/python/Reference/V2024/Models/ExpansionItem.md
View File

@@ -17,10 +17,12 @@ tags: ['SDK', 'Software Development Kit', 'ExpansionItem', 'V2024ExpansionItem']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**account_id** | **str** | The ID of the account | [optional]
**cause** | **str** | | [optional]
**cause** | **str** | Cause of the expansion item. | [optional]
**name** | **str** | The name of the item | [optional]
**attribute_requests** | [**[]AttributeRequest**](attribute-request) | | [optional]
**attribute_request** | [**AttributeRequest**](attribute-request) | | [optional]
**source** | [**AccountSource**](account-source) | | [optional]
**id** | **str** | ID of the expansion item | [optional]
**state** | **str** | State of the expansion item | [optional]
}
## Example
@@ -32,13 +34,13 @@ expansion_item = ExpansionItem(
account_id='2c91808981f58ea601821c3e93482e6f',
cause='Role',
name='smartsheet-role',
attribute_requests=[
sailpoint.v2024.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = '3203537556531076', )
],
source=
attribute_request=sailpoint.v2024.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = null, ),
source=,
id='ac2887ffe0e7435a8c18c73f7ae94c7b',
state='EXECUTING'
)
```

41
docs/tools/sdk/python/Reference/V2024/Models/ExportOptions1.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: v2024-export-options1
title: ExportOptions1
pagination_label: ExportOptions1
sidebar_label: ExportOptions1
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ExportOptions1', 'V2024ExportOptions1']
slug: /tools/sdk/python/v2024/models/export-options1
tags: ['SDK', 'Software Development Kit', 'ExportOptions1', 'V2024ExportOptions1']
---
# ExportOptions1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**exclude_types** | **[]str** | Object type names to be excluded from an sp-config export command. | [optional]
**include_types** | **[]str** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional]
**object_options** | [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional]
}
## Example
```python
from sailpoint.v2024.models.export_options1 import ExportOptions1
export_options1 = ExportOptions1(
exclude_types=[
'SOURCE'
],
include_types=[
'TRIGGER_SUBSCRIPTION'
],
object_options={TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}}
)
```
[[Back to top]](#)

3
docs/tools/sdk/python/Reference/V2024/Models/GetActiveCampaigns200ResponseInner.md
View File

@@ -94,7 +94,8 @@ search_campaign_info=sailpoint.v2024.models.campaign_all_of_search_campaign_info
operator = 'SELECTED', )
], ),
role_composition_campaign_info=sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info.Campaign_allOf_roleCompositionCampaignInfo(
reviewer = sailpoint.v2024.models.campaign_all_of_search_campaign_info_reviewer.Campaign_allOf_searchCampaignInfo_reviewer(
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', ),

50
docs/tools/sdk/python/Reference/V2024/Models/GetRoleAssignments200ResponseInner.md
View File

@@ -17,12 +17,12 @@ tags: ['SDK', 'Software Development Kit', 'GetRoleAssignments200ResponseInner',
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Assignment Id | [optional]
**role** | [**BaseReferenceDto1**](base-reference-dto1) | | [optional]
**role** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
**comments** | **str** | Comments added by the user when the assignment was made | [optional]
**assignment_source** | **str** | Source describing how this assignment was made | [optional]
**assigner** | [**BaseReferenceDto1**](base-reference-dto1) | | [optional]
**assigned_dimensions** | [**[]BaseReferenceDto1**](base-reference-dto1) | Dimensions assigned related to this role | [optional]
**assignment_context** | [**AssignmentContextDto**](assignment-context-dto) | | [optional]
**assigner** | [**RoleAssignmentDtoAssigner**](role-assignment-dto-assigner) | | [optional]
**assigned_dimensions** | [**[]BaseReferenceDto**](base-reference-dto) | Dimensions assigned related to this role | [optional]
**assignment_context** | [**RoleAssignmentDtoAssignmentContext**](role-assignment-dto-assignment-context) | | [optional]
**account_targets** | [**[]RoleTargetDto**](role-target-dto) | | [optional]
**remove_date** | **str** | Date that the assignment will be removed | [optional]
}
@@ -34,40 +34,24 @@ from sailpoint.v2024.models.get_role_assignments200_response_inner import GetRol
get_role_assignments200_response_inner = GetRoleAssignments200ResponseInner(
id='1cbb0705b38c4226b1334eadd8874086',
role=sailpoint.v2024.models.base_reference_dto_1.BaseReferenceDto_1(
id = 'ff8081814d977c21014da056804a0af3',
name = 'Github', ),
role=sailpoint.v2024.models.base_reference_dto.BaseReferenceDto(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', ),
comments='I'm a new Engineer and need this role to do my work',
assignment_source='UI',
assigner=sailpoint.v2024.models.base_reference_dto_1.BaseReferenceDto_1(
id = 'ff8081814d977c21014da056804a0af3',
name = 'Github', ),
assigner=sailpoint.v2024.models.role_assignment_dto_assigner.RoleAssignmentDto_assigner(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', ),
assigned_dimensions=[{id=1acc8ffe5fcf457090de28bee2af36ee, type=DIMENSION, name=Northeast region}],
assignment_context=sailpoint.v2024.models.assignment_context_dto.AssignmentContextDto(
requested = sailpoint.v2024.models.access_request_context.AccessRequestContext(
context_attributes = [
sailpoint.v2024.models.context_attribute_dto.ContextAttributeDto(
attribute = 'location',
value = Austin,
derived = False, )
], ),
matched = [
sailpoint.v2024.models.role_match_dto.RoleMatchDto(
role_ref = sailpoint.v2024.models.base_reference_dto_1.BaseReferenceDto_1(
id = 'ff8081814d977c21014da056804a0af3',
name = 'Github', ),
matched_attributes = [
sailpoint.v2024.models.context_attribute_dto.ContextAttributeDto(
attribute = 'location',
derived = False, )
], )
],
computed_date = 'Wed Feb 14 10:58:42', ),
assignment_context={requested={contextAttributes=[{attribute=department, value=Engineering, derived=false}]}, matched=[{id=e7697a1e96d04db1ac7b0f4544915d2c, type=DIMENSION, name=Engineer}], computedDate=Wed Feb 14 10:58:42},
account_targets=[
sailpoint.v2024.models.role_target_dto.RoleTargetDto(
source = sailpoint.v2024.models.base_reference_dto_1.BaseReferenceDto_1(
id = 'ff8081814d977c21014da056804a0af3',
name = 'Github', ),
source = sailpoint.v2024.models.base_reference_dto.BaseReferenceDto(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', ),
account_info = sailpoint.v2024.models.account_info_dto.AccountInfoDto(
native_identity = 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com',
display_name = 'Abby.Smith',

6
docs/tools/sdk/python/Reference/V2024/Models/IdentityAccess.md
View File

@@ -19,8 +19,8 @@ Name | Type | Description | Notes
**id** | **str** | The unique ID of the referenced object. | [optional]
**name** | **str** | The human readable name of the referenced object. | [optional]
**display_name** | **str** | | [optional]
**type** | [**DtoType**](dto-type) | | [optional]
**description** | **str** | | [optional]
**description** | **str** | Description of access item. | [optional]
**type** | **str** | Type of the access item. | [optional]
**source** | [**Reference**](reference) | | [optional]
**owner** | [**DisplayReference**](display-reference) | | [optional]
**revocable** | **bool** | | [optional]
@@ -40,8 +40,8 @@ identity_access = IdentityAccess(
id='2c91808568c529c60168cca6f90c1313',
name='John Doe',
display_name='John Q. Doe',
type='IDENTITY',
description='',
type='ROLE',
source=sailpoint.v2024.models.reference.Reference(
id = '2c91808568c529c60168cca6f90c1313',
name = 'John Doe', ),

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

@@ -17,7 +17,7 @@ Defines all the identity attribute mapping configurations. This defines how to g
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **bool** | The backend will only promote values if the profile/mapping is enabled. | [optional] [default to False]
**enabled** | **bool** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to False]
**attribute_transforms** | [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional]
}

9
docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributePreview.md
View File

@@ -19,7 +19,7 @@ Name | Type | Description | Notes
**name** | **str** | Name of the attribute that is being previewed. | [optional]
**value** | **str** | Value that was derived during the preview. | [optional]
**previous_value** | **str** | The value of the attribute before the preview. | [optional]
**error_messages** | [**[]ErrorMessageDto**](error-message-dto) | | [optional]
**error_messages** | [**[]ErrorMessageDto**](error-message-dto) | List of error messages | [optional]
}
## Example
@@ -31,12 +31,7 @@ identity_attribute_preview = IdentityAttributePreview(
name='email',
value='email@mail.com',
previous_value='oldEmail@mail.com',
error_messages=[
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.', )
]
error_messages={locale=en-US, localeOrigin=DEFAULT, text=Error Message}
)
```

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

@@ -11,13 +11,13 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'V2024Id
# IdentityAttributeTransform
Defines a transformation definition for an identity attribute.
Transform definition for an identity attribute.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identity_attribute_name** | **str** | Name of the identity attribute. | [optional]
**identity_attribute_name** | **str** | Identity attribute's name. | [optional]
**transform_definition** | [**TransformDefinition**](transform-definition) | | [optional]
}

16
docs/tools/sdk/python/Reference/V2024/Models/IdentityDocument.md
View File

@@ -19,7 +19,6 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique ID of the referenced object. | [required]
**name** | **str** | The human readable name of the referenced object. | [required]
**type** | [**DocumentType**](document-type) | | [required]
**display_name** | **str** | Identity's display name. | [optional]
**first_name** | **str** | Identity's first name. | [optional]
**last_name** | **str** | Identity's last name. | [optional]
@@ -37,6 +36,8 @@ Name | Type | Description | Notes
**identity_profile** | [**IdentityDocumentAllOfIdentityProfile**](identity-document-all-of-identity-profile) | | [optional]
**source** | [**IdentityDocumentAllOfSource**](identity-document-all-of-source) | | [optional]
**attributes** | **map[string]object** | Map or dictionary of key/value pairs. | [optional]
**disabled** | **bool** | Indicates whether the identity is disabled. | [optional] [default to False]
**locked** | **bool** | Indicates whether the identity is locked. | [optional] [default to False]
**processing_state** | **str** | Identity's processing state. | [optional]
**processing_details** | [**ProcessingDetails**](processing-details) | | [optional]
**accounts** | [**[]BaseAccount**](base-account) | List of accounts associated with the identity. | [optional]
@@ -51,6 +52,9 @@ Name | Type | Description | Notes
**owns** | [**[]Owns**](owns) | Access items the identity owns. | [optional]
**owns_count** | **int** | Number of access items the identity owns. | [optional]
**tags** | **[]str** | Tags that have been applied to the object. | [optional]
**tags_count** | **int** | Number of tags on the identity. | [optional]
**visible_segments** | **[]str** | List of segments that the identity is in. | [optional]
**visible_segment_count** | **int** | Number of segments the identity is in. | [optional]
}
## Example
@@ -61,7 +65,6 @@ from sailpoint.v2024.models.identity_document import IdentityDocument
identity_document = IdentityDocument(
id='2c91808568c529c60168cca6f90c1313',
name='John Doe',
type='identity',
display_name='Carol.Adams',
first_name='Carol',
last_name='Adams',
@@ -86,7 +89,9 @@ source=sailpoint.v2024.models.identity_document_all_of_source.IdentityDocument_a
id = '2c91808b6e9e6fb8016eec1a2b6f7b5f',
name = 'ODS-HR-Employees', ),
attributes={country=US, firstname=Carol, cloudStatus=UNREGISTERED},
processing_state='',
disabled=False,
locked=False,
processing_state='ERROR',
processing_details=sailpoint.v2024.models.processing_details.ProcessingDetails(
date = '2018-06-25T20:22:28.104Z',
stage = 'In Process',
@@ -135,7 +140,10 @@ owns=[
fallback_approver = False, )
],
owns_count=5,
tags=[TAG_1, TAG_2]
tags=[TAG_1, TAG_2],
tags_count=56,
visible_segments=[All Employees],
visible_segment_count=1
)
```

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

@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'V
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**task_result_id** | **str** | The id of the task result. | [optional]
**report_name** | **str** | The name of the report. | [optional]
**task_result_id** | **str** | Task result ID. | [optional]
**report_name** | **str** | Report name. | [optional]
}
## Example

7
docs/tools/sdk/python/Reference/V2024/Models/IdentityPreviewResponse.md
View File

@@ -35,12 +35,7 @@ preview_attributes=[
name = 'email',
value = 'email@mail.com',
previous_value = 'oldEmail@mail.com',
error_messages = [
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.', )
], )
error_messages = {locale=en-US, localeOrigin=DEFAULT, text=Error Message}, )
]
)

10
docs/tools/sdk/python/Reference/V2024/Models/IdentityProfile.md
View File

@@ -20,15 +20,15 @@ Name | Type | Description | Notes
**name** | **str** | Name of the Object | [required]
**created** | **datetime** | Creation date of the Object | [optional] [readonly]
**modified** | **datetime** | Last modification date of the Object | [optional] [readonly]
**description** | **str** | The description of the Identity Profile. | [optional]
**description** | **str** | Identity profile's description. | [optional]
**owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional]
**priority** | **int** | The priority for an Identity Profile. | [optional]
**priority** | **int** | Identity profile's priority. | [optional]
**authoritative_source** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | [required]
**identity_refresh_required** | **bool** | True if a identity refresh is needed. Typically triggered when a change on the source has been made. | [optional] [default to False]
**identity_count** | **int** | The number of identities that belong to the Identity Profile. | [optional]
**identity_refresh_required** | **bool** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to False]
**identity_count** | **int** | Number of identities belonging to the identity profile. | [optional]
**identity_attribute_config** | [**IdentityAttributeConfig**](identity-attribute-config) | | [optional]
**identity_exception_report_reference** | [**IdentityExceptionReportReference**](identity-exception-report-reference) | | [optional]
**has_time_based_attr** | **bool** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to False]
**has_time_based_attr** | **bool** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to False]
}
## Example

6
docs/tools/sdk/python/Reference/V2024/Models/IdentityProfileAllOfAuthoritativeSource.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSour
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'SOURCE' ] | Type of the object to which this reference applies | [optional]
**id** | **str** | ID of the object to which this reference applies | [optional]
**name** | **str** | Human-readable display name of the object to which this reference applies | [optional]
**type** | **Enum** [ 'SOURCE' ] | Authoritative source's object type. | [optional]
**id** | **str** | Authoritative source's ID. | [optional]
**name** | **str** | Authoritative source's name. | [optional]
}
## Example

8
docs/tools/sdk/python/Reference/V2024/Models/IdentityProfileAllOfOwner.md
View File

@@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'V2024Ide
# IdentityProfileAllOfOwner
The owner of the Identity Profile.
Identity profile's owner.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | Type of the object to which this reference applies | [optional]
**id** | **str** | ID of the object to which this reference applies | [optional]
**name** | **str** | Human-readable display name of the object to which this reference applies | [optional]
**type** | **Enum** [ 'IDENTITY' ] | Owner's object type. | [optional]
**id** | **str** | Owner's ID. | [optional]
**name** | **str** | Owner's name. | [optional]
}
## Example

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

@@ -17,7 +17,7 @@ Object created or updated by import.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY_OBJECT_CONFIG', 'IDENTITY_PROFILE', 'RULE', 'SOURCE', 'TRANSFORM', 'TRIGGER_SUBSCRIPTION' ] | DTO type of object created or updated by import. | [optional]
**type** | **Enum** [ 'CONNECTOR_RULE', 'IDENTITY_OBJECT_CONFIG', 'IDENTITY_PROFILE', 'RULE', 'SOURCE', 'TRANSFORM', 'TRIGGER_SUBSCRIPTION' ] | DTO type of object created or updated by import. | [optional]
**id** | **str** | ID of object created or updated by import. | [optional]
**name** | **str** | Display name of object created or updated by import. | [optional]
}

47
docs/tools/sdk/python/Reference/V2024/Models/ListDeploys200Response.md Normal file
View File

@@ -0,0 +1,47 @@
---
id: v2024-list-deploys200-response
title: ListDeploys200Response
pagination_label: ListDeploys200Response
sidebar_label: ListDeploys200Response
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ListDeploys200Response', 'V2024ListDeploys200Response']
slug: /tools/sdk/python/v2024/models/list-deploys200-response
tags: ['SDK', 'Software Development Kit', 'ListDeploys200Response', 'V2024ListDeploys200Response']
---
# ListDeploys200Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**items** | [**[]DeployResponse**](deploy-response) | list of deployments | [optional]
}
## Example
```python
from sailpoint.v2024.models.list_deploys200_response import ListDeploys200Response
list_deploys200_response = ListDeploys200Response(
items=[
sailpoint.v2024.models.deploy_response.DeployResponse(
job_id = '07659d7d-2cce-47c0-9e49-185787ee565a',
status = 'COMPLETE',
type = 'CONFIG_DEPLOY_DRAFT',
message = 'Deploy creation message',
requester_name = 'requester.name',
file_exists = True,
created = '2021-05-11T22:23:16Z',
modified = '2021-05-11T22:23:16Z',
completed = '2021-05-11T22:23:16Z',
draft_id = '07659d7d-2cce-47c0-9e49-185787ee565a',
draft_name = 'Draft Name',
cloud_storage_status = 'SYNCED', )
]
)
```
[[Back to top]](#)

73
docs/tools/sdk/python/Reference/V2024/Models/MachineAccount.md Normal file
View File

@@ -0,0 +1,73 @@
---
id: v2024-machine-account
title: MachineAccount
pagination_label: MachineAccount
sidebar_label: MachineAccount
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'MachineAccount', 'V2024MachineAccount']
slug: /tools/sdk/python/v2024/models/machine-account
tags: ['SDK', 'Software Development Kit', 'MachineAccount', 'V2024MachineAccount']
---
# MachineAccount
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | System-generated unique ID of the Object | [optional] [readonly]
**name** | **str** | Name of the Object | [required]
**created** | **datetime** | Creation date of the Object | [optional] [readonly]
**modified** | **datetime** | Last modification date of the Object | [optional] [readonly]
**description** | **str** | A description of the machine account | [optional]
**native_identity** | **str** | The unique ID of the machine account generated by the source system | [required]
**uuid** | **str** | The unique ID of the account as determined by the account schema | [optional]
**classification_method** | **Enum** [ 'SOURCE', 'CRITERIA', 'DISCOVERY', 'MANUAL' ] | Classification Method | [required]
**machine_identity** | **object** | The machine identity this account is associated with | [optional]
**owner_identity** | **object** | The identity who owns this account. | [optional]
**access_type** | **str** | The connection type of the source this account is from | [optional]
**subtype** | **str** | The sub-type | [optional]
**environment** | **str** | Environment | [optional]
**attributes** | **map[string]object** | Custom attributes specific to the machine account | [optional]
**connector_attributes** | **map[string]object** | The connector attributes for the account | [required]
**manually_correlated** | **bool** | Indicates if the account has been manually correlated to an identity | [optional] [default to False]
**manually_edited** | **bool** | Indicates if the account has been manually edited | [required][default to False]
**locked** | **bool** | Indicates if the account is currently locked | [required]
**enabled** | **bool** | Indicates if the account is enabled | [required][default to False]
**has_entitlements** | **bool** | Indicates if the account has entitlements | [required][default to True]
**source** | **object** | The source this machine account belongs to. | [required]
}
## Example
```python
from sailpoint.v2024.models.machine_account import MachineAccount
machine_account = MachineAccount(
id='id12345',
name='aName',
created='2015-05-28T14:07:17Z',
modified='2015-05-28T14:07:17Z',
description='Service account for Active Directory',
native_identity='552775',
uuid='{b0dce506-d6d4-44d2-8a32-d9a5b21fb175}',
classification_method='SOURCE',
machine_identity={id=1540e5a4-6c2e-4bf1-b88e-c08cae0696e9, type=MACHINE_IDENTITY, name=SVC_ADService},
owner_identity={id=2c918084660f45d6016617daa9210584, type=IDENTITY, name=Adam Kennedy},
access_type='direct',
subtype='',
environment='TEST',
attributes={firstName=SailPoint, lastName=Support, displayName=SailPoint Support},
connector_attributes={mail=machine-178@sailpoint.com, givenName=Support, displayName=SailPoint Support},
manually_correlated=True,
manually_edited=True,
locked=False,
enabled=False,
has_entitlements=False,
source={id=8d3e0094e99445de98eef6c75e25jc04, type=SOURCE, name=Active Directory}
)
```
[[Back to top]](#)

47
docs/tools/sdk/python/Reference/V2024/Models/MachineIdentity.md Normal file
View File

@@ -0,0 +1,47 @@
---
id: v2024-machine-identity
title: MachineIdentity
pagination_label: MachineIdentity
sidebar_label: MachineIdentity
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'MachineIdentity', 'V2024MachineIdentity']
slug: /tools/sdk/python/v2024/models/machine-identity
tags: ['SDK', 'Software Development Kit', 'MachineIdentity', 'V2024MachineIdentity']
---
# MachineIdentity
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | System-generated unique ID of the Object | [optional] [readonly]
**name** | **str** | Name of the Object | [required]
**created** | **datetime** | Creation date of the Object | [optional] [readonly]
**modified** | **datetime** | Last modification date of the Object | [optional] [readonly]
**business_application** | **str** | The business application that the identity represents | [required]
**description** | **str** | Description of machine identity | [optional]
**manually_edited** | **bool** | Indicates if the machine identity has been manually edited | [optional] [default to False]
**attributes** | **object** | A map of custom machine identity attributes | [optional]
}
## Example
```python
from sailpoint.v2024.models.machine_identity import MachineIdentity
machine_identity = MachineIdentity(
id='id12345',
name='aName',
created='2015-05-28T14:07:17Z',
modified='2015-05-28T14:07:17Z',
business_application='ADService',
description='',
manually_edited=True,
attributes={"Region":"EU"}
)
```
[[Back to top]](#)

57
docs/tools/sdk/python/Reference/V2024/Models/ManualWorkItemDetails1.md
View File

@@ -1,57 +0,0 @@
---
id: v2024-manual-work-item-details1
title: ManualWorkItemDetails1
pagination_label: ManualWorkItemDetails1
sidebar_label: ManualWorkItemDetails1
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ManualWorkItemDetails1', 'V2024ManualWorkItemDetails1']
slug: /tools/sdk/python/v2024/models/manual-work-item-details1
tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetails1', 'V2024ManualWorkItemDetails1']
---
# ManualWorkItemDetails1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**forwarded** | **bool** | True if the request for this item was forwarded from one owner to another. | [optional] [default to False]
**original_owner** | [**ManualWorkItemDetailsOriginalOwner**](manual-work-item-details-original-owner) | | [optional]
**current_owner** | [**ManualWorkItemDetailsCurrentOwner**](manual-work-item-details-current-owner) | | [optional]
**modified** | **datetime** | Time at which item was modified. | [optional]
**status** | [**ManualWorkItemState**](manual-work-item-state) | | [optional]
**forward_history** | [**[]ApprovalForwardHistory1**](approval-forward-history1) | The history of approval forward action. | [optional]
}
## Example
```python
from sailpoint.v2024.models.manual_work_item_details1 import ManualWorkItemDetails1
manual_work_item_details1 = ManualWorkItemDetails1(
forwarded=True,
original_owner=sailpoint.v2024.models.manual_work_item_details_original_owner.ManualWorkItemDetails_originalOwner(
type = 'IDENTITY',
id = '2c7180a46faadee4016fb4e018c20642',
name = 'Michael Michaels', ),
current_owner=sailpoint.v2024.models.manual_work_item_details_current_owner.ManualWorkItemDetails_currentOwner(
type = 'IDENTITY',
id = '2c3780a46faadee4016fb4e018c20652',
name = 'Allen Albertson', ),
modified='2019-08-23T18:52:57.398Z',
status='PENDING',
forward_history=[
sailpoint.v2024.models.approval_forward_history_1.ApprovalForwardHistory_1(
old_approver_name = 'Frank Mir',
new_approver_name = 'Al Volta',
comment = 'Forwarding from Frank to Al',
modified = '2019-08-23T18:52:57.398Z',
forwarder_name = 'William Wilson',
reassignment_type = 'AUTOMATIC_REASSIGNMENT', )
]
)
```
[[Back to top]](#)

35
docs/tools/sdk/python/Reference/V2024/Models/ManuallyUpdatedFieldsDTO.md
View File

@@ -1,35 +0,0 @@
---
id: v2024-manually-updated-fields-dto
title: ManuallyUpdatedFieldsDTO
pagination_label: ManuallyUpdatedFieldsDTO
sidebar_label: ManuallyUpdatedFieldsDTO
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ManuallyUpdatedFieldsDTO', 'V2024ManuallyUpdatedFieldsDTO']
slug: /tools/sdk/python/v2024/models/manually-updated-fields-dto
tags: ['SDK', 'Software Development Kit', 'ManuallyUpdatedFieldsDTO', 'V2024ManuallyUpdatedFieldsDTO']
---
# ManuallyUpdatedFieldsDTO
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**display_name** | **bool** | True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property. | [optional] [default to False]
**description** | **bool** | True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property. | [optional] [default to False]
}
## Example
```python
from sailpoint.v2024.models.manually_updated_fields_dto import ManuallyUpdatedFieldsDTO
manually_updated_fields_dto = ManuallyUpdatedFieldsDTO(
display_name=True,
description=True
)
```
[[Back to top]](#)

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

@@ -24,7 +24,7 @@ Name | Type | Description | Notes
**account_managers** | [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional]
**modified** | **datetime** | When the request was last modified. | [optional]
**created** | **datetime** | When the request was created. | [optional]
**non_employee_count** | **int** | Number of non-employee records associated with this source. | [optional]
**non_employee_count** | **int** | Number of non-employee records associated with this source. This value is 'NULL' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to 'true'. | [optional]
}
## Example

5
docs/tools/sdk/python/Reference/V2024/Models/OriginalRequest.md
View File

@@ -17,6 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'OriginalRequest', 'V2024OriginalReque
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**account_id** | **str** | Account ID. | [optional]
**result** | [**Result**](result) | | [optional]
**attribute_requests** | [**[]AttributeRequest**](attribute-request) | Attribute changes requested for account. | [optional]
**op** | **str** | Operation used. | [optional]
**source** | [**AccountSource**](account-source) | | [optional]
@@ -29,11 +30,13 @@ from sailpoint.v2024.models.original_request import OriginalRequest
original_request = OriginalRequest(
account_id='CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com',
result=sailpoint.v2024.models.result.Result(
status = 'Manual Task Created', ),
attribute_requests=[
sailpoint.v2024.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = '3203537556531076', )
value = null, )
],
op='add',
source=

10
docs/tools/sdk/python/Reference/V2024/Models/OutlierContributingFeature.md
View File

@@ -18,8 +18,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Contributing feature id | [optional]
**name** | **str** | The name of the feature | [optional]
**value_type** | **Enum** [ 'INTEGER', 'FLOAT' ] | The data type of the value field | [optional]
**value** | [**OutlierContributingFeatureValue**](outlier-contributing-feature-value) | | [optional]
**value_type** | [**OutlierValueType**](outlier-value-type) | | [optional]
**value** | **float** | The feature value | [optional]
**importance** | **float** | The importance of the feature. This can also be a negative value | [optional]
**display_name** | **str** | The (translated if header is passed) displayName for the feature | [optional]
**description** | **str** | The (translated if header is passed) description for the feature | [optional]
@@ -34,8 +34,10 @@ from sailpoint.v2024.models.outlier_contributing_feature import OutlierContribut
outlier_contributing_feature = OutlierContributingFeature(
id='66e38828-5017-47af-92ff-9844871352c5',
name='entitlement_count',
value_type='INTEGER',
value=0.92,
value_type=sailpoint.v2024.models.outlier_value_type.OutlierValueType(
name = 'INTEGER',
ordinal = 0, ),
value=1.0,
importance=-0.15,
display_name='Number of entitlements',
description='The total number of entitlements belonging to an identity',

32
docs/tools/sdk/python/Reference/V2024/Models/OutlierContributingFeatureValue.md
View File

@@ -1,32 +0,0 @@
---
id: v2024-outlier-contributing-feature-value
title: OutlierContributingFeatureValue
pagination_label: OutlierContributingFeatureValue
sidebar_label: OutlierContributingFeatureValue
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'OutlierContributingFeatureValue', 'V2024OutlierContributingFeatureValue']
slug: /tools/sdk/python/v2024/models/outlier-contributing-feature-value
tags: ['SDK', 'Software Development Kit', 'OutlierContributingFeatureValue', 'V2024OutlierContributingFeatureValue']
---
# OutlierContributingFeatureValue
The feature value
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
}
## Example
```python
from sailpoint.v2024.models.outlier_contributing_feature_value import OutlierContributingFeatureValue
outlier_contributing_feature_value = OutlierContributingFeatureValue(
)
```
[[Back to top]](#)

Some files were not shown because too many files have changed in this diff Show More