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

Update python SDK docs: 16525292132

Browse Source
This commit is contained in:
developer-relations-sp
2025-07-25 15:10:03 +00:00
parent be23bab385
commit 993bfb3fea
101 changed files with 2689 additions and 1526 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/tools/sdk/python/Reference/Beta/Models/AccessItemAccessProfileResponse.md
View File

@@ -16,18 +16,17 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponse', 'Be
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]
**access_type** | **str** | the access item type. accessProfile in this case | [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]
**source_name** | **str** | the name of the source | [optional]
**entitlement_count** | **int** | the number of entitlements the access profile will create | [required]
**description** | **str** | the description for the access profile | [optional]
**source_id** | **str** | the id of the source | [optional]
**app_refs** | [**[]AccessItemAccessProfileResponseAppRefsInner**](access-item-access-profile-response-app-refs-inner) | the list of app ids associated with the access profile | [required]
**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]
**revocable** | **bool** | indicates whether the access profile is revocable | [required]
}
## Example
@@ -36,15 +35,14 @@ Name | Type | Description | Notes
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',
access_type='accessProfile',
display_name='Dr. Arden Rogahn MD',
entitlement_count='12',
app_display_name='AppName',
source_name='DataScienceDataset',
entitlement_count=12,
description='AccessProfile - Workday/Citizenship access',
source_id='2793o32dwd',
app_refs=[{cloudAppId=8c190e6787aa4ed9a90bd9d5344523fb, cloudAppName=Sample App}, {cloudAppId=2c91808a77ff216301782327a50f09bf, cloudAppName=Another App}],
remove_date='2024-07-01T06:00:00.00Z',
standalone=False,
revocable=True

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

@@ -0,0 +1,35 @@
---
id: beta-access-item-access-profile-response-app-refs-inner
title: AccessItemAccessProfileResponseAppRefsInner
pagination_label: AccessItemAccessProfileResponseAppRefsInner
sidebar_label: AccessItemAccessProfileResponseAppRefsInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessItemAccessProfileResponseAppRefsInner', 'BetaAccessItemAccessProfileResponseAppRefsInner']
slug: /tools/sdk/python/beta/models/access-item-access-profile-response-app-refs-inner
tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponseAppRefsInner', 'BetaAccessItemAccessProfileResponseAppRefsInner']
---
# AccessItemAccessProfileResponseAppRefsInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cloud_app_id** | **str** | the cloud app id associated with the access profile | [optional]
**cloud_app_name** | **str** | the cloud app name associated with the access profile | [optional]
}
## Example
```python
from sailpoint.beta.models.access_item_access_profile_response_app_refs_inner import AccessItemAccessProfileResponseAppRefsInner
access_item_access_profile_response_app_refs_inner = AccessItemAccessProfileResponseAppRefsInner(
cloud_app_id='8c190e6787aa4ed9a90bd9d5344523fb',
cloud_app_name='Sample App'
)
```
[[Back to top]](#)

18
docs/tools/sdk/python/Reference/Beta/Models/AccessItemAccountResponse.md
View File

@@ -16,13 +16,13 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAccountResponse', 'BetaAcce
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]
**access_type** | **str** | the access item type. account in this case | [optional]
**display_name** | **str** | the display name of the identity | [optional]
**source_name** | **str** | the name of the source | [optional]
**native_identity** | **str** | the native identifier used to uniquely identify an acccount | [required]
**source_id** | **str** | the id of the source | [optional]
**entitlement_count** | **int** | the number of entitlements the account will create | [optional]
}
## Example
@@ -31,13 +31,13 @@ Name | Type | Description | Notes
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',
access_type='account',
display_name='Dr. Arden Rogahn MD',
source_name='DataScienceDataset',
native_identity='dr.arden.ogahn.d',
source_id='2793o32dwd',
entitlement_count='12',
display_name='Dr. Arden Rogahn MD'
entitlement_count=12
)
```

6
docs/tools/sdk/python/Reference/Beta/Models/AccessItemAppResponse.md
View File

@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAppResponse', 'BetaAccessIt
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. entitlement in this case | [optional]
**id** | **str** | the access item id | [optional]
**access_type** | **str** | the access item type. entitlement in this case | [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]
**app_role_id** | **str** | the app role id | [required]
}
## Example
@@ -29,8 +29,8 @@ Name | Type | Description | Notes
from sailpoint.beta.models.access_item_app_response import AccessItemAppResponse
access_item_app_response = AccessItemAppResponse(
access_type='app',
id='2c918087763e69d901763e72e97f006f',
access_type='app',
display_name='Display Name',
source_name='appName',
app_role_id='2c918087763e69d901763e72e97f006f'

20
docs/tools/sdk/python/Reference/Beta/Models/AccessItemAssociated.md
View File

@@ -16,11 +16,12 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAssociated', 'BetaAccessIte
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]
**date_time** | **str** | the date of event | [optional]
**identity_id** | **str** | the identity id | [optional]
**access_item** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [required]
**governance_event** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [required]
**access_item_type** | **Enum** [ 'account', 'app', 'entitlement', 'role', 'accessProfile' ] | the access item type | [optional]
}
## Example
@@ -29,20 +30,21 @@ Name | Type | Description | Notes
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',
date_time='2019-03-08T22:37:33.901Z',
identity_id='8c190e6787aa4ed9a90bd9d5344523fb',
access_item={id=8c190e6787aa4ed9a90bd9d5344523fb, accessType=account, nativeIdentity=127999, sourceName=JDBC Entitlements Source, entitlementCount=0, displayName=Sample Name},
governance_event=sailpoint.beta.models.correlated_governance_event.CorrelatedGovernanceEvent(
name = 'Manager Certification for Jon Snow',
dt = '2019-03-08T22:37:33.901Z',
date_time = '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', ), )
display_name = 'John Snow', ), ),
access_item_type='account'
)
```

56
docs/tools/sdk/python/Reference/Beta/Models/AccessItemAssociatedAccessItem.md
View File

@@ -16,25 +16,24 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAssociatedAccessItem', 'Bet
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]
**access_type** | **str** | the access item type. entitlement in this case | [optional]
**display_name** | **str** | the access item display name | [optional]
**source_name** | **str** | the associated source name if it exists | [optional]
**source_id** | **str** | the id of the source | [optional]
**attribute** | **str** | the entitlement attribute | [required]
**value** | **str** | the associated value | [required]
**type** | **str** | the type of entitlement | [required]
**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]
**source_id** | **str** | the id of the source | [optional]
**standalone** | **bool** | indicates whether the access profile is standalone | [required]
**privileged** | **bool** | indicates whether the entitlement is privileged | [required]
**cloud_governed** | **bool** | indicates whether the entitlement is cloud governed | [required]
**entitlement_count** | **int** | the number of entitlements the account will create | [required]
**app_refs** | [**[]AccessItemAccessProfileResponseAppRefsInner**](access-item-access-profile-response-app-refs-inner) | the list of app ids associated with the access profile | [required]
**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]
**native_identity** | **str** | the native identifier used to uniquely identify an acccount | [required]
**app_role_id** | **str** | the app role id | [required]
}
## Example
@@ -43,25 +42,24 @@ Name | Type | Description | Notes
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',
access_type='app',
display_name='Display Name',
source_name='appName',
attribute='groups',
value='Upward mobility access',
entitlement_type='entitlement',
type='ENTITLEMENT',
description='Role - Workday/Citizenship access',
source_id='2793o32dwd',
standalone=False,
privileged=False,
cloud_governed=True
cloud_governed=True,
entitlement_count=12,
app_refs=[{cloudAppId=8c190e6787aa4ed9a90bd9d5344523fb, cloudAppName=Sample App}, {cloudAppId=2c91808a77ff216301782327a50f09bf, cloudAppName=Another App}],
remove_date='2024-07-01T06:00:00.00Z',
revocable=True,
native_identity='dr.arden.ogahn.d',
app_role_id='2c918087763e69d901763e72e97f006f'
)
```

24
docs/tools/sdk/python/Reference/Beta/Models/AccessItemEntitlementResponse.md
View File

@@ -16,15 +16,15 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemEntitlementResponse', 'Beta
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]
**access_type** | **str** | the access item type. entitlement in this case | [optional]
**display_name** | **str** | the display name of the identity | [optional]
**source_name** | **str** | the name of the source | [optional]
**attribute** | **str** | the entitlement attribute | [required]
**value** | **str** | the associated value | [required]
**type** | **str** | the type of entitlement | [required]
**description** | **str** | the description for the entitlment | [optional]
**source_id** | **str** | the id of the source | [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]
@@ -36,15 +36,15 @@ Name | Type | Description | Notes
from sailpoint.beta.models.access_item_entitlement_response import AccessItemEntitlementResponse
access_item_entitlement_response = AccessItemEntitlementResponse(
access_type='entitlement',
id='2c918087763e69d901763e72e97f006f',
access_type='entitlement',
display_name='Dr. Arden Rogahn MD',
source_name='DataScienceDataset',
attribute='groups',
value='Upward mobility access',
entitlement_type='entitlement',
source_name='DataScienceDataset',
source_id='2793o32dwd',
type='ENTITLEMENT',
description='Entitlement - Workday/Citizenship access',
display_name='Dr. Arden Rogahn MD',
source_id='2793o32dwd',
standalone=True,
privileged=False,
cloud_governed=True

10
docs/tools/sdk/python/Reference/Beta/Models/AccessItemRemoved.md
View File

@@ -16,10 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemRemoved', 'BetaAccessItemRe
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_item** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional]
**access_item** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [required]
**identity_id** | **str** | the identity id | [optional]
**event_type** | **str** | the event type | [optional]
**dt** | **str** | the date of event | [optional]
**date_time** | **str** | the date of event | [optional]
**access_item_type** | **Enum** [ 'account', 'app', 'entitlement', 'role', 'accessProfile' ] | the access item type | [optional]
**governance_event** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional]
}
@@ -32,10 +33,11 @@ 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',
date_time='2019-03-08T22:37:33.901Z',
access_item_type='account',
governance_event=sailpoint.beta.models.correlated_governance_event.CorrelatedGovernanceEvent(
name = 'Manager Certification for Jon Snow',
dt = '2019-03-08T22:37:33.901Z',
date_time = '2019-03-08T22:37:33.901Z',
type = 'certification',
governance_id = '2c91808a77ff216301782327a50f09bf',
owners = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],

8
docs/tools/sdk/python/Reference/Beta/Models/AccessItemRoleResponse.md
View File

@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemRoleResponse', 'BetaAccessI
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. role in this case | [optional]
**id** | **str** | the access item id | [optional]
**access_type** | **str** | the access item type. role in this case | [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]
**description** | **str** | the description for the role | [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]
}
@@ -31,11 +31,11 @@ Name | Type | Description | Notes
from sailpoint.beta.models.access_item_role_response import AccessItemRoleResponse
access_item_role_response = AccessItemRoleResponse(
access_type='role',
id='2c918087763e69d901763e72e97f006f',
access_type='role',
display_name='sample',
description='Role - Workday/Citizenship access',
source_name='Source Name',
description='Role - Workday/Citizenship access',
remove_date='2024-07-01T06:00:00.00Z',
revocable=True
)

6
docs/tools/sdk/python/Reference/Beta/Models/AccessRequested.md
View File

@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequested', 'BetaAccessRequeste
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_request** | [**AccessRequestResponse1**](access-request-response1) | | [optional]
**access_request** | [**AccessRequestResponse1**](access-request-response1) | | [required]
**identity_id** | **str** | the identity id | [optional]
**event_type** | **str** | the event type | [optional]
**dt** | **str** | the date of event | [optional]
**date_time** | **str** | the date of event | [optional]
}
## Example
@@ -34,7 +34,7 @@ access_request=sailpoint.beta.models.access_request_response_1.AccessRequestResp
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'
date_time='2019-03-08T22:37:33.901Z'
)
```

28
docs/tools/sdk/python/Reference/Beta/Models/AccountStatusChanged.md
View File

@@ -18,9 +18,9 @@ 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]
**date_time** | **str** | the date of event | [optional]
**account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [required]
**status_change** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [required]
}
## Example
@@ -29,20 +29,20 @@ Name | Type | Description | Notes
from sailpoint.beta.models.account_status_changed import AccountStatusChanged
account_status_changed = AccountStatusChanged(
event_type='',
identity_id='',
dt='',
event_type='AccountStatusChanged',
identity_id='8a80828f643d484f01643e14202e206f',
date_time='2019-03-08T22:37:33.901Z',
account=sailpoint.beta.models.account_status_changed_account.AccountStatusChanged_account(
id = '',
native_identity = '',
display_name = '',
source_id = '',
source_name = '',
entitlement_count = 56,
access_type = '', ),
id = '2c91808a77ff216301782327a50f09bf',
native_identity = 'dr.arden.ogahn.d',
display_name = 'Adam Archer',
source_id = '8a80828f643d484f01643e14202e206f',
source_name = 'JDBC Entitlements Source',
entitlement_count = 2,
access_type = 'account', ),
status_change=sailpoint.beta.models.account_status_changed_status_change.AccountStatusChanged_statusChange(
previous_status = 'enabled',
new_status = 'enabled', )
new_status = 'disabled', )
)
```

14
docs/tools/sdk/python/Reference/Beta/Models/AccountStatusChangedAccount.md
View File

@@ -31,13 +31,13 @@ Name | Type | Description | Notes
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=''
id='2c91808a77ff216301782327a50f09bf',
native_identity='dr.arden.ogahn.d',
display_name='Adam Archer',
source_id='8a80828f643d484f01643e14202e206f',
source_name='JDBC Entitlements Source',
entitlement_count=2,
access_type='account'
)
```

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

@@ -27,7 +27,7 @@ from sailpoint.beta.models.account_status_changed_status_change import AccountSt
account_status_changed_status_change = AccountStatusChangedStatusChange(
previous_status='enabled',
new_status='enabled'
new_status='disabled'
)
```

6
docs/tools/sdk/python/Reference/Beta/Models/AttributeChange.md
View File

@@ -27,9 +27,9 @@ Name | Type | Description | Notes
from sailpoint.beta.models.attribute_change import AttributeChange
attribute_change = AttributeChange(
name='',
previous_value='',
new_value=''
name='firstname',
previous_value='adam',
new_value='zampa'
)
```

17
docs/tools/sdk/python/Reference/Beta/Models/AttributesChanged.md
View File

@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AttributesChanged', 'BetaAttributesCh
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**changes** | [**[]AttributeChange**](attribute-change) | | [optional]
**attribute_changes** | [**[]AttributeChange**](attribute-change) | | [required]
**event_type** | **str** | the event type | [optional]
**identity_id** | **str** | the identity id | [optional]
**dt** | **str** | the date of event | [optional]
**date_time** | **str** | the date of event | [optional]
}
## Example
@@ -28,12 +28,15 @@ Name | Type | Description | Notes
from sailpoint.beta.models.attributes_changed import AttributesChanged
attributes_changed = AttributesChanged(
changes=[
{name=firstname, previousValue=adam, newValue=zampa}
attribute_changes=[
sailpoint.beta.models.attribute_change.AttributeChange(
name = 'firstname',
previous_value = 'adam',
new_value = 'zampa', )
],
event_type='',
identity_id='',
dt=''
event_type='AttributesChanged',
identity_id='8a80828f643d484f01643e14202e206f',
date_time='2019-03-08T22:37:33.901Z'
)
```

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

@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'CorrelatedGovernanceEvent', 'BetaCorr
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | The name of the governance event, such as the certification name or access request ID. | [optional]
**dt** | **str** | The date that the certification or access request was completed. | [optional]
**date_time** | **str** | The date that the certification or access request was completed. | [optional]
**type** | **Enum** [ 'certification', 'accessRequest' ] | The type of governance event. | [optional]
**governance_id** | **str** | The ID of the instance that caused the event - either the certification ID or access request ID. | [optional]
**owners** | [**[]CertifierResponse**](certifier-response) | The owners of the governance event (the certifiers or approvers) | [optional]
@@ -32,7 +32,7 @@ from sailpoint.beta.models.correlated_governance_event import CorrelatedGovernan
correlated_governance_event = CorrelatedGovernanceEvent(
name='Manager Certification for Jon Snow',
dt='2019-03-08T22:37:33.901Z',
date_time='2019-03-08T22:37:33.901Z',
type='certification',
governance_id='2c91808a77ff216301782327a50f09bf',
owners=[{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],

85
docs/tools/sdk/python/Reference/Beta/Models/GetHistoricalIdentityEvents200ResponseInner.md
View File

@@ -16,21 +16,22 @@ tags: ['SDK', 'Software Development Kit', 'GetHistoricalIdentityEvents200Respons
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]
**changes** | [**[]AttributeChange**](attribute-change) | | [optional]
**access_request** | [**AccessRequestResponse1**](access-request-response1) | | [optional]
**certification_id** | **str** | the id of the certification item | [optional]
**certification_name** | **str** | the certification item name | [optional]
**certification_id** | **str** | the id of the certification item | [required]
**certification_name** | **str** | the certification item name | [required]
**signed_date** | **str** | the date ceritification was signed | [optional]
**certifiers** | [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional]
**reviewers** | [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional]
**signer** | [**CertifierResponse**](certifier-response) | | [optional]
**account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional]
**status_change** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional]
**event_type** | **str** | the event type | [optional]
**date_time** | **str** | the date of event | [optional]
**identity_id** | **str** | the identity id | [optional]
**access_item** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [required]
**governance_event** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [required]
**access_item_type** | **Enum** [ 'account', 'app', 'entitlement', 'role', 'accessProfile' ] | the access item type | [optional]
**attribute_changes** | [**[]AttributeChange**](attribute-change) | | [required]
**access_request** | [**AccessRequestResponse1**](access-request-response1) | | [required]
**account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [required]
**status_change** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [required]
}
## Example
@@ -39,27 +40,6 @@ Name | Type | Description | Notes
from sailpoint.beta.models.get_historical_identity_events200_response_inner import GetHistoricalIdentityEvents200ResponseInner
get_historical_identity_events200_response_inner = GetHistoricalIdentityEvents200ResponseInner(
access_item={id=8c190e6787aa4ed9a90bd9d5344523fb, accessType=account, nativeIdentity=127999, sourceName=JDBC Entitlements Source, entitlementCount=0, displayName=Sample Name},
identity_id='',
event_type='',
dt='',
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', ), ),
changes=[
{name=firstname, previousValue=adam, newValue=zampa}
],
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}]}], ),
certification_id='2c91808a77ff216301782327a50f09bf',
certification_name='Cert name',
signed_date='2019-03-08T22:37:33.901Z',
@@ -68,17 +48,42 @@ reviewers=[{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],
signer=sailpoint.beta.models.certifier_response.CertifierResponse(
id = '8a80828f643d484f01643e14202e206f',
display_name = 'John Snow', ),
event_type='AccountStatusChanged',
date_time='2019-03-08T22:37:33.901Z',
identity_id='8a80828f643d484f01643e14202e206f',
access_item={id=8c190e6787aa4ed9a90bd9d5344523fb, accessType=account, nativeIdentity=127999, sourceName=JDBC Entitlements Source, entitlementCount=0, displayName=Sample Name},
governance_event=sailpoint.beta.models.correlated_governance_event.CorrelatedGovernanceEvent(
name = 'Manager Certification for Jon Snow',
date_time = '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', ), ),
access_item_type='account',
attribute_changes=[
sailpoint.beta.models.attribute_change.AttributeChange(
name = 'firstname',
previous_value = 'adam',
new_value = 'zampa', )
],
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}]}], ),
account=sailpoint.beta.models.account_status_changed_account.AccountStatusChanged_account(
id = '',
native_identity = '',
display_name = '',
source_id = '',
source_name = '',
entitlement_count = 56,
access_type = '', ),
id = '2c91808a77ff216301782327a50f09bf',
native_identity = 'dr.arden.ogahn.d',
display_name = 'Adam Archer',
source_id = '8a80828f643d484f01643e14202e206f',
source_name = 'JDBC Entitlements Source',
entitlement_count = 2,
access_type = 'account', ),
status_change=sailpoint.beta.models.account_status_changed_status_change.AccountStatusChanged_statusChange(
previous_status = 'enabled',
new_status = 'enabled', )
new_status = 'disabled', )
)
```

8
docs/tools/sdk/python/Reference/Beta/Models/IdentityCertified.md
View File

@@ -16,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'IdentityCertified', 'BetaIdentityCert
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**certification_id** | **str** | the id of the certification item | [optional]
**certification_name** | **str** | the certification item name | [optional]
**certification_id** | **str** | the id of the certification item | [required]
**certification_name** | **str** | the certification item name | [required]
**signed_date** | **str** | the date ceritification was signed | [optional]
**certifiers** | [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional]
**reviewers** | [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional]
**signer** | [**CertifierResponse**](certifier-response) | | [optional]
**event_type** | **str** | the event type | [optional]
**dt** | **str** | the date of event | [optional]
**date_time** | **str** | the date of event | [optional]
}
## Example
@@ -41,7 +41,7 @@ signer=sailpoint.beta.models.certifier_response.CertifierResponse(
id = '8a80828f643d484f01643e14202e206f',
display_name = 'John Snow', ),
event_type='IdentityCertified',
dt='2019-03-08T22:37:33.901Z'
date_time='2019-03-08T22:37:33.901Z'
)
```

56
docs/tools/sdk/python/Reference/Beta/Models/ListIdentityAccessItems200ResponseInner.md
View File

@@ -16,25 +16,24 @@ tags: ['SDK', 'Software Development Kit', 'ListIdentityAccessItems200ResponseInn
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]
**access_type** | **str** | the access item type. entitlement in this case | [optional]
**display_name** | **str** | the access item display name | [optional]
**source_name** | **str** | the associated source name if it exists | [optional]
**source_id** | **str** | the id of the source | [optional]
**attribute** | **str** | the entitlement attribute | [required]
**value** | **str** | the associated value | [required]
**type** | **str** | the type of entitlement | [required]
**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]
**source_id** | **str** | the id of the source | [optional]
**standalone** | **bool** | indicates whether the access profile is standalone | [required]
**privileged** | **bool** | indicates whether the entitlement is privileged | [required]
**cloud_governed** | **bool** | indicates whether the entitlement is cloud governed | [required]
**entitlement_count** | **int** | the number of entitlements the account will create | [required]
**app_refs** | [**[]AccessItemAccessProfileResponseAppRefsInner**](access-item-access-profile-response-app-refs-inner) | the list of app ids associated with the access profile | [required]
**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]
**native_identity** | **str** | the native identifier used to uniquely identify an acccount | [required]
**app_role_id** | **str** | the app role id | [required]
}
## Example
@@ -43,25 +42,24 @@ Name | Type | Description | Notes
from sailpoint.beta.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner
list_identity_access_items200_response_inner = ListIdentityAccessItems200ResponseInner(
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',
access_type='app',
display_name='Display Name',
source_name='appName',
attribute='groups',
value='Upward mobility access',
entitlement_type='entitlement',
type='ENTITLEMENT',
description='Role - Workday/Citizenship access',
source_id='2793o32dwd',
standalone=False,
privileged=False,
cloud_governed=True
cloud_governed=True,
entitlement_count=12,
app_refs=[{cloudAppId=8c190e6787aa4ed9a90bd9d5344523fb, cloudAppName=Sample App}, {cloudAppId=2c91808a77ff216301782327a50f09bf, cloudAppName=Another App}],
remove_date='2024-07-01T06:00:00.00Z',
revocable=True,
native_identity='dr.arden.ogahn.d',
app_role_id='2c918087763e69d901763e72e97f006f'
)
```

67
docs/tools/sdk/python/Reference/Beta/Models/ListIdentitySnapshotAccessItems200ResponseInner.md Normal file
View File

@@ -0,0 +1,67 @@
---
id: beta-list-identity-snapshot-access-items200-response-inner
title: ListIdentitySnapshotAccessItems200ResponseInner
pagination_label: ListIdentitySnapshotAccessItems200ResponseInner
sidebar_label: ListIdentitySnapshotAccessItems200ResponseInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ListIdentitySnapshotAccessItems200ResponseInner', 'BetaListIdentitySnapshotAccessItems200ResponseInner']
slug: /tools/sdk/python/beta/models/list-identity-snapshot-access-items200-response-inner
tags: ['SDK', 'Software Development Kit', 'ListIdentitySnapshotAccessItems200ResponseInner', 'BetaListIdentitySnapshotAccessItems200ResponseInner']
---
# ListIdentitySnapshotAccessItems200ResponseInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | the access item id | [optional]
**access_type** | **str** | the access item type. role in this case | [optional]
**display_name** | **str** | the role display name | [optional]
**source_name** | **str** | the associated source name if it exists | [optional]
**entitlement_count** | **int** | the number of entitlements the account will create | [required]
**description** | **str** | the description for the role | [optional]
**source_id** | **str** | the id of the source | [optional]
**app_refs** | [**[]AccessItemAccessProfileResponseAppRefsInner**](access-item-access-profile-response-app-refs-inner) | the list of app ids associated with the access profile | [required]
**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 | [required]
**app_role_id** | **str** | the app role id | [required]
**attribute** | **str** | the entitlement attribute | [required]
**value** | **str** | the associated value | [required]
**type** | **str** | the type of entitlement | [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.list_identity_snapshot_access_items200_response_inner import ListIdentitySnapshotAccessItems200ResponseInner
list_identity_snapshot_access_items200_response_inner = ListIdentitySnapshotAccessItems200ResponseInner(
id='2c918087763e69d901763e72e97f006f',
access_type='role',
display_name='sample',
source_name='Source Name',
entitlement_count=12,
description='Role - Workday/Citizenship access',
source_id='2793o32dwd',
app_refs=[{cloudAppId=8c190e6787aa4ed9a90bd9d5344523fb, cloudAppName=Sample App}, {cloudAppId=2c91808a77ff216301782327a50f09bf, cloudAppName=Another App}],
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',
type='ENTITLEMENT',
privileged=False,
cloud_governed=True
)
```
[[Back to top]](#)