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

starting point for adding python sdk docs

Browse Source
This commit is contained in:
darrell-thobe-sp
2025-02-20 12:59:19 -05:00
parent 3b9e39ca19
commit c18583ede4
2726 changed files with 370294 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
docs/tools/sdk/python/Reference/Beta/Models/AccessConstraint.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-access-constraint
title: AccessConstraint
pagination_label: AccessConstraint
sidebar_label: AccessConstraint
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessConstraint', 'BetaAccessConstraint']
slug: /tools/sdk/python/beta/models/access-constraint
tags: ['SDK', 'Software Development Kit', 'AccessConstraint', 'BetaAccessConstraint']
---
# AccessConstraint
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'ENTITLEMENT', 'ACCESS_PROFILE', 'ROLE' ] | Type of Access | [required]
**ids** | **[]str** | Must be set only if operator is SELECTED. | [optional]
**operator** | **Enum** [ 'ALL', 'SELECTED' ] | Used to determine whether the scope of the campaign should be reduced for selected ids or all. | [required]
}
## Example
```python
from sailpoint.beta.models.access_constraint import AccessConstraint
access_constraint = AccessConstraint(
type='ENTITLEMENT',
ids=[2c90ad2a70ace7d50170acf22ca90010],
operator='SELECTED'
)
```
[[Back to top]](#)

35
docs/tools/sdk/python/Reference/Beta/Models/AccessCriteria.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: beta-access-criteria
title: AccessCriteria
pagination_label: AccessCriteria
sidebar_label: AccessCriteria
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessCriteria', 'BetaAccessCriteria']
slug: /tools/sdk/python/beta/models/access-criteria
tags: ['SDK', 'Software Development Kit', 'AccessCriteria', 'BetaAccessCriteria']
---
# AccessCriteria
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Business name for the access construct list | [optional]
**criteria_list** | [**[]AccessCriteriaCriteriaListInner**](access-criteria-criteria-list-inner) | List of criteria. There is a min of 1 and max of 50 items in the list. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_criteria import AccessCriteria
access_criteria = AccessCriteria(
name='money-in',
criteria_list=[{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}]
)
```
[[Back to top]](#)

37
docs/tools/sdk/python/Reference/Beta/Models/AccessCriteriaCriteriaListInner.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-access-criteria-criteria-list-inner
title: AccessCriteriaCriteriaListInner
pagination_label: AccessCriteriaCriteriaListInner
sidebar_label: AccessCriteriaCriteriaListInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessCriteriaCriteriaListInner', 'BetaAccessCriteriaCriteriaListInner']
slug: /tools/sdk/python/beta/models/access-criteria-criteria-list-inner
tags: ['SDK', 'Software Development Kit', 'AccessCriteriaCriteriaListInner', 'BetaAccessCriteriaCriteriaListInner']
---
# AccessCriteriaCriteriaListInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'ENTITLEMENT' ] | DTO type | [optional]
**id** | **str** | ID of the object to which this reference applies to | [optional]
**name** | **str** | Human-readable display name of the object to which this reference applies to | [optional]
}
## Example
```python
from sailpoint.beta.models.access_criteria_criteria_list_inner import AccessCriteriaCriteriaListInner
access_criteria_criteria_list_inner = AccessCriteriaCriteriaListInner(
type='ENTITLEMENT',
id='2c91808568c529c60168cca6f90c1313',
name='Administrator'
)
```
[[Back to top]](#)

55
docs/tools/sdk/python/Reference/Beta/Models/AccessItemAccessProfileResponse.md Normal file
View File

@@ -0,0 +1,55 @@
---
id: beta-access-item-access-profile-response
title: AccessItemAccessProfileResponse
pagination_label: AccessItemAccessProfileResponse
sidebar_label: AccessItemAccessProfileResponse
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessItemAccessProfileResponse', 'BetaAccessItemAccessProfileResponse']
slug: /tools/sdk/python/beta/models/access-item-access-profile-response
tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponse', 'BetaAccessItemAccessProfileResponse']
---
# AccessItemAccessProfileResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. accessProfile in this case | [optional]
**id** | **str** | the access item id | [optional]
**name** | **str** | the access profile name | [optional]
**source_name** | **str** | the name of the source | [optional]
**source_id** | **str** | the id of the source | [optional]
**description** | **str** | the description for the access profile | [optional]
**display_name** | **str** | the display name of the identity | [optional]
**entitlement_count** | **str** | the number of entitlements the access profile will create | [optional]
**app_display_name** | **str** | the name of | [optional]
**remove_date** | **str** | the date the access profile is no longer assigned to the specified identity | [optional]
**standalone** | **bool** | indicates whether the access profile is standalone | [required]
**revocable** | **bool** | indicates whether the access profile is | [required]
}
## Example
```python
from sailpoint.beta.models.access_item_access_profile_response import AccessItemAccessProfileResponse
access_item_access_profile_response = AccessItemAccessProfileResponse(
access_type='accessProfile',
id='2c918087763e69d901763e72e97f006f',
name='sample',
source_name='DataScienceDataset',
source_id='2793o32dwd',
description='AccessProfile - Workday/Citizenship access',
display_name='Dr. Arden Rogahn MD',
entitlement_count='12',
app_display_name='AppName',
remove_date='2024-07-01T06:00:00.00Z',
standalone=False,
revocable=True
)
```
[[Back to top]](#)

45
docs/tools/sdk/python/Reference/Beta/Models/AccessItemAccountResponse.md Normal file
View File

@@ -0,0 +1,45 @@
---
id: beta-access-item-account-response
title: AccessItemAccountResponse
pagination_label: AccessItemAccountResponse
sidebar_label: AccessItemAccountResponse
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessItemAccountResponse', 'BetaAccessItemAccountResponse']
slug: /tools/sdk/python/beta/models/access-item-account-response
tags: ['SDK', 'Software Development Kit', 'AccessItemAccountResponse', 'BetaAccessItemAccountResponse']
---
# AccessItemAccountResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. account in this case | [optional]
**id** | **str** | the access item id | [optional]
**native_identity** | **str** | the native identifier used to uniquely identify an acccount | [optional]
**source_name** | **str** | the name of the source | [optional]
**source_id** | **str** | the id of the source | [optional]
**entitlement_count** | **str** | the number of entitlements the account will create | [optional]
**display_name** | **str** | the display name of the identity | [optional]
}
## Example
```python
from sailpoint.beta.models.access_item_account_response import AccessItemAccountResponse
access_item_account_response = AccessItemAccountResponse(
access_type='account',
id='2c918087763e69d901763e72e97f006f',
native_identity='dr.arden.ogahn.d',
source_name='DataScienceDataset',
source_id='2793o32dwd',
entitlement_count='12',
display_name='Dr. Arden Rogahn MD'
)
```
[[Back to top]](#)

41
docs/tools/sdk/python/Reference/Beta/Models/AccessItemAppResponse.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: beta-access-item-app-response
title: AccessItemAppResponse
pagination_label: AccessItemAppResponse
sidebar_label: AccessItemAppResponse
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessItemAppResponse', 'BetaAccessItemAppResponse']
slug: /tools/sdk/python/beta/models/access-item-app-response
tags: ['SDK', 'Software Development Kit', 'AccessItemAppResponse', 'BetaAccessItemAppResponse']
---
# AccessItemAppResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. entitlement in this case | [optional]
**id** | **str** | the access item id | [optional]
**display_name** | **str** | the access item display name | [optional]
**source_name** | **str** | the associated source name if it exists | [optional]
**app_role_id** | **str** | the app role id | [optional]
}
## Example
```python
from sailpoint.beta.models.access_item_app_response import AccessItemAppResponse
access_item_app_response = AccessItemAppResponse(
access_type='app',
id='2c918087763e69d901763e72e97f006f',
display_name='Display Name',
source_name='appName',
app_role_id='2c918087763e69d901763e72e97f006f'
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/Beta/Models/AccessItemApproverDto.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: beta-access-item-approver-dto
title: AccessItemApproverDto
pagination_label: AccessItemApproverDto
sidebar_label: AccessItemApproverDto
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessItemApproverDto', 'BetaAccessItemApproverDto']
slug: /tools/sdk/python/beta/models/access-item-approver-dto
tags: ['SDK', 'Software Development Kit', 'AccessItemApproverDto', 'BetaAccessItemApproverDto']
---
# AccessItemApproverDto
Identity who approved the access item request.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity who approved the access item request. | [optional]
**id** | **str** | ID of identity who approved the access item request. | [optional]
**name** | **str** | Human-readable display name of identity who approved the access item request. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_item_approver_dto import AccessItemApproverDto
access_item_approver_dto = AccessItemApproverDto(
type='IDENTITY',
id='2c3780a46faadee4016fb4e018c20652',
name='Allen Albertson'
)
```
[[Back to top]](#)

50
docs/tools/sdk/python/Reference/Beta/Models/AccessItemAssociated.md Normal file
View File

@@ -0,0 +1,50 @@
---
id: beta-access-item-associated
title: AccessItemAssociated
pagination_label: AccessItemAssociated
sidebar_label: AccessItemAssociated
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessItemAssociated', 'BetaAccessItemAssociated']
slug: /tools/sdk/python/beta/models/access-item-associated
tags: ['SDK', 'Software Development Kit', 'AccessItemAssociated', 'BetaAccessItemAssociated']
---
# AccessItemAssociated
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_item** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional]
**identity_id** | **str** | the identity id | [optional]
**event_type** | **str** | the event type | [optional]
**dt** | **str** | the date of event | [optional]
**governance_event** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional]
}
## Example
```python
from sailpoint.beta.models.access_item_associated import AccessItemAssociated
access_item_associated = AccessItemAssociated(
access_item={id=8c190e6787aa4ed9a90bd9d5344523fb, accessType=account, nativeIdentity=127999, sourceName=JDBC Entitlements Source, entitlementCount=0, displayName=Sample Name},
identity_id='8c190e6787aa4ed9a90bd9d5344523fb',
event_type='AccessItemAssociated',
dt='2019-03-08T22:37:33.901Z',
governance_event=sailpoint.beta.models.correlated_governance_event.CorrelatedGovernanceEvent(
name = 'Manager Certification for Jon Snow',
dt = '2019-03-08T22:37:33.901Z',
type = 'certification',
governance_id = '2c91808a77ff216301782327a50f09bf',
owners = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],
reviewers = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],
decision_maker = sailpoint.beta.models.certifier_response.CertifierResponse(
id = '8a80828f643d484f01643e14202e206f',
display_name = 'John Snow', ), )
)
```
[[Back to top]](#)

69
docs/tools/sdk/python/Reference/Beta/Models/AccessItemAssociatedAccessItem.md Normal file
View File

@@ -0,0 +1,69 @@
---
id: beta-access-item-associated-access-item
title: AccessItemAssociatedAccessItem
pagination_label: AccessItemAssociatedAccessItem
sidebar_label: AccessItemAssociatedAccessItem
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessItemAssociatedAccessItem', 'BetaAccessItemAssociatedAccessItem']
slug: /tools/sdk/python/beta/models/access-item-associated-access-item
tags: ['SDK', 'Software Development Kit', 'AccessItemAssociatedAccessItem', 'BetaAccessItemAssociatedAccessItem']
---
# AccessItemAssociatedAccessItem
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. role in this case | [optional]
**id** | **str** | the access item id | [optional]
**name** | **str** | the access profile name | [optional]
**source_name** | **str** | the associated source name if it exists | [optional]
**source_id** | **str** | the id of the source | [optional]
**description** | **str** | the description for the role | [optional]
**display_name** | **str** | the role display name | [optional]
**entitlement_count** | **str** | the number of entitlements the account will create | [optional]
**app_display_name** | **str** | the name of | [optional]
**remove_date** | **str** | the date the role is no longer assigned to the specified identity | [optional]
**standalone** | **bool** | indicates whether the entitlement is standalone | [required]
**revocable** | **bool** | indicates whether the role is revocable | [required]
**native_identity** | **str** | the native identifier used to uniquely identify an acccount | [optional]
**app_role_id** | **str** | the app role id | [optional]
**attribute** | **str** | the entitlement attribute | [optional]
**value** | **str** | the associated value | [optional]
**entitlement_type** | **str** | the type of entitlement | [optional]
**privileged** | **bool** | indicates whether the entitlement is privileged | [required]
**cloud_governed** | **bool** | indicates whether the entitlement is cloud governed | [required]
}
## Example
```python
from sailpoint.beta.models.access_item_associated_access_item import AccessItemAssociatedAccessItem
access_item_associated_access_item = AccessItemAssociatedAccessItem(
access_type='role',
id='2c918087763e69d901763e72e97f006f',
name='sample',
source_name='Source Name',
source_id='2793o32dwd',
description='Role - Workday/Citizenship access',
display_name='sample',
entitlement_count='12',
app_display_name='AppName',
remove_date='2024-07-01T06:00:00.00Z',
standalone=True,
revocable=True,
native_identity='dr.arden.ogahn.d',
app_role_id='2c918087763e69d901763e72e97f006f',
attribute='groups',
value='Upward mobility access',
entitlement_type='entitlement',
privileged=False,
cloud_governed=True
)
```
[[Back to top]](#)

39
docs/tools/sdk/python/Reference/Beta/Models/AccessItemDiff.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: beta-access-item-diff
title: AccessItemDiff
pagination_label: AccessItemDiff
sidebar_label: AccessItemDiff
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessItemDiff', 'BetaAccessItemDiff']
slug: /tools/sdk/python/beta/models/access-item-diff
tags: ['SDK', 'Software Development Kit', 'AccessItemDiff', 'BetaAccessItemDiff']
---
# AccessItemDiff
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | the id of the access item | [optional]
**event_type** | **Enum** [ 'ADD', 'REMOVE' ] | | [optional]
**display_name** | **str** | the display name of the access item | [optional]
**source_name** | **str** | the source name of the access item | [optional]
}
## Example
```python
from sailpoint.beta.models.access_item_diff import AccessItemDiff
access_item_diff = AccessItemDiff(
id='',
event_type='ADD',
display_name='',
source_name=''
)
```
[[Back to top]](#)

55
docs/tools/sdk/python/Reference/Beta/Models/AccessItemEntitlementResponse.md Normal file
View File

@@ -0,0 +1,55 @@
---
id: beta-access-item-entitlement-response
title: AccessItemEntitlementResponse
pagination_label: AccessItemEntitlementResponse
sidebar_label: AccessItemEntitlementResponse
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessItemEntitlementResponse', 'BetaAccessItemEntitlementResponse']
slug: /tools/sdk/python/beta/models/access-item-entitlement-response
tags: ['SDK', 'Software Development Kit', 'AccessItemEntitlementResponse', 'BetaAccessItemEntitlementResponse']
---
# AccessItemEntitlementResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. entitlement in this case | [optional]
**id** | **str** | the access item id | [optional]
**attribute** | **str** | the entitlement attribute | [optional]
**value** | **str** | the associated value | [optional]
**entitlement_type** | **str** | the type of entitlement | [optional]
**source_name** | **str** | the name of the source | [optional]
**source_id** | **str** | the id of the source | [optional]
**description** | **str** | the description for the entitlment | [optional]
**display_name** | **str** | the display name of the identity | [optional]
**standalone** | **bool** | indicates whether the entitlement is standalone | [required]
**privileged** | **bool** | indicates whether the entitlement is privileged | [required]
**cloud_governed** | **bool** | indicates whether the entitlement is cloud governed | [required]
}
## Example
```python
from sailpoint.beta.models.access_item_entitlement_response import AccessItemEntitlementResponse
access_item_entitlement_response = AccessItemEntitlementResponse(
access_type='entitlement',
id='2c918087763e69d901763e72e97f006f',
attribute='groups',
value='Upward mobility access',
entitlement_type='entitlement',
source_name='DataScienceDataset',
source_id='2793o32dwd',
description='Entitlement - Workday/Citizenship access',
display_name='Dr. Arden Rogahn MD',
standalone=True,
privileged=False,
cloud_governed=True
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/Beta/Models/AccessItemOwnerDto.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: beta-access-item-owner-dto
title: AccessItemOwnerDto
pagination_label: AccessItemOwnerDto
sidebar_label: AccessItemOwnerDto
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessItemOwnerDto', 'BetaAccessItemOwnerDto']
slug: /tools/sdk/python/beta/models/access-item-owner-dto
tags: ['SDK', 'Software Development Kit', 'AccessItemOwnerDto', 'BetaAccessItemOwnerDto']
---
# AccessItemOwnerDto
Access item owner's identity.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | Access item owner's DTO type. | [optional]
**id** | **str** | Access item owner's identity ID. | [optional]
**name** | **str** | Access item owner's human-readable display name. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_item_owner_dto import AccessItemOwnerDto
access_item_owner_dto = AccessItemOwnerDto(
type='IDENTITY',
id='2c9180a46faadee4016fb4e018c20639',
name='Support'
)
```
[[Back to top]](#)

35
docs/tools/sdk/python/Reference/Beta/Models/AccessItemRef.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: beta-access-item-ref
title: AccessItemRef
pagination_label: AccessItemRef
sidebar_label: AccessItemRef
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessItemRef', 'BetaAccessItemRef']
slug: /tools/sdk/python/beta/models/access-item-ref
tags: ['SDK', 'Software Development Kit', 'AccessItemRef', 'BetaAccessItemRef']
---
# AccessItemRef
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | ID of the access item to retrieve the recommendation for. | [optional]
**type** | **Enum** [ 'ENTITLEMENT', 'ACCESS_PROFILE', 'ROLE' ] | Access item's type. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_item_ref import AccessItemRef
access_item_ref = AccessItemRef(
id='2c938083633d259901633d2623ec0375',
type='ENTITLEMENT'
)
```
[[Back to top]](#)

50
docs/tools/sdk/python/Reference/Beta/Models/AccessItemRemoved.md Normal file
View File

@@ -0,0 +1,50 @@
---
id: beta-access-item-removed
title: AccessItemRemoved
pagination_label: AccessItemRemoved
sidebar_label: AccessItemRemoved
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessItemRemoved', 'BetaAccessItemRemoved']
slug: /tools/sdk/python/beta/models/access-item-removed
tags: ['SDK', 'Software Development Kit', 'AccessItemRemoved', 'BetaAccessItemRemoved']
---
# AccessItemRemoved
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_item** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional]
**identity_id** | **str** | the identity id | [optional]
**event_type** | **str** | the event type | [optional]
**dt** | **str** | the date of event | [optional]
**governance_event** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional]
}
## Example
```python
from sailpoint.beta.models.access_item_removed import AccessItemRemoved
access_item_removed = AccessItemRemoved(
access_item={id=8c190e6787aa4ed9a90bd9d5344523fb, accessType=account, nativeIdentity=127999, sourceName=JDBC Entitlements Source, entitlementCount=0, displayName=Sample Name},
identity_id='8c190e6787aa4ed9a90bd9d5344523fb',
event_type='AccessItemRemoved',
dt='2019-03-08T22:37:33.901Z',
governance_event=sailpoint.beta.models.correlated_governance_event.CorrelatedGovernanceEvent(
name = 'Manager Certification for Jon Snow',
dt = '2019-03-08T22:37:33.901Z',
type = 'certification',
governance_id = '2c91808a77ff216301782327a50f09bf',
owners = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],
reviewers = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],
decision_maker = sailpoint.beta.models.certifier_response.CertifierResponse(
id = '8a80828f643d484f01643e14202e206f',
display_name = 'John Snow', ), )
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/Beta/Models/AccessItemRequestedForDto.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: beta-access-item-requested-for-dto
title: AccessItemRequestedForDto
pagination_label: AccessItemRequestedForDto
sidebar_label: AccessItemRequestedForDto
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessItemRequestedForDto', 'BetaAccessItemRequestedForDto']
slug: /tools/sdk/python/beta/models/access-item-requested-for-dto
tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedForDto', 'BetaAccessItemRequestedForDto']
---
# AccessItemRequestedForDto
Identity the access item is requested for.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity the access item is requested for. | [optional]
**id** | **str** | ID of identity the access item is requested for. | [optional]
**name** | **str** | Human-readable display name of identity the access item is requested for. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_item_requested_for_dto import AccessItemRequestedForDto
access_item_requested_for_dto = AccessItemRequestedForDto(
type='IDENTITY',
id='2c4180a46faadee4016fb4e018c20626',
name='Robert Robinson'
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/Beta/Models/AccessItemRequester.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: beta-access-item-requester
title: AccessItemRequester
pagination_label: AccessItemRequester
sidebar_label: AccessItemRequester
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessItemRequester', 'BetaAccessItemRequester']
slug: /tools/sdk/python/beta/models/access-item-requester
tags: ['SDK', 'Software Development Kit', 'AccessItemRequester', 'BetaAccessItemRequester']
---
# AccessItemRequester
Access item requester's identity.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | Access item requester's DTO type. | [optional]
**id** | **str** | Access item requester's identity ID. | [optional]
**name** | **str** | Access item owner's human-readable display name. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_item_requester import AccessItemRequester
access_item_requester = AccessItemRequester(
type='IDENTITY',
id='2c7180a46faadee4016fb4e018c20648',
name='William Wilson'
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/Beta/Models/AccessItemRequesterDto.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: beta-access-item-requester-dto
title: AccessItemRequesterDto
pagination_label: AccessItemRequesterDto
sidebar_label: AccessItemRequesterDto
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessItemRequesterDto', 'BetaAccessItemRequesterDto']
slug: /tools/sdk/python/beta/models/access-item-requester-dto
tags: ['SDK', 'Software Development Kit', 'AccessItemRequesterDto', 'BetaAccessItemRequesterDto']
---
# AccessItemRequesterDto
Access item requester's identity.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | Access item requester's DTO type. | [optional]
**id** | **str** | Access item requester's identity ID. | [optional]
**name** | **str** | Access item owner's human-readable display name. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_item_requester_dto import AccessItemRequesterDto
access_item_requester_dto = AccessItemRequesterDto(
type='IDENTITY',
id='2c7180a46faadee4016fb4e018c20648',
name='William Wilson'
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/Beta/Models/AccessItemReviewedBy.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: beta-access-item-reviewed-by
title: AccessItemReviewedBy
pagination_label: AccessItemReviewedBy
sidebar_label: AccessItemReviewedBy
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessItemReviewedBy', 'BetaAccessItemReviewedBy']
slug: /tools/sdk/python/beta/models/access-item-reviewed-by
tags: ['SDK', 'Software Development Kit', 'AccessItemReviewedBy', 'BetaAccessItemReviewedBy']
---
# AccessItemReviewedBy
Identity who reviewed the access item request.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity who reviewed the access item request. | [optional]
**id** | **str** | ID of identity who reviewed the access item request. | [optional]
**name** | **str** | Human-readable display name of identity who reviewed the access item request. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_item_reviewed_by import AccessItemReviewedBy
access_item_reviewed_by = AccessItemReviewedBy(
type='IDENTITY',
id='2c3780a46faadee4016fb4e018c20652',
name='Allen Albertson'
)
```
[[Back to top]](#)

45
docs/tools/sdk/python/Reference/Beta/Models/AccessItemRoleResponse.md Normal file
View File

@@ -0,0 +1,45 @@
---
id: beta-access-item-role-response
title: AccessItemRoleResponse
pagination_label: AccessItemRoleResponse
sidebar_label: AccessItemRoleResponse
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessItemRoleResponse', 'BetaAccessItemRoleResponse']
slug: /tools/sdk/python/beta/models/access-item-role-response
tags: ['SDK', 'Software Development Kit', 'AccessItemRoleResponse', 'BetaAccessItemRoleResponse']
---
# AccessItemRoleResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. role in this case | [optional]
**id** | **str** | the access item id | [optional]
**display_name** | **str** | the role display name | [optional]
**description** | **str** | the description for the role | [optional]
**source_name** | **str** | the associated source name if it exists | [optional]
**remove_date** | **str** | the date the role is no longer assigned to the specified identity | [optional]
**revocable** | **bool** | indicates whether the role is revocable | [required]
}
## Example
```python
from sailpoint.beta.models.access_item_role_response import AccessItemRoleResponse
access_item_role_response = AccessItemRoleResponse(
access_type='role',
id='2c918087763e69d901763e72e97f006f',
display_name='sample',
description='Role - Workday/Citizenship access',
source_name='Source Name',
remove_date='2024-07-01T06:00:00.00Z',
revocable=True
)
```
[[Back to top]](#)

91
docs/tools/sdk/python/Reference/Beta/Models/AccessProfile.md Normal file
View File

@@ -0,0 +1,91 @@
---
id: beta-access-profile
title: AccessProfile
pagination_label: AccessProfile
sidebar_label: AccessProfile
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessProfile', 'BetaAccessProfile']
slug: /tools/sdk/python/beta/models/access-profile
tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'BetaAccessProfile']
---
# AccessProfile
Access Profile
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The ID of the Access Profile | [optional] [readonly]
**name** | **str** | Name of the Access Profile | [required]
**description** | **str** | Information about the Access Profile | [optional]
**created** | **datetime** | Date the Access Profile was created | [optional] [readonly]
**modified** | **datetime** | Date the Access Profile was last modified. | [optional] [readonly]
**enabled** | **bool** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to True]
**owner** | [**OwnerReference**](owner-reference) | | [required]
**source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required]
**entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional]
**requestable** | **bool** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to True]
**access_request_config** | [**Requestability**](requestability) | | [optional]
**revocation_request_config** | [**Revocability**](revocability) | | [optional]
**segments** | **[]str** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional]
**provisioning_criteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional]
}
## Example
```python
from sailpoint.beta.models.access_profile import AccessProfile
access_profile = AccessProfile(
id='2c91808a7190d06e01719938fcd20792',
name='Employee-database-read-write',
description='Collection of entitlements to read/write the employee database',
created='2021-03-01T22:32:58.104Z',
modified='2021-03-02T20:22:28.104Z',
enabled=True,
owner=sailpoint.beta.models.owner_reference.OwnerReference(
type = 'IDENTITY',
id = '2c9180a46faadee4016fb4e018c20639',
name = 'support', ),
source=sailpoint.beta.models.access_profile_source_ref.AccessProfileSourceRef(
id = '2c91809773dee3610173fdb0b6061ef4',
type = 'SOURCE',
name = 'ODS-AD-SOURCE', ),
entitlements=[
sailpoint.beta.models.entitlement_ref.EntitlementRef(
type = 'ENTITLEMENT',
id = '2c91809773dee32014e13e122092014e',
name = 'CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local', )
],
requestable=True,
access_request_config=sailpoint.beta.models.requestability.Requestability(
comments_required = True,
denial_comments_required = True,
approval_schemes = [
sailpoint.beta.models.access_profile_approval_scheme.AccessProfileApprovalScheme(
approver_type = 'GOVERNANCE_GROUP',
approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', )
], ),
revocation_request_config=sailpoint.beta.models.revocability.Revocability(
approval_schemes = [
sailpoint.beta.models.access_profile_approval_scheme.AccessProfileApprovalScheme(
approver_type = 'GOVERNANCE_GROUP',
approver_id = '46c79819-a69f-49a2-becb-12c971ae66c6', )
], ),
segments=[f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a],
provisioning_criteria=sailpoint.beta.models.provisioning_criteria_level1.ProvisioningCriteriaLevel1(
operation = 'EQUALS',
attribute = 'email',
value = 'carlee.cert1c9f9b6fd@mailinator.com',
children = [
sailpoint.beta.models.provisioning_criteria_level2.ProvisioningCriteriaLevel2(
attribute = 'email',
value = 'carlee.cert1c9f9b6fd@mailinator.com', )
], )
)
```
[[Back to top]](#)

35
docs/tools/sdk/python/Reference/Beta/Models/AccessProfileApprovalScheme.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: beta-access-profile-approval-scheme
title: AccessProfileApprovalScheme
pagination_label: AccessProfileApprovalScheme
sidebar_label: AccessProfileApprovalScheme
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessProfileApprovalScheme', 'BetaAccessProfileApprovalScheme']
slug: /tools/sdk/python/beta/models/access-profile-approval-scheme
tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'BetaAccessProfileApprovalScheme']
---
# AccessProfileApprovalScheme
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**approver_type** | **Enum** [ 'APP_OWNER', 'OWNER', 'SOURCE_OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional]
**approver_id** | **str** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional]
}
## Example
```python
from sailpoint.beta.models.access_profile_approval_scheme import AccessProfileApprovalScheme
access_profile_approval_scheme = AccessProfileApprovalScheme(
approver_type='GOVERNANCE_GROUP',
approver_id='46c79819-a69f-49a2-becb-12c971ae66c6'
)
```
[[Back to top]](#)

35
docs/tools/sdk/python/Reference/Beta/Models/AccessProfileBulkDeleteRequest.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: beta-access-profile-bulk-delete-request
title: AccessProfileBulkDeleteRequest
pagination_label: AccessProfileBulkDeleteRequest
sidebar_label: AccessProfileBulkDeleteRequest
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessProfileBulkDeleteRequest', 'BetaAccessProfileBulkDeleteRequest']
slug: /tools/sdk/python/beta/models/access-profile-bulk-delete-request
tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteRequest', 'BetaAccessProfileBulkDeleteRequest']
---
# AccessProfileBulkDeleteRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_profile_ids** | **[]str** | List of IDs of Access Profiles to be deleted. | [optional]
**best_effort_only** | **bool** | If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_profile_bulk_delete_request import AccessProfileBulkDeleteRequest
access_profile_bulk_delete_request = AccessProfileBulkDeleteRequest(
access_profile_ids=[2c9180847812e0b1017817051919ecca, 2c9180887812e0b201781e129f151816],
best_effort_only=True
)
```
[[Back to top]](#)

46
docs/tools/sdk/python/Reference/Beta/Models/AccessProfileBulkDeleteResponse.md Normal file
View File

@@ -0,0 +1,46 @@
---
id: beta-access-profile-bulk-delete-response
title: AccessProfileBulkDeleteResponse
pagination_label: AccessProfileBulkDeleteResponse
sidebar_label: AccessProfileBulkDeleteResponse
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessProfileBulkDeleteResponse', 'BetaAccessProfileBulkDeleteResponse']
slug: /tools/sdk/python/beta/models/access-profile-bulk-delete-response
tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteResponse', 'BetaAccessProfileBulkDeleteResponse']
---
# AccessProfileBulkDeleteResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**task_id** | **str** | ID of the task which is executing the bulk deletion. This can be passed to the **/task-status** API to track status. | [optional]
**pending** | **[]str** | List of IDs of Access Profiles which are pending deletion. | [optional]
**in_use** | [**[]AccessProfileUsage**](access-profile-usage) | List of usages of Access Profiles targeted for deletion. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_profile_bulk_delete_response import AccessProfileBulkDeleteResponse
access_profile_bulk_delete_response = AccessProfileBulkDeleteResponse(
task_id='2c9180867817ac4d017817c491119a20',
pending=[2c91808876438bbb017668c21919ecca, 2c91808876438bb201766e129f151816],
in_use=[
sailpoint.beta.models.access_profile_usage.AccessProfileUsage(
access_profile_id = '2c91808876438bbb017668c21919ecca',
used_by = [
sailpoint.beta.models.access_profile_usage_used_by_inner.AccessProfileUsage_usedBy_inner(
type = 'ROLE',
id = '2c8180857a9b3da0017aa03418480f9d',
name = 'Manager Role', )
], )
]
)
```
[[Back to top]](#)

36
docs/tools/sdk/python/Reference/Beta/Models/AccessProfileBulkUpdateRequestInner.md Normal file
View File

@@ -0,0 +1,36 @@
---
id: beta-access-profile-bulk-update-request-inner
title: AccessProfileBulkUpdateRequestInner
pagination_label: AccessProfileBulkUpdateRequestInner
sidebar_label: AccessProfileBulkUpdateRequestInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessProfileBulkUpdateRequestInner', 'BetaAccessProfileBulkUpdateRequestInner']
slug: /tools/sdk/python/beta/models/access-profile-bulk-update-request-inner
tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkUpdateRequestInner', 'BetaAccessProfileBulkUpdateRequestInner']
---
# AccessProfileBulkUpdateRequestInner
Access Profile's basic details.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Access Profile ID. | [optional]
**requestable** | **bool** | Access Profile is requestable or not. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_profile_bulk_update_request_inner import AccessProfileBulkUpdateRequestInner
access_profile_bulk_update_request_inner = AccessProfileBulkUpdateRequestInner(
id='464ae7bf-791e-49fd-b746-06a2e4a8',
requestable=False
)
```
[[Back to top]](#)

85
docs/tools/sdk/python/Reference/Beta/Models/AccessProfileDetails.md Normal file
View File

@@ -0,0 +1,85 @@
---
id: beta-access-profile-details
title: AccessProfileDetails
pagination_label: AccessProfileDetails
sidebar_label: AccessProfileDetails
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessProfileDetails', 'BetaAccessProfileDetails']
slug: /tools/sdk/python/beta/models/access-profile-details
tags: ['SDK', 'Software Development Kit', 'AccessProfileDetails', 'BetaAccessProfileDetails']
---
# AccessProfileDetails
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The ID of the Access Profile | [optional]
**name** | **str** | Name of the Access Profile | [optional]
**description** | **str** | Information about the Access Profile | [optional]
**created** | **datetime** | Date the Access Profile was created | [optional]
**modified** | **datetime** | Date the Access Profile was last modified. | [optional]
**disabled** | **bool** | Whether the Access Profile is enabled. | [optional] [default to True]
**requestable** | **bool** | Whether the Access Profile is requestable via access request. | [optional] [default to False]
**protected** | **bool** | Whether the Access Profile is protected. | [optional] [default to False]
**owner_id** | **str** | The owner ID of the Access Profile | [optional]
**source_id** | **int** | The source ID of the Access Profile | [optional]
**source_name** | **str** | The source name of the Access Profile | [optional]
**app_id** | **int** | The source app ID of the Access Profile | [optional]
**app_name** | **str** | The source app name of the Access Profile | [optional]
**application_id** | **str** | The id of the application | [optional]
**type** | **str** | The type of the access profile | [optional]
**entitlements** | **[]str** | List of IDs of entitlements | [optional]
**entitlement_count** | **int** | The number of entitlements in the access profile | [optional]
**segments** | **[]str** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional]
**approval_schemes** | **str** | Comma-separated list of approval schemes. Each approval scheme is one of - manager - appOwner - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional]
**revoke_request_approval_schemes** | **str** | Comma-separated list of revoke request approval schemes. Each approval scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional]
**request_comments_required** | **bool** | Whether the access profile require request comment for access request. | [optional] [default to False]
**denied_comments_required** | **bool** | Whether denied comment is required when access request is denied. | [optional] [default to False]
**account_selector** | [**AccessProfileDetailsAccountSelector**](access-profile-details-account-selector) | | [optional]
}
## Example
```python
from sailpoint.beta.models.access_profile_details import AccessProfileDetails
access_profile_details = AccessProfileDetails(
id='2c91808a7190d06e01719938fcd20792',
name='Employee-database-read-write',
description='Collection of entitlements to read/write the employee database',
created='2021-03-01T22:32:58.104Z',
modified='2021-03-02T20:22:28.104Z',
disabled=True,
requestable=True,
protected=False,
owner_id='9870808a7190d06e01719938fcd20792',
source_id=10360661,
source_name='AD Source',
app_id=10360661,
app_name='mail app',
application_id='edcb0951812949d085b60cd8bf35bc78',
type='source',
entitlements=[2c9180857725c14301772a93bb77242d, c9dc28e148a24d65b3ccb5fb8ca5ddd9],
entitlement_count=12,
segments=[f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a],
approval_schemes='accessProfileOwner',
revoke_request_approval_schemes='accessProfileOwner',
request_comments_required=True,
denied_comments_required=True,
account_selector=sailpoint.beta.models.access_profile_details_account_selector.AccessProfileDetails_accountSelector(
selectors = [
sailpoint.beta.models.selector.selector(
application_id = '2c91808874ff91550175097daaec161c"',
account_match_config = sailpoint.beta.models.selector_account_match_config.selector_accountMatchConfig(
match_expression = sailpoint.beta.models.selector_account_match_config_match_expression.selector_accountMatchConfig_matchExpression(
match_terms = [{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}],
and = True, ), ), )
], )
)
```
[[Back to top]](#)

41
docs/tools/sdk/python/Reference/Beta/Models/AccessProfileDetailsAccountSelector.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: beta-access-profile-details-account-selector
title: AccessProfileDetailsAccountSelector
pagination_label: AccessProfileDetailsAccountSelector
sidebar_label: AccessProfileDetailsAccountSelector
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessProfileDetailsAccountSelector', 'BetaAccessProfileDetailsAccountSelector']
slug: /tools/sdk/python/beta/models/access-profile-details-account-selector
tags: ['SDK', 'Software Development Kit', 'AccessProfileDetailsAccountSelector', 'BetaAccessProfileDetailsAccountSelector']
---
# AccessProfileDetailsAccountSelector
How to select account when there are multiple accounts for the user
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**selectors** | [**[]Selector**](selector) | | [optional]
}
## Example
```python
from sailpoint.beta.models.access_profile_details_account_selector import AccessProfileDetailsAccountSelector
access_profile_details_account_selector = AccessProfileDetailsAccountSelector(
selectors=[
sailpoint.beta.models.selector.selector(
application_id = '2c91808874ff91550175097daaec161c"',
account_match_config = sailpoint.beta.models.selector_account_match_config.selector_accountMatchConfig(
match_expression = sailpoint.beta.models.selector_account_match_config_match_expression.selector_accountMatchConfig_matchExpression(
match_terms = [{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}],
and = True, ), ), )
]
)
```
[[Back to top]](#)

37
docs/tools/sdk/python/Reference/Beta/Models/AccessProfileRef.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-access-profile-ref
title: AccessProfileRef
pagination_label: AccessProfileRef
sidebar_label: AccessProfileRef
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessProfileRef', 'BetaAccessProfileRef']
slug: /tools/sdk/python/beta/models/access-profile-ref
tags: ['SDK', 'Software Development Kit', 'AccessProfileRef', 'BetaAccessProfileRef']
---
# AccessProfileRef
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | ID of the Access Profile | [optional]
**type** | **Enum** [ 'ACCESS_PROFILE' ] | Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result. | [optional]
**name** | **str** | Human-readable display name of the Access Profile. This field is ignored on input. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_profile_ref import AccessProfileRef
access_profile_ref = AccessProfileRef(
id='ff808081751e6e129f1518161919ecca',
type='ACCESS_PROFILE',
name='Access Profile 2567'
)
```
[[Back to top]](#)

37
docs/tools/sdk/python/Reference/Beta/Models/AccessProfileSourceRef.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-access-profile-source-ref
title: AccessProfileSourceRef
pagination_label: AccessProfileSourceRef
sidebar_label: AccessProfileSourceRef
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessProfileSourceRef', 'BetaAccessProfileSourceRef']
slug: /tools/sdk/python/beta/models/access-profile-source-ref
tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'BetaAccessProfileSourceRef']
---
# AccessProfileSourceRef
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The ID of the Source with with which the Access Profile is associated | [optional]
**type** | **Enum** [ 'SOURCE' ] | The type of the Source, will always be SOURCE | [optional]
**name** | **str** | The display name of the associated Source | [optional]
}
## Example
```python
from sailpoint.beta.models.access_profile_source_ref import AccessProfileSourceRef
access_profile_source_ref = AccessProfileSourceRef(
id='2c91809773dee3610173fdb0b6061ef4',
type='SOURCE',
name='ODS-AD-SOURCE'
)
```
[[Back to top]](#)

43
docs/tools/sdk/python/Reference/Beta/Models/AccessProfileUpdateItem.md Normal file
View File

@@ -0,0 +1,43 @@
---
id: beta-access-profile-update-item
title: AccessProfileUpdateItem
pagination_label: AccessProfileUpdateItem
sidebar_label: AccessProfileUpdateItem
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessProfileUpdateItem', 'BetaAccessProfileUpdateItem']
slug: /tools/sdk/python/beta/models/access-profile-update-item
tags: ['SDK', 'Software Development Kit', 'AccessProfileUpdateItem', 'BetaAccessProfileUpdateItem']
---
# AccessProfileUpdateItem
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Identifier of Access Profile in bulk update request. | [required]
**requestable** | **bool** | Access Profile requestable or not. | [required]
**status** | **str** | The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation. > 201 - Access profile is updated successfully. > 404 - Access profile not found. | [required]
**description** | **str** | Human readable status description and containing additional context information about success or failures etc. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_profile_update_item import AccessProfileUpdateItem
access_profile_update_item = AccessProfileUpdateItem(
id='2c7180a46faadee4016fb4e018c20642',
requestable=False,
status='201',
description='
> Access profile is updated successfully.
> Referenced Access profile with Id "2c7180a46faadee4016fb4e018c20642" was not found.
'
)
```
[[Back to top]](#)

40
docs/tools/sdk/python/Reference/Beta/Models/AccessProfileUsage.md Normal file
View File

@@ -0,0 +1,40 @@
---
id: beta-access-profile-usage
title: AccessProfileUsage
pagination_label: AccessProfileUsage
sidebar_label: AccessProfileUsage
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessProfileUsage', 'BetaAccessProfileUsage']
slug: /tools/sdk/python/beta/models/access-profile-usage
tags: ['SDK', 'Software Development Kit', 'AccessProfileUsage', 'BetaAccessProfileUsage']
---
# AccessProfileUsage
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_profile_id** | **str** | ID of the Access Profile that is in use | [optional]
**used_by** | [**[]AccessProfileUsageUsedByInner**](access-profile-usage-used-by-inner) | List of references to objects which are using the indicated Access Profile | [optional]
}
## Example
```python
from sailpoint.beta.models.access_profile_usage import AccessProfileUsage
access_profile_usage = AccessProfileUsage(
access_profile_id='2c91808876438bbb017668c21919ecca',
used_by=[
sailpoint.beta.models.access_profile_usage_used_by_inner.AccessProfileUsage_usedBy_inner(
type = 'ROLE',
id = '2c8180857a9b3da0017aa03418480f9d',
name = 'Manager Role', )
]
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/Beta/Models/AccessProfileUsageUsedByInner.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: beta-access-profile-usage-used-by-inner
title: AccessProfileUsageUsedByInner
pagination_label: AccessProfileUsageUsedByInner
sidebar_label: AccessProfileUsageUsedByInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessProfileUsageUsedByInner', 'BetaAccessProfileUsageUsedByInner']
slug: /tools/sdk/python/beta/models/access-profile-usage-used-by-inner
tags: ['SDK', 'Software Development Kit', 'AccessProfileUsageUsedByInner', 'BetaAccessProfileUsageUsedByInner']
---
# AccessProfileUsageUsedByInner
Role using the access profile.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'ROLE' ] | DTO type of role using the access profile. | [optional]
**id** | **str** | ID of role using the access profile. | [optional]
**name** | **str** | Display name of role using the access profile. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_profile_usage_used_by_inner import AccessProfileUsageUsedByInner
access_profile_usage_used_by_inner = AccessProfileUsageUsedByInner(
type='ROLE',
id='2c8180857a9b3da0017aa03418480f9d',
name='Manager Role'
)
```
[[Back to top]](#)

33
docs/tools/sdk/python/Reference/Beta/Models/AccessRecommendationMessage.md Normal file
View File

@@ -0,0 +1,33 @@
---
id: beta-access-recommendation-message
title: AccessRecommendationMessage
pagination_label: AccessRecommendationMessage
sidebar_label: AccessRecommendationMessage
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRecommendationMessage', 'BetaAccessRecommendationMessage']
slug: /tools/sdk/python/beta/models/access-recommendation-message
tags: ['SDK', 'Software Development Kit', 'AccessRecommendationMessage', 'BetaAccessRecommendationMessage']
---
# AccessRecommendationMessage
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**interpretation** | **str** | Information about why the access item was recommended. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_recommendation_message import AccessRecommendationMessage
access_recommendation_message = AccessRecommendationMessage(
interpretation='95% of your peers have this access.'
)
```
[[Back to top]](#)

48
docs/tools/sdk/python/Reference/Beta/Models/AccessRequest.md Normal file
View File

@@ -0,0 +1,48 @@
---
id: beta-access-request
title: AccessRequest
pagination_label: AccessRequest
sidebar_label: AccessRequest
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequest', 'BetaAccessRequest']
slug: /tools/sdk/python/beta/models/access-request
tags: ['SDK', 'Software Development Kit', 'AccessRequest', 'BetaAccessRequest']
---
# AccessRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**requested_for** | **[]str** | A list of Identity IDs for whom the Access is requested. If it's a Revoke request, there can only be one Identity ID. | [required]
**request_type** | [**AccessRequestType**](access-request-type) | | [optional]
**requested_items** | [**[]AccessRequestItem**](access-request-item) | | [required]
**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_request import AccessRequest
access_request = AccessRequest(
requested_for=[
'2c918084660f45d6016617daa9210584'
],
request_type='GRANT_ACCESS',
requested_items=[
sailpoint.beta.models.access_request_item.AccessRequestItem(
type = 'ACCESS_PROFILE',
id = '2c9180835d2e5168015d32f890ca1581',
comment = 'Requesting access profile for John Doe',
client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1},
remove_date = '2020-07-11T21:23:15Z', )
],
client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app}
)
```
[[Back to top]](#)

57
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestConfig.md Normal file
View File

@@ -0,0 +1,57 @@
---
id: beta-access-request-config
title: AccessRequestConfig
pagination_label: AccessRequestConfig
sidebar_label: AccessRequestConfig
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestConfig', 'BetaAccessRequestConfig']
slug: /tools/sdk/python/beta/models/access-request-config
tags: ['SDK', 'Software Development Kit', 'AccessRequestConfig', 'BetaAccessRequestConfig']
---
# AccessRequestConfig
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**approvals_must_be_external** | **bool** | If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn't an org admin. | [optional] [default to False]
**auto_approval_enabled** | **bool** | If this is true and the requester and reviewer are the same, the request is automatically approved. | [optional] [default to False]
**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]
}
## Example
```python
from sailpoint.beta.models.access_request_config import AccessRequestConfig
access_request_config = AccessRequestConfig(
approvals_must_be_external=True,
auto_approval_enabled=True,
reauthorization_enabled=True,
request_on_behalf_of_config=sailpoint.beta.models.request_on_behalf_of_config.RequestOnBehalfOfConfig(
allow_request_on_behalf_of_anyone_by_anyone = True,
allow_request_on_behalf_of_employee_by_manager = True, ),
approval_reminder_and_escalation_config=sailpoint.beta.models.approval_reminder_and_escalation_config.ApprovalReminderAndEscalationConfig(
days_until_escalation = 0,
days_between_reminders = 0,
max_reminders = 1,
fallback_approver_ref = sailpoint.beta.models.identity_reference_with_name_and_email.IdentityReferenceWithNameAndEmail(
type = 'IDENTITY',
id = '5168015d32f890ca15812c9180835d2e',
name = 'Alison Ferguso',
email = 'alison.ferguso@identitysoon.com', ), ),
entitlement_request_config=sailpoint.beta.models.entitlement_request_config_1.EntitlementRequestConfig_1(
allow_entitlement_request = True,
request_comments_required = False,
denied_comments_required = False,
grant_request_approval_schemes = 'sourceOwner', )
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestContext.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: beta-access-request-context
title: AccessRequestContext
pagination_label: AccessRequestContext
sidebar_label: AccessRequestContext
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestContext', 'BetaAccessRequestContext']
slug: /tools/sdk/python/beta/models/access-request-context
tags: ['SDK', 'Software Development Kit', 'AccessRequestContext', 'BetaAccessRequestContext']
---
# AccessRequestContext
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**context_attributes** | [**[]ContextAttributeDto**](context-attribute-dto) | | [optional]
}
## Example
```python
from sailpoint.beta.models.access_request_context import AccessRequestContext
access_request_context = AccessRequestContext(
context_attributes=[
sailpoint.beta.models.context_attribute_dto.ContextAttributeDto(
attribute = 'location',
value = Austin,
derived = False, )
]
)
```
[[Back to top]](#)

55
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestDynamicApprover.md Normal file
View File

@@ -0,0 +1,55 @@
---
id: beta-access-request-dynamic-approver
title: AccessRequestDynamicApprover
pagination_label: AccessRequestDynamicApprover
sidebar_label: AccessRequestDynamicApprover
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestDynamicApprover', 'BetaAccessRequestDynamicApprover']
slug: /tools/sdk/python/beta/models/access-request-dynamic-approver
tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover', 'BetaAccessRequestDynamicApprover']
---
# AccessRequestDynamicApprover
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_request_id** | **str** | The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-request-status) to get the status of the request. | [required]
**requested_for** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required]
**requested_items** | [**[]AccessRequestDynamicApproverRequestedItemsInner**](access-request-dynamic-approver-requested-items-inner) | The access items that are being requested. | [required]
**requested_by** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required]
}
## Example
```python
from sailpoint.beta.models.access_request_dynamic_approver import AccessRequestDynamicApprover
access_request_dynamic_approver = AccessRequestDynamicApprover(
access_request_id='4b4d982dddff4267ab12f0f1e72b5a6d',
requested_for=[
sailpoint.beta.models.access_item_requested_for_dto.AccessItemRequestedForDto(
type = 'IDENTITY',
id = '2c4180a46faadee4016fb4e018c20626',
name = 'Robert Robinson', )
],
requested_items=[
sailpoint.beta.models.access_request_dynamic_approver_requested_items_inner.AccessRequestDynamicApprover_requestedItems_inner(
id = '2c91808b6ef1d43e016efba0ce470904',
name = 'Engineering Access',
description = 'Engineering Access',
type = ACCESS_PROFILE,
operation = Add,
comment = 'William needs this access for his day to day job activities.', )
],
requested_by=sailpoint.beta.models.access_item_requester_dto.AccessItemRequesterDto(
type = 'IDENTITY',
id = '2c7180a46faadee4016fb4e018c20648',
name = 'William Wilson', )
)
```
[[Back to top]](#)

37
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestDynamicApprover1.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-access-request-dynamic-approver1
title: AccessRequestDynamicApprover1
pagination_label: AccessRequestDynamicApprover1
sidebar_label: AccessRequestDynamicApprover1
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestDynamicApprover1', 'BetaAccessRequestDynamicApprover1']
slug: /tools/sdk/python/beta/models/access-request-dynamic-approver1
tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover1', 'BetaAccessRequestDynamicApprover1']
---
# AccessRequestDynamicApprover1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique ID of the identity to add to the approver list for the access request. | [required]
**name** | **str** | The name of the identity to add to the approver list for the access request. | [required]
**type** | **Enum** [ 'IDENTITY', 'GOVERNANCE_GROUP' ] | The type of object being referenced. | [required]
}
## Example
```python
from sailpoint.beta.models.access_request_dynamic_approver1 import AccessRequestDynamicApprover1
access_request_dynamic_approver1 = AccessRequestDynamicApprover1(
id='2c91808b6ef1d43e016efba0ce470906',
name='Adam Adams',
type=IDENTITY
)
```
[[Back to top]](#)

43
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestDynamicApproverRequestedItemsInner.md Normal file
View File

@@ -0,0 +1,43 @@
---
id: beta-access-request-dynamic-approver-requested-items-inner
title: AccessRequestDynamicApproverRequestedItemsInner
pagination_label: AccessRequestDynamicApproverRequestedItemsInner
sidebar_label: AccessRequestDynamicApproverRequestedItemsInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestDynamicApproverRequestedItemsInner', 'BetaAccessRequestDynamicApproverRequestedItemsInner']
slug: /tools/sdk/python/beta/models/access-request-dynamic-approver-requested-items-inner
tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApproverRequestedItemsInner', 'BetaAccessRequestDynamicApproverRequestedItemsInner']
---
# AccessRequestDynamicApproverRequestedItemsInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique ID of the access item. | [required]
**name** | **str** | Human friendly name of the access item. | [required]
**description** | **str** | Extended description of the access item. | [optional]
**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of access item being requested. | [required]
**operation** | **Enum** [ 'Add', 'Remove' ] | Grant or revoke the access item | [required]
**comment** | **str** | A comment from the requestor on why the access is needed. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_request_dynamic_approver_requested_items_inner import AccessRequestDynamicApproverRequestedItemsInner
access_request_dynamic_approver_requested_items_inner = AccessRequestDynamicApproverRequestedItemsInner(
id='2c91808b6ef1d43e016efba0ce470904',
name='Engineering Access',
description='Engineering Access',
type=ACCESS_PROFILE,
operation=Add,
comment='William needs this access for his day to day job activities.'
)
```
[[Back to top]](#)

41
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestItem.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: beta-access-request-item
title: AccessRequestItem
pagination_label: AccessRequestItem
sidebar_label: AccessRequestItem
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestItem', 'BetaAccessRequestItem']
slug: /tools/sdk/python/beta/models/access-request-item
tags: ['SDK', 'Software Development Kit', 'AccessRequestItem', 'BetaAccessRequestItem']
---
# AccessRequestItem
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of the item being requested. | [required]
**id** | **str** | ID of Role, Access Profile or Entitlement being requested. | [required]
**comment** | **str** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional]
**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional]
**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_request_item import AccessRequestItem
access_request_item = AccessRequestItem(
type='ACCESS_PROFILE',
id='2c9180835d2e5168015d32f890ca1581',
comment='Requesting access profile for John Doe',
client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1},
remove_date='2020-07-11T21:23:15Z'
)
```
[[Back to top]](#)

47
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestItemResponse.md Normal file
View File

@@ -0,0 +1,47 @@
---
id: beta-access-request-item-response
title: AccessRequestItemResponse
pagination_label: AccessRequestItemResponse
sidebar_label: AccessRequestItemResponse
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestItemResponse', 'BetaAccessRequestItemResponse']
slug: /tools/sdk/python/beta/models/access-request-item-response
tags: ['SDK', 'Software Development Kit', 'AccessRequestItemResponse', 'BetaAccessRequestItemResponse']
---
# AccessRequestItemResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**operation** | **str** | the access request item operation | [optional]
**access_item_type** | **str** | the access item type | [optional]
**name** | **str** | the name of access request item | [optional]
**decision** | **Enum** [ 'APPROVED', 'REJECTED' ] | the final decision for the access request | [optional]
**description** | **str** | the description of access request item | [optional]
**source_id** | **str** | the source id | [optional]
**source_name** | **str** | the source Name | [optional]
**approval_infos** | [**[]ApprovalInfoResponse**](approval-info-response) | | [optional]
}
## Example
```python
from sailpoint.beta.models.access_request_item_response import AccessRequestItemResponse
access_request_item_response = AccessRequestItemResponse(
operation='Add',
access_item_type='role',
name='Role-1',
decision='APPROVED',
description='The role descrition',
source_id='8a80828f643d484f01643e14202e206f',
source_name='Source1',
approval_infos=[{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}]
)
```
[[Back to top]](#)

44
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPhases.md Normal file
View File

@@ -0,0 +1,44 @@
---
id: beta-access-request-phases
title: AccessRequestPhases
pagination_label: AccessRequestPhases
sidebar_label: AccessRequestPhases
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestPhases', 'BetaAccessRequestPhases']
slug: /tools/sdk/python/beta/models/access-request-phases
tags: ['SDK', 'Software Development Kit', 'AccessRequestPhases', 'BetaAccessRequestPhases']
---
# AccessRequestPhases
Provides additional details about this access request phase.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**started** | **datetime** | The time that this phase started. | [optional]
**finished** | **datetime** | The time that this phase finished. | [optional]
**name** | **str** | The name of this phase. | [optional]
**state** | **Enum** [ 'PENDING', 'EXECUTING', 'COMPLETED', 'CANCELLED', 'NOT_EXECUTED' ] | The state of this phase. | [optional]
**result** | **Enum** [ 'SUCCESSFUL', 'FAILED' ] | The state of this phase. | [optional]
**phase_reference** | **str** | A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_request_phases import AccessRequestPhases
access_request_phases = AccessRequestPhases(
started='2020-07-11T00:00Z',
finished='2020-07-12T00:00Z',
name='APPROVAL_PHASE',
state='COMPLETED',
result='SUCCESSFUL',
phase_reference='approvalDetails'
)
```
[[Back to top]](#)

64
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPostApproval.md Normal file
View File

@@ -0,0 +1,64 @@
---
id: beta-access-request-post-approval
title: AccessRequestPostApproval
pagination_label: AccessRequestPostApproval
sidebar_label: AccessRequestPostApproval
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestPostApproval', 'BetaAccessRequestPostApproval']
slug: /tools/sdk/python/beta/models/access-request-post-approval
tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApproval', 'BetaAccessRequestPostApproval']
---
# AccessRequestPostApproval
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_request_id** | **str** | The unique ID of the access request. | [required]
**requested_for** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required]
**requested_items_status** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details on the outcome of each access item. | [required]
**requested_by** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required]
}
## Example
```python
from sailpoint.beta.models.access_request_post_approval import AccessRequestPostApproval
access_request_post_approval = AccessRequestPostApproval(
access_request_id='2c91808b6ef1d43e016efba0ce470904',
requested_for=[
sailpoint.beta.models.access_item_requested_for_dto.AccessItemRequestedForDto(
type = 'IDENTITY',
id = '2c4180a46faadee4016fb4e018c20626',
name = 'Robert Robinson', )
],
requested_items_status=[
sailpoint.beta.models.access_request_post_approval_requested_items_status_inner.AccessRequestPostApproval_requestedItemsStatus_inner(
id = '2c91808b6ef1d43e016efba0ce470904',
name = 'Engineering Access',
description = 'Access to engineering database',
type = ACCESS_PROFILE,
operation = Add,
comment = 'William needs this access to do his job.',
client_metadata = {applicationName=My application},
approval_info = [
sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner(
approval_comment = 'This access looks good. Approved.',
approval_decision = APPROVED,
approver_name = 'Stephen.Austin',
approver = sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner_approver.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner_approver(
type = IDENTITY, ), )
], )
],
requested_by=sailpoint.beta.models.access_item_requester_dto.AccessItemRequesterDto(
type = 'IDENTITY',
id = '2c7180a46faadee4016fb4e018c20648',
name = 'William Wilson', )
)
```
[[Back to top]](#)

54
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md Normal file
View File

@@ -0,0 +1,54 @@
---
id: beta-access-request-post-approval-requested-items-status-inner
title: AccessRequestPostApprovalRequestedItemsStatusInner
pagination_label: AccessRequestPostApprovalRequestedItemsStatusInner
sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInner', 'BetaAccessRequestPostApprovalRequestedItemsStatusInner']
slug: /tools/sdk/python/beta/models/access-request-post-approval-requested-items-status-inner
tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInner', 'BetaAccessRequestPostApprovalRequestedItemsStatusInner']
---
# AccessRequestPostApprovalRequestedItemsStatusInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique ID of the access item being requested. | [required]
**name** | **str** | The human friendly name of the access item. | [required]
**description** | **str** | Detailed description of the access item. | [optional]
**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of access item. | [required]
**operation** | **Enum** [ 'Add', 'Remove' ] | The action to perform on the access item. | [required]
**comment** | **str** | A comment from the identity requesting the access. | [optional]
**client_metadata** | **map[string]object** | Additional customer defined metadata about the access item. | [optional]
**approval_info** | [**[]AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner**](access-request-post-approval-requested-items-status-inner-approval-info-inner) | A list of one or more approvers for the access request. | [required]
}
## Example
```python
from sailpoint.beta.models.access_request_post_approval_requested_items_status_inner import AccessRequestPostApprovalRequestedItemsStatusInner
access_request_post_approval_requested_items_status_inner = AccessRequestPostApprovalRequestedItemsStatusInner(
id='2c91808b6ef1d43e016efba0ce470904',
name='Engineering Access',
description='Access to engineering database',
type=ACCESS_PROFILE,
operation=Add,
comment='William needs this access to do his job.',
client_metadata={applicationName=My application},
approval_info=[
sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner(
approval_comment = 'This access looks good. Approved.',
approval_decision = APPROVED,
approver_name = 'Stephen.Austin',
approver = sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner_approver.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner_approver(
type = IDENTITY, ), )
]
)
```
[[Back to top]](#)

40
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md Normal file
View File

@@ -0,0 +1,40 @@
---
id: beta-access-request-post-approval-requested-items-status-inner-approval-info-inner
title: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner
pagination_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner
sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner', 'BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner']
slug: /tools/sdk/python/beta/models/access-request-post-approval-requested-items-status-inner-approval-info-inner
tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner', 'BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner']
---
# AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**approval_comment** | **str** | A comment left by the approver. | [optional]
**approval_decision** | **Enum** [ 'APPROVED', 'DENIED' ] | The final decision of the approver. | [required]
**approver_name** | **str** | The name of the approver | [required]
**approver** | [**AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover**](access-request-post-approval-requested-items-status-inner-approval-info-inner-approver) | | [required]
}
## Example
```python
from sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner import AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner
access_request_post_approval_requested_items_status_inner_approval_info_inner = AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner(
approval_comment='This access looks good. Approved.',
approval_decision=APPROVED,
approver_name='Stephen.Austin',
approver=sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner_approver.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner_approver(
type = IDENTITY, )
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: beta-access-request-post-approval-requested-items-status-inner-approval-info-inner-approver
title: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover
pagination_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover
sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover', 'BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover']
slug: /tools/sdk/python/beta/models/access-request-post-approval-requested-items-status-inner-approval-info-inner-approver
tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover', 'BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover']
---
# AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover
The identity of the approver.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | The type of object that is referenced | [required]
**id** | **str** | ID of identity who approved the access item request. | [required]
**name** | **str** | Human-readable display name of identity who approved the access item request. | [required]
}
## Example
```python
from sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner_approver import AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover
access_request_post_approval_requested_items_status_inner_approval_info_inner_approver = AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover(
type=IDENTITY,
id='2c3780a46faadee4016fb4e018c20652',
name='Allen Albertson'
)
```
[[Back to top]](#)

55
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPreApproval.md Normal file
View File

@@ -0,0 +1,55 @@
---
id: beta-access-request-pre-approval
title: AccessRequestPreApproval
pagination_label: AccessRequestPreApproval
sidebar_label: AccessRequestPreApproval
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestPreApproval', 'BetaAccessRequestPreApproval']
slug: /tools/sdk/python/beta/models/access-request-pre-approval
tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval', 'BetaAccessRequestPreApproval']
---
# AccessRequestPreApproval
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_request_id** | **str** | The unique ID of the access request. | [required]
**requested_for** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required]
**requested_items** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details of the access items being requested. | [required]
**requested_by** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required]
}
## Example
```python
from sailpoint.beta.models.access_request_pre_approval import AccessRequestPreApproval
access_request_pre_approval = AccessRequestPreApproval(
access_request_id='2c91808b6ef1d43e016efba0ce470904',
requested_for=[
sailpoint.beta.models.access_item_requested_for_dto.AccessItemRequestedForDto(
type = 'IDENTITY',
id = '2c4180a46faadee4016fb4e018c20626',
name = 'Robert Robinson', )
],
requested_items=[
sailpoint.beta.models.access_request_pre_approval_requested_items_inner.AccessRequestPreApproval_requestedItems_inner(
id = '2c91808b6ef1d43e016efba0ce470904',
name = 'Engineering Access',
description = 'Access to engineering database',
type = ACCESS_PROFILE,
operation = Add,
comment = 'William needs this access to do his job.', )
],
requested_by=sailpoint.beta.models.access_item_requester_dto.AccessItemRequesterDto(
type = 'IDENTITY',
id = '2c7180a46faadee4016fb4e018c20648',
name = 'William Wilson', )
)
```
[[Back to top]](#)

37
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPreApproval1.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-access-request-pre-approval1
title: AccessRequestPreApproval1
pagination_label: AccessRequestPreApproval1
sidebar_label: AccessRequestPreApproval1
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestPreApproval1', 'BetaAccessRequestPreApproval1']
slug: /tools/sdk/python/beta/models/access-request-pre-approval1
tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval1', 'BetaAccessRequestPreApproval1']
---
# AccessRequestPreApproval1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**approved** | **bool** | Whether or not to approve the access request. | [required]
**comment** | **str** | A comment about the decision to approve or deny the request. | [required]
**approver** | **str** | The name of the entity that approved or denied the request. | [required]
}
## Example
```python
from sailpoint.beta.models.access_request_pre_approval1 import AccessRequestPreApproval1
access_request_pre_approval1 = AccessRequestPreApproval1(
approved=False,
comment='This access should be denied, because this will cause an SOD violation.',
approver='AcmeCorpExternalIntegration'
)
```
[[Back to top]](#)

43
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPreApprovalRequestedItemsInner.md Normal file
View File

@@ -0,0 +1,43 @@
---
id: beta-access-request-pre-approval-requested-items-inner
title: AccessRequestPreApprovalRequestedItemsInner
pagination_label: AccessRequestPreApprovalRequestedItemsInner
sidebar_label: AccessRequestPreApprovalRequestedItemsInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestPreApprovalRequestedItemsInner', 'BetaAccessRequestPreApprovalRequestedItemsInner']
slug: /tools/sdk/python/beta/models/access-request-pre-approval-requested-items-inner
tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApprovalRequestedItemsInner', 'BetaAccessRequestPreApprovalRequestedItemsInner']
---
# AccessRequestPreApprovalRequestedItemsInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique ID of the access item being requested. | [required]
**name** | **str** | The human friendly name of the access item. | [required]
**description** | **str** | Detailed description of the access item. | [optional]
**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of access item. | [required]
**operation** | **Enum** [ 'Add', 'Remove' ] | The action to perform on the access item. | [required]
**comment** | **str** | A comment from the identity requesting the access. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_request_pre_approval_requested_items_inner import AccessRequestPreApprovalRequestedItemsInner
access_request_pre_approval_requested_items_inner = AccessRequestPreApprovalRequestedItemsInner(
id='2c91808b6ef1d43e016efba0ce470904',
name='Engineering Access',
description='Access to engineering database',
type=ACCESS_PROFILE,
operation=Add,
comment='William needs this access to do his job.'
)
```
[[Back to top]](#)

37
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationActionItemDto.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-access-request-recommendation-action-item-dto
title: AccessRequestRecommendationActionItemDto
pagination_label: AccessRequestRecommendationActionItemDto
sidebar_label: AccessRequestRecommendationActionItemDto
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestRecommendationActionItemDto', 'BetaAccessRequestRecommendationActionItemDto']
slug: /tools/sdk/python/beta/models/access-request-recommendation-action-item-dto
tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationActionItemDto', 'BetaAccessRequestRecommendationActionItemDto']
---
# AccessRequestRecommendationActionItemDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identity_id** | **str** | The identity ID taking the action. | [required]
**access** | [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | [required]
}
## Example
```python
from sailpoint.beta.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto
access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto(
identity_id='2c91808570313110017040b06f344ec9',
access=sailpoint.beta.models.access_request_recommendation_item.AccessRequestRecommendationItem(
id = '2c9180835d2e5168015d32f890ca1581',
type = 'ACCESS_PROFILE', )
)
```
[[Back to top]](#)

39
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationActionItemResponseDto.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: beta-access-request-recommendation-action-item-response-dto
title: AccessRequestRecommendationActionItemResponseDto
pagination_label: AccessRequestRecommendationActionItemResponseDto
sidebar_label: AccessRequestRecommendationActionItemResponseDto
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestRecommendationActionItemResponseDto', 'BetaAccessRequestRecommendationActionItemResponseDto']
slug: /tools/sdk/python/beta/models/access-request-recommendation-action-item-response-dto
tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationActionItemResponseDto', 'BetaAccessRequestRecommendationActionItemResponseDto']
---
# AccessRequestRecommendationActionItemResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identity_id** | **str** | The identity ID taking the action. | [optional]
**access** | [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | [optional]
**timestamp** | **datetime** | | [optional]
}
## Example
```python
from sailpoint.beta.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto
access_request_recommendation_action_item_response_dto = AccessRequestRecommendationActionItemResponseDto(
identity_id='2c91808570313110017040b06f344ec9',
access=sailpoint.beta.models.access_request_recommendation_item.AccessRequestRecommendationItem(
id = '2c9180835d2e5168015d32f890ca1581',
type = 'ACCESS_PROFILE', ),
timestamp='2017-07-11T18:45:37.098Z'
)
```
[[Back to top]](#)

35
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationItem.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: beta-access-request-recommendation-item
title: AccessRequestRecommendationItem
pagination_label: AccessRequestRecommendationItem
sidebar_label: AccessRequestRecommendationItem
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestRecommendationItem', 'BetaAccessRequestRecommendationItem']
slug: /tools/sdk/python/beta/models/access-request-recommendation-item
tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItem', 'BetaAccessRequestRecommendationItem']
---
# AccessRequestRecommendationItem
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | ID of access item being recommended. | [optional]
**type** | [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional]
}
## Example
```python
from sailpoint.beta.models.access_request_recommendation_item import AccessRequestRecommendationItem
access_request_recommendation_item = AccessRequestRecommendationItem(
id='2c9180835d2e5168015d32f890ca1581',
type='ACCESS_PROFILE'
)
```
[[Back to top]](#)

52
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationItemDetail.md Normal file
View File

@@ -0,0 +1,52 @@
---
id: beta-access-request-recommendation-item-detail
title: AccessRequestRecommendationItemDetail
pagination_label: AccessRequestRecommendationItemDetail
sidebar_label: AccessRequestRecommendationItemDetail
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestRecommendationItemDetail', 'BetaAccessRequestRecommendationItemDetail']
slug: /tools/sdk/python/beta/models/access-request-recommendation-item-detail
tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemDetail', 'BetaAccessRequestRecommendationItemDetail']
---
# AccessRequestRecommendationItemDetail
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identity_id** | **str** | Identity ID for the recommendation | [optional]
**access** | [**AccessRequestRecommendationItemDetailAccess**](access-request-recommendation-item-detail-access) | | [optional]
**ignored** | **bool** | Whether or not the identity has already chosen to ignore this recommendation. | [optional]
**requested** | **bool** | Whether or not the identity has already chosen to request this recommendation. | [optional]
**viewed** | **bool** | Whether or not the identity reportedly viewed this recommendation. | [optional]
**messages** | [**[]AccessRecommendationMessage**](access-recommendation-message) | | [optional]
**translation_messages** | [**[]TranslationMessage**](translation-message) | The list of translation messages | [optional]
}
## Example
```python
from sailpoint.beta.models.access_request_recommendation_item_detail import AccessRequestRecommendationItemDetail
access_request_recommendation_item_detail = AccessRequestRecommendationItemDetail(
identity_id='2c91808570313110017040b06f344ec9',
access=sailpoint.beta.models.access_request_recommendation_item_detail_access.AccessRequestRecommendationItemDetail_access(
id = '2c9180835d2e5168015d32f890ca1581',
type = 'ACCESS_PROFILE',
name = 'Employee-database-read-write',
description = 'This item grants an employee read and write access to the database', ),
ignored=True,
requested=True,
viewed=True,
messages=[
sailpoint.beta.models.access_recommendation_message.AccessRecommendationMessage(
interpretation = '95% of your peers have this access.', )
],
translation_messages=[{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}]
)
```
[[Back to top]](#)

39
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationItemDetailAccess.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: beta-access-request-recommendation-item-detail-access
title: AccessRequestRecommendationItemDetailAccess
pagination_label: AccessRequestRecommendationItemDetailAccess
sidebar_label: AccessRequestRecommendationItemDetailAccess
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestRecommendationItemDetailAccess', 'BetaAccessRequestRecommendationItemDetailAccess']
slug: /tools/sdk/python/beta/models/access-request-recommendation-item-detail-access
tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemDetailAccess', 'BetaAccessRequestRecommendationItemDetailAccess']
---
# AccessRequestRecommendationItemDetailAccess
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | ID of access item being recommended. | [optional]
**type** | [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional]
**name** | **str** | Name of the access item | [optional]
**description** | **str** | Description of the access item | [optional]
}
## Example
```python
from sailpoint.beta.models.access_request_recommendation_item_detail_access import AccessRequestRecommendationItemDetailAccess
access_request_recommendation_item_detail_access = AccessRequestRecommendationItemDetailAccess(
id='2c9180835d2e5168015d32f890ca1581',
type='ACCESS_PROFILE',
name='Employee-database-read-write',
description='This item grants an employee read and write access to the database'
)
```
[[Back to top]](#)

23
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestRecommendationItemType.md Normal file
View File

@@ -0,0 +1,23 @@
---
id: beta-access-request-recommendation-item-type
title: AccessRequestRecommendationItemType
pagination_label: AccessRequestRecommendationItemType
sidebar_label: AccessRequestRecommendationItemType
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestRecommendationItemType', 'BetaAccessRequestRecommendationItemType']
slug: /tools/sdk/python/beta/models/access-request-recommendation-item-type
tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemType', 'BetaAccessRequestRecommendationItemType']
---
# AccessRequestRecommendationItemType
The type of access item.
## Enum
* `ACCESS_PROFILE` (value: `'ACCESS_PROFILE'`)
* `ROLE` (value: `'ROLE'`)
[[Back to top]](#)

35
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestResponse.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: beta-access-request-response
title: AccessRequestResponse
pagination_label: AccessRequestResponse
sidebar_label: AccessRequestResponse
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestResponse', 'BetaAccessRequestResponse']
slug: /tools/sdk/python/beta/models/access-request-response
tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse', 'BetaAccessRequestResponse']
---
# AccessRequestResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**new_requests** | [**[]AccessRequestTracking**](access-request-tracking) | A list of new access request tracking data mapped to the values requested. | [optional]
**existing_requests** | [**[]AccessRequestTracking**](access-request-tracking) | A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_request_response import AccessRequestResponse
access_request_response = AccessRequestResponse(
new_requests=[{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ENTITLEMENT, id=779c6fd7171540bba1184e5946112c28}], attributesHash=-1928438224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdb]}],
existing_requests=[{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ROLE, id=779c6fd7171540bbc1184e5946112c28}], attributesHash=2843118224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdc]}]
)
```
[[Back to top]](#)

37
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestResponse1.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-access-request-response1
title: AccessRequestResponse1
pagination_label: AccessRequestResponse1
sidebar_label: AccessRequestResponse1
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestResponse1', 'BetaAccessRequestResponse1']
slug: /tools/sdk/python/beta/models/access-request-response1
tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse1', 'BetaAccessRequestResponse1']
---
# AccessRequestResponse1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**requester_id** | **str** | the requester Id | [optional]
**requester_name** | **str** | the requesterName | [optional]
**items** | [**[]AccessRequestItemResponse**](access-request-item-response) | | [optional]
}
## Example
```python
from sailpoint.beta.models.access_request_response1 import AccessRequestResponse1
access_request_response1 = AccessRequestResponse1(
requester_id='2c91808a77ff216301782327a50f09bf',
requester_name='Bing C',
items=[{operation=Add, accessItemType=role, name=Role-1, decision=APPROVED, description=The role descrition, sourceId=8a80828f643d484f01643e14202e206f, sourceName=Source1, approvalInfos=[{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}]}]
)
```
[[Back to top]](#)

42
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestTracking.md Normal file
View File

@@ -0,0 +1,42 @@
---
id: beta-access-request-tracking
title: AccessRequestTracking
pagination_label: AccessRequestTracking
sidebar_label: AccessRequestTracking
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestTracking', 'BetaAccessRequestTracking']
slug: /tools/sdk/python/beta/models/access-request-tracking
tags: ['SDK', 'Software Development Kit', 'AccessRequestTracking', 'BetaAccessRequestTracking']
---
# AccessRequestTracking
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**requested_for** | **str** | The identity id in which the access request is for. | [optional]
**requested_items_details** | [**[]RequestedItemDetails**](requested-item-details) | The details of the item requested. | [optional]
**attributes_hash** | **str** | a hash representation of the access requested, useful for longer term tracking client side. | [optional]
**access_request_ids** | **[]str** | a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_request_tracking import AccessRequestTracking
access_request_tracking = AccessRequestTracking(
requested_for='2c918084660f45d6016617daa9210584',
requested_items_details={
"type": "ENTITLEMENT",
"id": "779c6fd7171540bba1184e5946112c28"
},
attributes_hash='-1928438224',
access_request_ids=[5d3118c518a44ec7805450d53479ccdb]
)
```
[[Back to top]](#)

23
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestType.md Normal file
View File

@@ -0,0 +1,23 @@
---
id: beta-access-request-type
title: AccessRequestType
pagination_label: AccessRequestType
sidebar_label: AccessRequestType
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestType', 'BetaAccessRequestType']
slug: /tools/sdk/python/beta/models/access-request-type
tags: ['SDK', 'Software Development Kit', 'AccessRequestType', 'BetaAccessRequestType']
---
# AccessRequestType
Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field.
## Enum
* `GRANT_ACCESS` (value: `'GRANT_ACCESS'`)
* `REVOKE_ACCESS` (value: `'REVOKE_ACCESS'`)
[[Back to top]](#)

42
docs/tools/sdk/python/Reference/Beta/Models/AccessRequested.md Normal file
View File

@@ -0,0 +1,42 @@
---
id: beta-access-requested
title: AccessRequested
pagination_label: AccessRequested
sidebar_label: AccessRequested
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequested', 'BetaAccessRequested']
slug: /tools/sdk/python/beta/models/access-requested
tags: ['SDK', 'Software Development Kit', 'AccessRequested', 'BetaAccessRequested']
---
# AccessRequested
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_request** | [**AccessRequestResponse1**](access-request-response1) | | [optional]
**identity_id** | **str** | the identity id | [optional]
**event_type** | **str** | the event type | [optional]
**dt** | **str** | the date of event | [optional]
}
## Example
```python
from sailpoint.beta.models.access_requested import AccessRequested
access_requested = AccessRequested(
access_request=sailpoint.beta.models.access_request_response_1.AccessRequestResponse_1(
requester_id = '2c91808a77ff216301782327a50f09bf',
requester_name = 'Bing C',
items = [{operation=Add, accessItemType=role, name=Role-1, decision=APPROVED, description=The role descrition, sourceId=8a80828f643d484f01643e14202e206f, sourceName=Source1, approvalInfos=[{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}]}], ),
identity_id='8a80828f643d484f01643e14202e206f',
event_type='AccessRequested',
dt='2019-03-08T22:37:33.901Z'
)
```
[[Back to top]](#)

23
docs/tools/sdk/python/Reference/Beta/Models/AccessType.md Normal file
View File

@@ -0,0 +1,23 @@
---
id: beta-access-type
title: AccessType
pagination_label: AccessType
sidebar_label: AccessType
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessType', 'BetaAccessType']
slug: /tools/sdk/python/beta/models/access-type
tags: ['SDK', 'Software Development Kit', 'AccessType', 'BetaAccessType']
---
# AccessType
Access type of API Client indicating online or offline use
## Enum
* `ONLINE` (value: `'ONLINE'`)
* `OFFLINE` (value: `'OFFLINE'`)
[[Back to top]](#)

98
docs/tools/sdk/python/Reference/Beta/Models/Account.md Normal file
View File

@@ -0,0 +1,98 @@
---
id: beta-account
title: Account
pagination_label: Account
sidebar_label: Account
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'Account', 'BetaAccount']
slug: /tools/sdk/python/beta/models/account
tags: ['SDK', 'Software Development Kit', 'Account', 'BetaAccount']
---
# Account
## 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]
**source_id** | **str** | The unique ID of the source this account belongs to | [required]
**source_name** | **str** | The display name of the source this account belongs to | [required]
**identity_id** | **str** | The unique ID of the identity this account is correlated to | [optional]
**cloud_lifecycle_state** | **str** | The lifecycle state of the identity this account is correlated to | [optional]
**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]
**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]
**disabled** | **bool** | Indicates if the account is currently disabled | [required]
**locked** | **bool** | Indicates if the account is currently locked | [required]
**native_identity** | **str** | The unique ID of the account generated by the source system | [required]
**system_account** | **bool** | If true, this is a user account within IdentityNow. If false, this is an account from a source system. | [required]
**uncorrelated** | **bool** | Indicates if this account is not correlated to an identity | [required]
**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]
**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]
}
## Example
```python
from sailpoint.beta.models.account import Account
account = Account(
id='id12345',
name='aName',
created='2023-01-03T21:16:22.432Z',
modified='2023-01-03T21:16:22.432Z',
source_id='2c9180835d2e5168015d32f890ca1581',
source_name='Employees',
identity_id='2c9180835d2e5168015d32f890ca1581',
cloud_lifecycle_state='active',
identity_state='ACTIVE',
connection_type='direct',
is_machine=True,
recommendation=sailpoint.beta.models.recommendation.Recommendation(
type = 'MACHINE',
method = 'DISCOVERY', ),
attributes={firstName=SailPoint, lastName=Support, displayName=SailPoint Support},
authoritative=False,
description='',
disabled=False,
locked=False,
native_identity='552775',
system_account=False,
uncorrelated=False,
uuid='{b0dce506-d6d4-44d2-8a32-d9a5b21fb175}',
manually_correlated=False,
has_entitlements=True,
identity=sailpoint.beta.models.base_reference_dto.BaseReferenceDto(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', ),
source_owner=sailpoint.beta.models.base_reference_dto.BaseReferenceDto(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', ),
features='ENABLE',
origin='AGGREGATED',
owner_identity=sailpoint.beta.models.base_reference_dto.BaseReferenceDto(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', )
)
```
[[Back to top]](#)

35
docs/tools/sdk/python/Reference/Beta/Models/AccountAction.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: beta-account-action
title: AccountAction
pagination_label: AccountAction
sidebar_label: AccountAction
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAction', 'BetaAccountAction']
slug: /tools/sdk/python/beta/models/account-action
tags: ['SDK', 'Software Development Kit', 'AccountAction', 'BetaAccountAction']
---
# AccountAction
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**action** | **Enum** [ 'ENABLE', 'DISABLE' ] | Describes if action will be enabled or disabled | [optional]
**source_ids** | **[]str** | List of source IDs. The sources must have the ENABLE feature or flat file source. See \"/sources\" endpoint for source features. | [optional]
}
## Example
```python
from sailpoint.beta.models.account_action import AccountAction
account_action = AccountAction(
action='ENABLE',
source_ids=[2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500]
)
```
[[Back to top]](#)

31
docs/tools/sdk/python/Reference/Beta/Models/AccountActivityApprovalStatus.md Normal file
View File

@@ -0,0 +1,31 @@
---
id: beta-account-activity-approval-status
title: AccountActivityApprovalStatus
pagination_label: AccountActivityApprovalStatus
sidebar_label: AccountActivityApprovalStatus
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountActivityApprovalStatus', 'BetaAccountActivityApprovalStatus']
slug: /tools/sdk/python/beta/models/account-activity-approval-status
tags: ['SDK', 'Software Development Kit', 'AccountActivityApprovalStatus', 'BetaAccountActivityApprovalStatus']
---
# AccountActivityApprovalStatus
The state of an approval status
## Enum
* `FINISHED` (value: `'FINISHED'`)
* `REJECTED` (value: `'REJECTED'`)
* `RETURNED` (value: `'RETURNED'`)
* `EXPIRED` (value: `'EXPIRED'`)
* `PENDING` (value: `'PENDING'`)
* `CANCELED` (value: `'CANCELED'`)
[[Back to top]](#)

78
docs/tools/sdk/python/Reference/Beta/Models/AccountActivityItem.md Normal file
View File

@@ -0,0 +1,78 @@
---
id: beta-account-activity-item
title: AccountActivityItem
pagination_label: AccountActivityItem
sidebar_label: AccountActivityItem
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountActivityItem', 'BetaAccountActivityItem']
slug: /tools/sdk/python/beta/models/account-activity-item
tags: ['SDK', 'Software Development Kit', 'AccountActivityItem', 'BetaAccountActivityItem']
---
# AccountActivityItem
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Item id | [optional]
**name** | **str** | Human-readable display name of item | [optional]
**requested** | **datetime** | Date and time item was requested | [optional]
**approval_status** | [**AccountActivityApprovalStatus**](account-activity-approval-status) | | [optional]
**provisioning_status** | [**ProvisioningState**](provisioning-state) | | [optional]
**requester_comment** | [**Comment**](comment) | | [optional]
**reviewer_identity_summary** | [**IdentitySummary**](identity-summary) | | [optional]
**reviewer_comment** | [**Comment**](comment) | | [optional]
**operation** | [**AccountActivityItemOperation**](account-activity-item-operation) | | [optional]
**attribute** | **str** | Attribute to which account activity applies | [optional]
**value** | **str** | Value of attribute | [optional]
**native_identity** | **str** | Native identity in the target system to which the account activity applies | [optional]
**source_id** | **str** | Id of Source to which account activity applies | [optional]
**account_request_info** | [**AccountRequestInfo**](account-request-info) | | [optional]
**client_metadata** | **map[string]str** | Arbitrary key-value pairs, if any were included in the corresponding access request item | [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.beta.models.account_activity_item import AccountActivityItem
account_activity_item = AccountActivityItem(
id='48c545831b264409a81befcabb0e3c5a',
name='48c545831b264409a81befcabb0e3c5a',
requested='2017-07-11T18:45:37.098Z',
approval_status='PENDING',
provisioning_status='PENDING',
requester_comment=sailpoint.beta.models.comment.Comment(
commenter_id = '2c918084660f45d6016617daa9210584',
commenter_name = 'Adam Kennedy',
body = 'Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.',
date = '2017-07-11T18:45:37.098Z', ),
reviewer_identity_summary=sailpoint.beta.models.identity_summary.IdentitySummary(
id = 'ff80818155fe8c080155fe8d925b0316',
name = 'SailPoint Services',
identity_id = 'c15b9f5cca5a4e9599eaa0e64fa921bd',
completed = True, ),
reviewer_comment=sailpoint.beta.models.comment.Comment(
commenter_id = '2c918084660f45d6016617daa9210584',
commenter_name = 'Adam Kennedy',
body = 'Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.',
date = '2017-07-11T18:45:37.098Z', ),
operation='ADD',
attribute='detectedRoles',
value='Treasury Analyst [AccessProfile-1529010191212]',
native_identity='Sandie.Camero',
source_id='2c91808363ef85290164000587130c0c',
account_request_info=sailpoint.beta.models.account_request_info.AccountRequestInfo(
requested_object_id = '2c91808563ef85690164001c31140c0c',
requested_object_name = 'Treasury Analyst',
requested_object_type = 'ACCESS_PROFILE', ),
client_metadata={customKey1=custom value 1, customKey2=custom value 2},
remove_date='2020-07-11T00:00Z'
)
```
[[Back to top]](#)

39
docs/tools/sdk/python/Reference/Beta/Models/AccountActivityItemOperation.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: beta-account-activity-item-operation
title: AccountActivityItemOperation
pagination_label: AccountActivityItemOperation
sidebar_label: AccountActivityItemOperation
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountActivityItemOperation', 'BetaAccountActivityItemOperation']
slug: /tools/sdk/python/beta/models/account-activity-item-operation
tags: ['SDK', 'Software Development Kit', 'AccountActivityItemOperation', 'BetaAccountActivityItemOperation']
---
# AccountActivityItemOperation
Represents an operation in an account activity item
## Enum
* `ADD` (value: `'ADD'`)
* `CREATE` (value: `'CREATE'`)
* `MODIFY` (value: `'MODIFY'`)
* `DELETE` (value: `'DELETE'`)
* `DISABLE` (value: `'DISABLE'`)
* `ENABLE` (value: `'ENABLE'`)
* `UNLOCK` (value: `'UNLOCK'`)
* `LOCK` (value: `'LOCK'`)
* `REMOVE` (value: `'REMOVE'`)
* `SET` (value: `'SET'`)
[[Back to top]](#)

39
docs/tools/sdk/python/Reference/Beta/Models/AccountAggregation.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: beta-account-aggregation
title: AccountAggregation
pagination_label: AccountAggregation
sidebar_label: AccountAggregation
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAggregation', 'BetaAccountAggregation']
slug: /tools/sdk/python/beta/models/account-aggregation
tags: ['SDK', 'Software Development Kit', 'AccountAggregation', 'BetaAccountAggregation']
---
# AccountAggregation
## Properties
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]
**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]
}
## Example
```python
from sailpoint.beta.models.account_aggregation import AccountAggregation
account_aggregation = AccountAggregation(
start='2021-01-31T14:30:05.104Z',
status='ACCOUNTS_COLLECTED',
total_accounts=520,
processed_accounts=150
)
```
[[Back to top]](#)

57
docs/tools/sdk/python/Reference/Beta/Models/AccountAggregationCompleted.md Normal file
View File

@@ -0,0 +1,57 @@
---
id: beta-account-aggregation-completed
title: AccountAggregationCompleted
pagination_label: AccountAggregationCompleted
sidebar_label: AccountAggregationCompleted
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAggregationCompleted', 'BetaAccountAggregationCompleted']
slug: /tools/sdk/python/beta/models/account-aggregation-completed
tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompleted', 'BetaAccountAggregationCompleted']
---
# AccountAggregationCompleted
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**source** | [**AccountAggregationCompletedSource**](account-aggregation-completed-source) | | [required]
**status** | **Enum** [ 'Success', 'Failed', 'Terminated' ] | The overall status of the aggregation. | [required]
**started** | **datetime** | The date and time when the account aggregation started. | [required]
**completed** | **datetime** | The date and time when the account aggregation finished. | [required]
**errors** | **[]str** | A list of errors that occurred during the aggregation. | [required]
**warnings** | **[]str** | A list of warnings that occurred during the aggregation. | [required]
**stats** | [**AccountAggregationCompletedStats**](account-aggregation-completed-stats) | | [required]
}
## Example
```python
from sailpoint.beta.models.account_aggregation_completed import AccountAggregationCompleted
account_aggregation_completed = AccountAggregationCompleted(
source=sailpoint.beta.models.account_aggregation_completed_source.AccountAggregationCompleted_source(
type = 'SOURCE',
id = '2c9180835d191a86015d28455b4b232a',
name = 'HR Active Directory', ),
status=Success,
started='2020-06-29T22:01:50.474Z',
completed='2020-06-29T22:02:04.090Z',
errors=[
'Accounts unable to be aggregated.'
],
warnings=[
'Account Skipped'
],
stats=sailpoint.beta.models.account_aggregation_completed_stats.AccountAggregationCompleted_stats(
scanned = 200,
unchanged = 190,
changed = 6,
added = 4,
removed = 3, )
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/Beta/Models/AccountAggregationCompletedSource.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: beta-account-aggregation-completed-source
title: AccountAggregationCompletedSource
pagination_label: AccountAggregationCompletedSource
sidebar_label: AccountAggregationCompletedSource
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAggregationCompletedSource', 'BetaAccountAggregationCompletedSource']
slug: /tools/sdk/python/beta/models/account-aggregation-completed-source
tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedSource', 'BetaAccountAggregationCompletedSource']
---
# AccountAggregationCompletedSource
The source the accounts are being aggregated from.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'SOURCE' ] | The DTO type of the source the accounts are being aggregated from. | [required]
**id** | **str** | The ID of the source the accounts are being aggregated from. | [required]
**name** | **str** | Display name of the source the accounts are being aggregated from. | [required]
}
## Example
```python
from sailpoint.beta.models.account_aggregation_completed_source import AccountAggregationCompletedSource
account_aggregation_completed_source = AccountAggregationCompletedSource(
type='SOURCE',
id='2c9180835d191a86015d28455b4b232a',
name='HR Active Directory'
)
```
[[Back to top]](#)

42
docs/tools/sdk/python/Reference/Beta/Models/AccountAggregationCompletedStats.md Normal file
View File

@@ -0,0 +1,42 @@
---
id: beta-account-aggregation-completed-stats
title: AccountAggregationCompletedStats
pagination_label: AccountAggregationCompletedStats
sidebar_label: AccountAggregationCompletedStats
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAggregationCompletedStats', 'BetaAccountAggregationCompletedStats']
slug: /tools/sdk/python/beta/models/account-aggregation-completed-stats
tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedStats', 'BetaAccountAggregationCompletedStats']
---
# AccountAggregationCompletedStats
Overall statistics about the account aggregation.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**scanned** | **int** | The number of accounts which were scanned / iterated over. | [required]
**unchanged** | **int** | The number of accounts which existed before, but had no changes. | [required]
**changed** | **int** | The number of accounts which existed before, but had changes. | [required]
**added** | **int** | The number of accounts which are new - have not existed before. | [required]
**removed** | **int** | The number accounts which existed before, but no longer exist (thus getting removed). | [required]
}
## Example
```python
from sailpoint.beta.models.account_aggregation_completed_stats import AccountAggregationCompletedStats
account_aggregation_completed_stats = AccountAggregationCompletedStats(
scanned=200,
unchanged=190,
changed=6,
added=4,
removed=3
)
```
[[Back to top]](#)

39
docs/tools/sdk/python/Reference/Beta/Models/AccountAggregationStatus.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: beta-account-aggregation-status
title: AccountAggregationStatus
pagination_label: AccountAggregationStatus
sidebar_label: AccountAggregationStatus
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAggregationStatus', 'BetaAccountAggregationStatus']
slug: /tools/sdk/python/beta/models/account-aggregation-status
tags: ['SDK', 'Software Development Kit', 'AccountAggregationStatus', 'BetaAccountAggregationStatus']
---
# AccountAggregationStatus
## Properties
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]
**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]
}
## Example
```python
from sailpoint.beta.models.account_aggregation_status import AccountAggregationStatus
account_aggregation_status = AccountAggregationStatus(
start='2021-01-31T14:30:05.104Z',
status='ACCOUNTS_COLLECTED',
total_accounts=520,
processed_accounts=150
)
```
[[Back to top]](#)

33
docs/tools/sdk/python/Reference/Beta/Models/AccountAttributes.md Normal file
View File

@@ -0,0 +1,33 @@
---
id: beta-account-attributes
title: AccountAttributes
pagination_label: AccountAttributes
sidebar_label: AccountAttributes
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAttributes', 'BetaAccountAttributes']
slug: /tools/sdk/python/beta/models/account-attributes
tags: ['SDK', 'Software Development Kit', 'AccountAttributes', 'BetaAccountAttributes']
---
# AccountAttributes
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attributes** | **object** | The schema attribute values for the account | [required]
}
## Example
```python
from sailpoint.beta.models.account_attributes import AccountAttributes
account_attributes = AccountAttributes(
attributes={city=Austin, displayName=John Doe, userName=jdoe, sAMAccountName=jDoe, mail=john.doe@sailpoint.com}
)
```
[[Back to top]](#)

55
docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChanged.md Normal file
View File

@@ -0,0 +1,55 @@
---
id: beta-account-attributes-changed
title: AccountAttributesChanged
pagination_label: AccountAttributesChanged
sidebar_label: AccountAttributesChanged
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAttributesChanged', 'BetaAccountAttributesChanged']
slug: /tools/sdk/python/beta/models/account-attributes-changed
tags: ['SDK', 'Software Development Kit', 'AccountAttributesChanged', 'BetaAccountAttributesChanged']
---
# AccountAttributesChanged
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identity** | [**AccountAttributesChangedIdentity**](account-attributes-changed-identity) | | [required]
**source** | [**AccountAttributesChangedSource**](account-attributes-changed-source) | | [required]
**account** | [**AccountAttributesChangedAccount**](account-attributes-changed-account) | | [required]
**changes** | [**[]AccountAttributesChangedChangesInner**](account-attributes-changed-changes-inner) | A list of attributes that changed. | [required]
}
## Example
```python
from sailpoint.beta.models.account_attributes_changed import AccountAttributesChanged
account_attributes_changed = AccountAttributesChanged(
identity=sailpoint.beta.models.account_attributes_changed_identity.AccountAttributesChanged_identity(
type = 'IDENTITY',
id = '2c7180a46faadee4016fb4e018c20642',
name = 'Michael Michaels', ),
source=sailpoint.beta.models.account_attributes_changed_source.AccountAttributesChanged_source(
id = '4e4d982dddff4267ab12f0f1e72b5a6d',
type = 'SOURCE',
name = 'Corporate Active Directory', ),
account=sailpoint.beta.models.account_attributes_changed_account.AccountAttributesChanged_account(
id = '52170a74-ca89-11ea-87d0-0242ac130003',
uuid = '1cb1f07d-3e5a-4431-becd-234fa4306108',
name = 'john.doe',
native_identity = 'cn=john.doe,ou=users,dc=acme,dc=com',
type = ACCOUNT, ),
changes=[
sailpoint.beta.models.account_attributes_changed_changes_inner.AccountAttributesChanged_changes_inner(
attribute = 'sn',
old_value = doe,
new_value = ryans, )
]
)
```
[[Back to top]](#)

42
docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedAccount.md Normal file
View File

@@ -0,0 +1,42 @@
---
id: beta-account-attributes-changed-account
title: AccountAttributesChangedAccount
pagination_label: AccountAttributesChangedAccount
sidebar_label: AccountAttributesChangedAccount
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAttributesChangedAccount', 'BetaAccountAttributesChangedAccount']
slug: /tools/sdk/python/beta/models/account-attributes-changed-account
tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedAccount', 'BetaAccountAttributesChangedAccount']
---
# AccountAttributesChangedAccount
Details of the account where the attributes changed.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | SailPoint generated unique identifier. | [required]
**uuid** | **str** | The source's unique identifier for the account. UUID is generated by the source system. | [required]
**name** | **str** | Name of the account. | [required]
**native_identity** | **str** | Unique ID of the account on the source. | [required]
**type** | **Enum** [ 'ACCOUNT' ] | The type of the account | [required]
}
## Example
```python
from sailpoint.beta.models.account_attributes_changed_account import AccountAttributesChangedAccount
account_attributes_changed_account = AccountAttributesChangedAccount(
id='52170a74-ca89-11ea-87d0-0242ac130003',
uuid='1cb1f07d-3e5a-4431-becd-234fa4306108',
name='john.doe',
native_identity='cn=john.doe,ou=users,dc=acme,dc=com',
type=ACCOUNT
)
```
[[Back to top]](#)

37
docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedChangesInner.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-account-attributes-changed-changes-inner
title: AccountAttributesChangedChangesInner
pagination_label: AccountAttributesChangedChangesInner
sidebar_label: AccountAttributesChangedChangesInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAttributesChangedChangesInner', 'BetaAccountAttributesChangedChangesInner']
slug: /tools/sdk/python/beta/models/account-attributes-changed-changes-inner
tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInner', 'BetaAccountAttributesChangedChangesInner']
---
# AccountAttributesChangedChangesInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attribute** | **str** | The name of the attribute. | [required]
**old_value** | [**AccountAttributesChangedChangesInnerOldValue**](account-attributes-changed-changes-inner-old-value) | | [required]
**new_value** | [**AccountAttributesChangedChangesInnerNewValue**](account-attributes-changed-changes-inner-new-value) | | [required]
}
## Example
```python
from sailpoint.beta.models.account_attributes_changed_changes_inner import AccountAttributesChangedChangesInner
account_attributes_changed_changes_inner = AccountAttributesChangedChangesInner(
attribute='sn',
old_value=doe,
new_value=ryans
)
```
[[Back to top]](#)

32
docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedChangesInnerNewValue.md Normal file
View File

@@ -0,0 +1,32 @@
---
id: beta-account-attributes-changed-changes-inner-new-value
title: AccountAttributesChangedChangesInnerNewValue
pagination_label: AccountAttributesChangedChangesInnerNewValue
sidebar_label: AccountAttributesChangedChangesInnerNewValue
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAttributesChangedChangesInnerNewValue', 'BetaAccountAttributesChangedChangesInnerNewValue']
slug: /tools/sdk/python/beta/models/account-attributes-changed-changes-inner-new-value
tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInnerNewValue', 'BetaAccountAttributesChangedChangesInnerNewValue']
---
# AccountAttributesChangedChangesInnerNewValue
The new value of the attribute.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
}
## Example
```python
from sailpoint.beta.models.account_attributes_changed_changes_inner_new_value import AccountAttributesChangedChangesInnerNewValue
account_attributes_changed_changes_inner_new_value = AccountAttributesChangedChangesInnerNewValue(
)
```
[[Back to top]](#)

32
docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedChangesInnerOldValue.md Normal file
View File

@@ -0,0 +1,32 @@
---
id: beta-account-attributes-changed-changes-inner-old-value
title: AccountAttributesChangedChangesInnerOldValue
pagination_label: AccountAttributesChangedChangesInnerOldValue
sidebar_label: AccountAttributesChangedChangesInnerOldValue
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAttributesChangedChangesInnerOldValue', 'BetaAccountAttributesChangedChangesInnerOldValue']
slug: /tools/sdk/python/beta/models/account-attributes-changed-changes-inner-old-value
tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInnerOldValue', 'BetaAccountAttributesChangedChangesInnerOldValue']
---
# AccountAttributesChangedChangesInnerOldValue
The previous value of the attribute.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
}
## Example
```python
from sailpoint.beta.models.account_attributes_changed_changes_inner_old_value import AccountAttributesChangedChangesInnerOldValue
account_attributes_changed_changes_inner_old_value = AccountAttributesChangedChangesInnerOldValue(
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedIdentity.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: beta-account-attributes-changed-identity
title: AccountAttributesChangedIdentity
pagination_label: AccountAttributesChangedIdentity
sidebar_label: AccountAttributesChangedIdentity
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAttributesChangedIdentity', 'BetaAccountAttributesChangedIdentity']
slug: /tools/sdk/python/beta/models/account-attributes-changed-identity
tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedIdentity', 'BetaAccountAttributesChangedIdentity']
---
# AccountAttributesChangedIdentity
The identity whose account attributes were updated.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | DTO type of the identity whose account attributes were updated. | [required]
**id** | **str** | ID of the identity whose account attributes were updated. | [required]
**name** | **str** | Display name of the identity whose account attributes were updated. | [required]
}
## Example
```python
from sailpoint.beta.models.account_attributes_changed_identity import AccountAttributesChangedIdentity
account_attributes_changed_identity = AccountAttributesChangedIdentity(
type='IDENTITY',
id='2c7180a46faadee4016fb4e018c20642',
name='Michael Michaels'
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesChangedSource.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: beta-account-attributes-changed-source
title: AccountAttributesChangedSource
pagination_label: AccountAttributesChangedSource
sidebar_label: AccountAttributesChangedSource
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAttributesChangedSource', 'BetaAccountAttributesChangedSource']
slug: /tools/sdk/python/beta/models/account-attributes-changed-source
tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedSource', 'BetaAccountAttributesChangedSource']
---
# AccountAttributesChangedSource
The source that contains the account.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | ID of the object to which this reference applies | [required]
**type** | **Enum** [ 'SOURCE' ] | The type of object that is referenced | [required]
**name** | **str** | Human-readable display name of the object to which this reference applies | [required]
}
## Example
```python
from sailpoint.beta.models.account_attributes_changed_source import AccountAttributesChangedSource
account_attributes_changed_source = AccountAttributesChangedSource(
id='4e4d982dddff4267ab12f0f1e72b5a6d',
type='SOURCE',
name='Corporate Active Directory'
)
```
[[Back to top]](#)

33
docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesCreate.md Normal file
View File

@@ -0,0 +1,33 @@
---
id: beta-account-attributes-create
title: AccountAttributesCreate
pagination_label: AccountAttributesCreate
sidebar_label: AccountAttributesCreate
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAttributesCreate', 'BetaAccountAttributesCreate']
slug: /tools/sdk/python/beta/models/account-attributes-create
tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreate', 'BetaAccountAttributesCreate']
---
# AccountAttributesCreate
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attributes** | [**AccountAttributesCreateAttributes**](account-attributes-create-attributes) | | [required]
}
## Example
```python
from sailpoint.beta.models.account_attributes_create import AccountAttributesCreate
account_attributes_create = AccountAttributesCreate(
attributes={sourceId=34bfcbe116c9407464af37acbaf7a4dc, city=Austin, displayName=John Doe, userName=jdoe, sAMAccountName=jDoe, mail=john.doe@sailpoint.com}
)
```
[[Back to top]](#)

34
docs/tools/sdk/python/Reference/Beta/Models/AccountAttributesCreateAttributes.md Normal file
View File

@@ -0,0 +1,34 @@
---
id: beta-account-attributes-create-attributes
title: AccountAttributesCreateAttributes
pagination_label: AccountAttributesCreateAttributes
sidebar_label: AccountAttributesCreateAttributes
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAttributesCreateAttributes', 'BetaAccountAttributesCreateAttributes']
slug: /tools/sdk/python/beta/models/account-attributes-create-attributes
tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreateAttributes', 'BetaAccountAttributesCreateAttributes']
---
# AccountAttributesCreateAttributes
The schema attribute values for the account
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**source_id** | **str** | Target source to create an account | [required]
}
## Example
```python
from sailpoint.beta.models.account_attributes_create_attributes import AccountAttributesCreateAttributes
account_attributes_create_attributes = AccountAttributesCreateAttributes(
source_id='34bfcbe116c9407464af37acbaf7a4dc'
)
```
[[Back to top]](#)

52
docs/tools/sdk/python/Reference/Beta/Models/AccountCorrelated.md Normal file
View File

@@ -0,0 +1,52 @@
---
id: beta-account-correlated
title: AccountCorrelated
pagination_label: AccountCorrelated
sidebar_label: AccountCorrelated
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountCorrelated', 'BetaAccountCorrelated']
slug: /tools/sdk/python/beta/models/account-correlated
tags: ['SDK', 'Software Development Kit', 'AccountCorrelated', 'BetaAccountCorrelated']
---
# AccountCorrelated
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identity** | [**AccountCorrelatedIdentity**](account-correlated-identity) | | [required]
**source** | [**AccountCorrelatedSource**](account-correlated-source) | | [required]
**account** | [**AccountCorrelatedAccount**](account-correlated-account) | | [required]
**attributes** | **map[string]object** | The attributes associated with the account. Attributes are unique per source. | [required]
**entitlement_count** | **int** | The number of entitlements associated with this account. | [optional]
}
## Example
```python
from sailpoint.beta.models.account_correlated import AccountCorrelated
account_correlated = AccountCorrelated(
identity=sailpoint.beta.models.account_correlated_identity.AccountCorrelated_identity(
type = 'IDENTITY',
id = '2c7180a46faadee4016fb4e018c20642',
name = 'Michael Michaels', ),
source=sailpoint.beta.models.account_correlated_source.AccountCorrelated_source(
type = 'SOURCE',
id = '2c9180835d191a86015d28455b4b232a',
name = 'HR Active Directory', ),
account=sailpoint.beta.models.account_correlated_account.AccountCorrelated_account(
type = 'ACCOUNT',
id = '98da47c31df444558c211f9b205184f6',
name = 'Brian Mendoza',
native_identity = 'cn=john.doe,ou=users,dc=acme,dc=com',
uuid = '1cb1f07d-3e5a-4431-becd-234fa4306108', ),
attributes={sn=doe, givenName=john, memberOf=[cn=g1,ou=groups,dc=acme,dc=com, cn=g2,ou=groups,dc=acme,dc=com, cn=g3,ou=groups,dc=acme,dc=com]},
entitlement_count=0
)
```
[[Back to top]](#)

42
docs/tools/sdk/python/Reference/Beta/Models/AccountCorrelatedAccount.md Normal file
View File

@@ -0,0 +1,42 @@
---
id: beta-account-correlated-account
title: AccountCorrelatedAccount
pagination_label: AccountCorrelatedAccount
sidebar_label: AccountCorrelatedAccount
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountCorrelatedAccount', 'BetaAccountCorrelatedAccount']
slug: /tools/sdk/python/beta/models/account-correlated-account
tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedAccount', 'BetaAccountCorrelatedAccount']
---
# AccountCorrelatedAccount
The correlated account.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'ACCOUNT' ] | The correlated account's DTO type. | [required]
**id** | **str** | The correlated account's ID. | [required]
**name** | **str** | The correlated account's display name. | [required]
**native_identity** | **str** | Unique ID of the account on the source. | [required]
**uuid** | **str** | The source's unique identifier for the account. UUID is generated by the source system. | [optional]
}
## Example
```python
from sailpoint.beta.models.account_correlated_account import AccountCorrelatedAccount
account_correlated_account = AccountCorrelatedAccount(
type='ACCOUNT',
id='98da47c31df444558c211f9b205184f6',
name='Brian Mendoza',
native_identity='cn=john.doe,ou=users,dc=acme,dc=com',
uuid='1cb1f07d-3e5a-4431-becd-234fa4306108'
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/Beta/Models/AccountCorrelatedIdentity.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: beta-account-correlated-identity
title: AccountCorrelatedIdentity
pagination_label: AccountCorrelatedIdentity
sidebar_label: AccountCorrelatedIdentity
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountCorrelatedIdentity', 'BetaAccountCorrelatedIdentity']
slug: /tools/sdk/python/beta/models/account-correlated-identity
tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedIdentity', 'BetaAccountCorrelatedIdentity']
---
# AccountCorrelatedIdentity
Identity the account is correlated with.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | DTO type of the identity the account is correlated with. | [required]
**id** | **str** | ID of the identity the account is correlated with. | [required]
**name** | **str** | Display name of the identity the account is correlated with. | [required]
}
## Example
```python
from sailpoint.beta.models.account_correlated_identity import AccountCorrelatedIdentity
account_correlated_identity = AccountCorrelatedIdentity(
type='IDENTITY',
id='2c7180a46faadee4016fb4e018c20642',
name='Michael Michaels'
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/Beta/Models/AccountCorrelatedSource.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: beta-account-correlated-source
title: AccountCorrelatedSource
pagination_label: AccountCorrelatedSource
sidebar_label: AccountCorrelatedSource
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountCorrelatedSource', 'BetaAccountCorrelatedSource']
slug: /tools/sdk/python/beta/models/account-correlated-source
tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedSource', 'BetaAccountCorrelatedSource']
---
# AccountCorrelatedSource
The source the accounts are being correlated from.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'SOURCE' ] | The DTO type of the source the accounts are being correlated from. | [required]
**id** | **str** | The ID of the source the accounts are being correlated from. | [required]
**name** | **str** | Display name of the source the accounts are being correlated from. | [required]
}
## Example
```python
from sailpoint.beta.models.account_correlated_source import AccountCorrelatedSource
account_correlated_source = AccountCorrelatedSource(
type='SOURCE',
id='2c9180835d191a86015d28455b4b232a',
name='HR Active Directory'
)
```
[[Back to top]](#)

37
docs/tools/sdk/python/Reference/Beta/Models/AccountInfoDto.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-account-info-dto
title: AccountInfoDto
pagination_label: AccountInfoDto
sidebar_label: AccountInfoDto
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountInfoDto', 'BetaAccountInfoDto']
slug: /tools/sdk/python/beta/models/account-info-dto
tags: ['SDK', 'Software Development Kit', 'AccountInfoDto', 'BetaAccountInfoDto']
---
# AccountInfoDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**native_identity** | **str** | The unique ID of the account generated by the source system | [optional]
**display_name** | **str** | Display name for this account | [optional]
**uuid** | **str** | UUID associated with this account | [optional]
}
## Example
```python
from sailpoint.beta.models.account_info_dto import AccountInfoDto
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',
uuid='{ad9fc391-246d-40af-b248-b6556a2b7c01}'
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/Beta/Models/AccountRequestInfo.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: beta-account-request-info
title: AccountRequestInfo
pagination_label: AccountRequestInfo
sidebar_label: AccountRequestInfo
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountRequestInfo', 'BetaAccountRequestInfo']
slug: /tools/sdk/python/beta/models/account-request-info
tags: ['SDK', 'Software Development Kit', 'AccountRequestInfo', 'BetaAccountRequestInfo']
---
# AccountRequestInfo
If an account activity item is associated with an access request, captures details of that request.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**requested_object_id** | **str** | Id of requested object | [optional]
**requested_object_name** | **str** | Human-readable name of requested object | [optional]
**requested_object_type** | [**RequestableObjectType**](requestable-object-type) | | [optional]
}
## Example
```python
from sailpoint.beta.models.account_request_info import AccountRequestInfo
account_request_info = AccountRequestInfo(
requested_object_id='2c91808563ef85690164001c31140c0c',
requested_object_name='Treasury Analyst',
requested_object_type='ACCESS_PROFILE'
)
```
[[Back to top]](#)

50
docs/tools/sdk/python/Reference/Beta/Models/AccountStatusChanged.md Normal file
View File

@@ -0,0 +1,50 @@
---
id: beta-account-status-changed
title: AccountStatusChanged
pagination_label: AccountStatusChanged
sidebar_label: AccountStatusChanged
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountStatusChanged', 'BetaAccountStatusChanged']
slug: /tools/sdk/python/beta/models/account-status-changed
tags: ['SDK', 'Software Development Kit', 'AccountStatusChanged', 'BetaAccountStatusChanged']
---
# AccountStatusChanged
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**event_type** | **str** | the event type | [optional]
**identity_id** | **str** | the identity id | [optional]
**dt** | **str** | the date of event | [optional]
**account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional]
**status_change** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional]
}
## Example
```python
from sailpoint.beta.models.account_status_changed import AccountStatusChanged
account_status_changed = AccountStatusChanged(
event_type='',
identity_id='',
dt='',
account=sailpoint.beta.models.account_status_changed_account.AccountStatusChanged_account(
id = '',
native_identity = '',
display_name = '',
source_id = '',
source_name = '',
entitlement_count = 56,
access_type = '', ),
status_change=sailpoint.beta.models.account_status_changed_status_change.AccountStatusChanged_statusChange(
previous_status = 'enabled',
new_status = 'enabled', )
)
```
[[Back to top]](#)

45
docs/tools/sdk/python/Reference/Beta/Models/AccountStatusChangedAccount.md Normal file
View File

@@ -0,0 +1,45 @@
---
id: beta-account-status-changed-account
title: AccountStatusChangedAccount
pagination_label: AccountStatusChangedAccount
sidebar_label: AccountStatusChangedAccount
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountStatusChangedAccount', 'BetaAccountStatusChangedAccount']
slug: /tools/sdk/python/beta/models/account-status-changed-account
tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedAccount', 'BetaAccountStatusChangedAccount']
---
# AccountStatusChangedAccount
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | the ID of the account in the database | [optional]
**native_identity** | **str** | the native identifier of the account | [optional]
**display_name** | **str** | the display name of the account | [optional]
**source_id** | **str** | the ID of the source for this account | [optional]
**source_name** | **str** | the name of the source for this account | [optional]
**entitlement_count** | **int** | the number of entitlements on this account | [optional]
**access_type** | **str** | this value is always \"account\" | [optional]
}
## Example
```python
from sailpoint.beta.models.account_status_changed_account import AccountStatusChangedAccount
account_status_changed_account = AccountStatusChangedAccount(
id='',
native_identity='',
display_name='',
source_id='',
source_name='',
entitlement_count=56,
access_type=''
)
```
[[Back to top]](#)

35
docs/tools/sdk/python/Reference/Beta/Models/AccountStatusChangedStatusChange.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: beta-account-status-changed-status-change
title: AccountStatusChangedStatusChange
pagination_label: AccountStatusChangedStatusChange
sidebar_label: AccountStatusChangedStatusChange
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountStatusChangedStatusChange', 'BetaAccountStatusChangedStatusChange']
slug: /tools/sdk/python/beta/models/account-status-changed-status-change
tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedStatusChange', 'BetaAccountStatusChangedStatusChange']
---
# AccountStatusChangedStatusChange
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**previous_status** | **Enum** [ 'enabled', 'disabled', 'locked' ] | the previous status of the account | [optional]
**new_status** | **Enum** [ 'enabled', 'disabled', 'locked' ] | the new status of the account | [optional]
}
## Example
```python
from sailpoint.beta.models.account_status_changed_status_change import AccountStatusChangedStatusChange
account_status_changed_status_change = AccountStatusChangedStatusChange(
previous_status='enabled',
new_status='enabled'
)
```
[[Back to top]](#)

36
docs/tools/sdk/python/Reference/Beta/Models/AccountToggleRequest.md Normal file
View File

@@ -0,0 +1,36 @@
---
id: beta-account-toggle-request
title: AccountToggleRequest
pagination_label: AccountToggleRequest
sidebar_label: AccountToggleRequest
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountToggleRequest', 'BetaAccountToggleRequest']
slug: /tools/sdk/python/beta/models/account-toggle-request
tags: ['SDK', 'Software Development Kit', 'AccountToggleRequest', 'BetaAccountToggleRequest']
---
# AccountToggleRequest
Request used for account enable/disable
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**external_verification_id** | **str** | If set, an external process validates that the user wants to proceed with this request. | [optional]
**force_provisioning** | **bool** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. | [optional]
}
## Example
```python
from sailpoint.beta.models.account_toggle_request import AccountToggleRequest
account_toggle_request = AccountToggleRequest(
external_verification_id='3f9180835d2e5168015d32f890ca1581',
force_provisioning=False
)
```
[[Back to top]](#)

50
docs/tools/sdk/python/Reference/Beta/Models/AccountUncorrelated.md Normal file
View File

@@ -0,0 +1,50 @@
---
id: beta-account-uncorrelated
title: AccountUncorrelated
pagination_label: AccountUncorrelated
sidebar_label: AccountUncorrelated
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountUncorrelated', 'BetaAccountUncorrelated']
slug: /tools/sdk/python/beta/models/account-uncorrelated
tags: ['SDK', 'Software Development Kit', 'AccountUncorrelated', 'BetaAccountUncorrelated']
---
# AccountUncorrelated
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identity** | [**AccountUncorrelatedIdentity**](account-uncorrelated-identity) | | [required]
**source** | [**AccountUncorrelatedSource**](account-uncorrelated-source) | | [required]
**account** | [**AccountUncorrelatedAccount**](account-uncorrelated-account) | | [required]
**entitlement_count** | **int** | The number of entitlements associated with this account. | [optional]
}
## Example
```python
from sailpoint.beta.models.account_uncorrelated import AccountUncorrelated
account_uncorrelated = AccountUncorrelated(
identity=sailpoint.beta.models.account_uncorrelated_identity.AccountUncorrelated_identity(
type = 'IDENTITY',
id = '2c3780a46faadee4016fb4e018c20652',
name = 'Allen Albertson', ),
source=sailpoint.beta.models.account_uncorrelated_source.AccountUncorrelated_source(
type = 'SOURCE',
id = '2c6180835d191a86015d28455b4b231b',
name = 'Corporate Directory', ),
account=sailpoint.beta.models.account_uncorrelated_account.AccountUncorrelated_account(
type = ACCOUNT,
id = '4dd497e3723e439991cb6d0e478375dd',
name = 'Sadie Jensen',
native_identity = 'cn=john.doe,ou=users,dc=acme,dc=com',
uuid = '1cb1f07d-3e5a-4431-becd-234fa4306108', ),
entitlement_count=0
)
```
[[Back to top]](#)

42
docs/tools/sdk/python/Reference/Beta/Models/AccountUncorrelatedAccount.md Normal file
View File

@@ -0,0 +1,42 @@
---
id: beta-account-uncorrelated-account
title: AccountUncorrelatedAccount
pagination_label: AccountUncorrelatedAccount
sidebar_label: AccountUncorrelatedAccount
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountUncorrelatedAccount', 'BetaAccountUncorrelatedAccount']
slug: /tools/sdk/python/beta/models/account-uncorrelated-account
tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedAccount', 'BetaAccountUncorrelatedAccount']
---
# AccountUncorrelatedAccount
Uncorrelated account.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'ACCOUNT' ] | Uncorrelated account's DTO type. | [required]
**id** | **str** | Uncorrelated account's ID. | [required]
**name** | **str** | Uncorrelated account's display name. | [required]
**native_identity** | **str** | Unique ID of the account on the source. | [required]
**uuid** | **str** | The source's unique identifier for the account. UUID is generated by the source system. | [optional]
}
## Example
```python
from sailpoint.beta.models.account_uncorrelated_account import AccountUncorrelatedAccount
account_uncorrelated_account = AccountUncorrelatedAccount(
type=ACCOUNT,
id='4dd497e3723e439991cb6d0e478375dd',
name='Sadie Jensen',
native_identity='cn=john.doe,ou=users,dc=acme,dc=com',
uuid='1cb1f07d-3e5a-4431-becd-234fa4306108'
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/Beta/Models/AccountUncorrelatedIdentity.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: beta-account-uncorrelated-identity
title: AccountUncorrelatedIdentity
pagination_label: AccountUncorrelatedIdentity
sidebar_label: AccountUncorrelatedIdentity
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountUncorrelatedIdentity', 'BetaAccountUncorrelatedIdentity']
slug: /tools/sdk/python/beta/models/account-uncorrelated-identity
tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedIdentity', 'BetaAccountUncorrelatedIdentity']
---
# AccountUncorrelatedIdentity
Identity the account is uncorrelated with.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | DTO type of the identity the account is uncorrelated with. | [required]
**id** | **str** | ID of the identity the account is uncorrelated with. | [required]
**name** | **str** | Display name of the identity the account is uncorrelated with. | [required]
}
## Example
```python
from sailpoint.beta.models.account_uncorrelated_identity import AccountUncorrelatedIdentity
account_uncorrelated_identity = AccountUncorrelatedIdentity(
type='IDENTITY',
id='2c3780a46faadee4016fb4e018c20652',
name='Allen Albertson'
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/Beta/Models/AccountUncorrelatedSource.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: beta-account-uncorrelated-source
title: AccountUncorrelatedSource
pagination_label: AccountUncorrelatedSource
sidebar_label: AccountUncorrelatedSource
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountUncorrelatedSource', 'BetaAccountUncorrelatedSource']
slug: /tools/sdk/python/beta/models/account-uncorrelated-source
tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedSource', 'BetaAccountUncorrelatedSource']
---
# AccountUncorrelatedSource
The source the accounts are uncorrelated from.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'SOURCE' ] | The DTO type of the source the accounts are uncorrelated from. | [required]
**id** | **str** | The ID of the source the accounts are uncorrelated from. | [required]
**name** | **str** | Display name of the source the accounts are uncorrelated from. | [required]
}
## Example
```python
from sailpoint.beta.models.account_uncorrelated_source import AccountUncorrelatedSource
account_uncorrelated_source = AccountUncorrelatedSource(
type='SOURCE',
id='2c6180835d191a86015d28455b4b231b',
name='Corporate Directory'
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/Beta/Models/AccountUnlockRequest.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: beta-account-unlock-request
title: AccountUnlockRequest
pagination_label: AccountUnlockRequest
sidebar_label: AccountUnlockRequest
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountUnlockRequest', 'BetaAccountUnlockRequest']
slug: /tools/sdk/python/beta/models/account-unlock-request
tags: ['SDK', 'Software Development Kit', 'AccountUnlockRequest', 'BetaAccountUnlockRequest']
---
# AccountUnlockRequest
Request used for account unlock
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**external_verification_id** | **str** | If set, an external process validates that the user wants to proceed with this request. | [optional]
**unlock_idn_account** | **bool** | If set, the IDN account is unlocked after the workflow completes. | [optional]
**force_provisioning** | **bool** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. | [optional]
}
## Example
```python
from sailpoint.beta.models.account_unlock_request import AccountUnlockRequest
account_unlock_request = AccountUnlockRequest(
external_verification_id='3f9180835d2e5168015d32f890ca1581',
unlock_idn_account=False,
force_provisioning=False
)
```
[[Back to top]](#)

35
docs/tools/sdk/python/Reference/Beta/Models/AccountUsage.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: beta-account-usage
title: AccountUsage
pagination_label: AccountUsage
sidebar_label: AccountUsage
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountUsage', 'BetaAccountUsage']
slug: /tools/sdk/python/beta/models/account-usage
tags: ['SDK', 'Software Development Kit', 'AccountUsage', 'BetaAccountUsage']
---
# AccountUsage
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**var_date** | **date** | The first day of the month for which activity is aggregated. | [optional]
**count** | **int** | The number of days within the month that the account was active in a source. | [optional]
}
## Example
```python
from sailpoint.beta.models.account_usage import AccountUsage
account_usage = AccountUsage(
var_date='Thu Apr 20 20:00:00 EDT 2023',
count=10
)
```
[[Back to top]](#)

34
docs/tools/sdk/python/Reference/Beta/Models/AccountsAsyncResult.md Normal file
View File

@@ -0,0 +1,34 @@
---
id: beta-accounts-async-result
title: AccountsAsyncResult
pagination_label: AccountsAsyncResult
sidebar_label: AccountsAsyncResult
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountsAsyncResult', 'BetaAccountsAsyncResult']
slug: /tools/sdk/python/beta/models/accounts-async-result
tags: ['SDK', 'Software Development Kit', 'AccountsAsyncResult', 'BetaAccountsAsyncResult']
---
# AccountsAsyncResult
Accounts async response containing details on started async process
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | id of the task | [required]
}
## Example
```python
from sailpoint.beta.models.accounts_async_result import AccountsAsyncResult
accounts_async_result = AccountsAsyncResult(
id='2c91808474683da6017468693c260195'
)
```
[[Back to top]](#)

57
docs/tools/sdk/python/Reference/Beta/Models/AccountsCollectedForAggregation.md Normal file
View File

@@ -0,0 +1,57 @@
---
id: beta-accounts-collected-for-aggregation
title: AccountsCollectedForAggregation
pagination_label: AccountsCollectedForAggregation
sidebar_label: AccountsCollectedForAggregation
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountsCollectedForAggregation', 'BetaAccountsCollectedForAggregation']
slug: /tools/sdk/python/beta/models/accounts-collected-for-aggregation
tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregation', 'BetaAccountsCollectedForAggregation']
---
# AccountsCollectedForAggregation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**source** | [**AccountsCollectedForAggregationSource**](accounts-collected-for-aggregation-source) | | [required]
**status** | **Enum** [ 'Success', 'Failed', 'Terminated' ] | The overall status of the collection. | [required]
**started** | **datetime** | The date and time when the account collection started. | [required]
**completed** | **datetime** | The date and time when the account collection finished. | [required]
**errors** | **[]str** | A list of errors that occurred during the collection. | [required]
**warnings** | **[]str** | A list of warnings that occurred during the collection. | [required]
**stats** | [**AccountsCollectedForAggregationStats**](accounts-collected-for-aggregation-stats) | | [required]
}
## Example
```python
from sailpoint.beta.models.accounts_collected_for_aggregation import AccountsCollectedForAggregation
accounts_collected_for_aggregation = AccountsCollectedForAggregation(
source=sailpoint.beta.models.accounts_collected_for_aggregation_source.AccountsCollectedForAggregation_source(
id = '4e4d982dddff4267ab12f0f1e72b5a6d',
type = 'SOURCE',
name = 'Corporate Active Directory', ),
status=Success,
started='2020-06-29T22:01:50.474Z',
completed='2020-06-29T22:02:04.090Z',
errors=[
'Unable to collect accounts for aggregation.'
],
warnings=[
'Account Skipped'
],
stats=sailpoint.beta.models.accounts_collected_for_aggregation_stats.AccountsCollectedForAggregation_stats(
scanned = 200,
unchanged = 190,
changed = 6,
added = 4,
removed = 3, )
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/Beta/Models/AccountsCollectedForAggregationSource.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: beta-accounts-collected-for-aggregation-source
title: AccountsCollectedForAggregationSource
pagination_label: AccountsCollectedForAggregationSource
sidebar_label: AccountsCollectedForAggregationSource
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountsCollectedForAggregationSource', 'BetaAccountsCollectedForAggregationSource']
slug: /tools/sdk/python/beta/models/accounts-collected-for-aggregation-source
tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregationSource', 'BetaAccountsCollectedForAggregationSource']
---
# AccountsCollectedForAggregationSource
Reference to the source that has been aggregated.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | ID of the object to which this reference applies | [required]
**type** | **Enum** [ 'SOURCE' ] | The type of object that is referenced | [required]
**name** | **str** | Human-readable display name of the object to which this reference applies | [required]
}
## Example
```python
from sailpoint.beta.models.accounts_collected_for_aggregation_source import AccountsCollectedForAggregationSource
accounts_collected_for_aggregation_source = AccountsCollectedForAggregationSource(
id='4e4d982dddff4267ab12f0f1e72b5a6d',
type='SOURCE',
name='Corporate Active Directory'
)
```
[[Back to top]](#)

42
docs/tools/sdk/python/Reference/Beta/Models/AccountsCollectedForAggregationStats.md Normal file
View File

@@ -0,0 +1,42 @@
---
id: beta-accounts-collected-for-aggregation-stats
title: AccountsCollectedForAggregationStats
pagination_label: AccountsCollectedForAggregationStats
sidebar_label: AccountsCollectedForAggregationStats
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountsCollectedForAggregationStats', 'BetaAccountsCollectedForAggregationStats']
slug: /tools/sdk/python/beta/models/accounts-collected-for-aggregation-stats
tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregationStats', 'BetaAccountsCollectedForAggregationStats']
---
# AccountsCollectedForAggregationStats
Overall statistics about the account collection.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**scanned** | **int** | The number of accounts which were scanned / iterated over. | [required]
**unchanged** | **int** | The number of accounts which existed before, but had no changes. | [required]
**changed** | **int** | The number of accounts which existed before, but had changes. | [required]
**added** | **int** | The number of accounts which are new - have not existed before. | [required]
**removed** | **int** | The number accounts which existed before, but no longer exist (thus getting removed). | [required]
}
## Example
```python
from sailpoint.beta.models.accounts_collected_for_aggregation_stats import AccountsCollectedForAggregationStats
accounts_collected_for_aggregation_stats = AccountsCollectedForAggregationStats(
scanned=200,
unchanged=190,
changed=6,
added=4,
removed=3
)
```
[[Back to top]](#)

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