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

update layout for method examples

Browse Source
This commit is contained in:
darrell-thobe-sp
2025-02-25 11:46:14 -05:00
parent a4e2ab4717
commit aa76768244
208 changed files with 14924 additions and 9712 deletions
Download Patch File Download Diff File Expand all files Collapse all files

165
docs/tools/sdk/python/Reference/V2024/Methods/IdentityHistoryApi.md
View File

@@ -71,10 +71,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_compare_response import IdentityCompareResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
snapshot1 = '2007-03-01T13:00:00Z' # str | The snapshot 1 of identity (optional) # str | The snapshot 1 of identity (optional)
@@ -89,13 +93,12 @@ from pprint import pprint
try:
# Gets a difference of count for each access item types for the given identity between 2 snapshots
api_response = api_instance.compare_identity_snapshots(id, x_sail_point_experimental, )
results =IdentityHistoryApi(api_client).compare_identity_snapshots(id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.compare_identity_snapshots(id, x_sail_point_experimental, snapshot1, snapshot2, access_item_types, limit, offset, count)
# results = IdentityHistoryApi(api_client).compare_identity_snapshots(id, x_sail_point_experimental, snapshot1, snapshot2, access_item_types, limit, offset, count)
print("The response of IdentityHistoryApi->compare_identity_snapshots:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e)
```
@@ -147,10 +150,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_item_diff import AccessItemDiff
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
access_type = 'role' # str | The specific type which needs to be compared # str | The specific type which needs to be compared
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
@@ -164,13 +171,12 @@ from pprint import pprint
try:
# Gets a list of differences of specific accessType for the given identity between 2 snapshots
api_response = api_instance.compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, )
results =IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, access_associated, snapshot1, snapshot2, limit, offset, count)
# results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, access_associated, snapshot1, snapshot2, limit, offset, count)
print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e)
```
@@ -215,23 +221,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_history_response import IdentityHistoryResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
try:
# Get latest snapshot of identity
api_response = api_instance.get_historical_identity(id, x_sail_point_experimental)
results =IdentityHistoryApi(api_client).get_historical_identity(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_historical_identity(id, x_sail_point_experimental)
# results = IdentityHistoryApi(api_client).get_historical_identity(id, x_sail_point_experimental)
print("The response of IdentityHistoryApi->get_historical_identity:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityHistoryApi->get_historical_identity: %s\n" % e)
```
@@ -283,10 +292,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.get_historical_identity_events200_response_inner import GetHistoricalIdentityEvents200ResponseInner
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
var_from = '2024-03-01T13:00:00Z' # str | The optional instant until which access events are returned (optional) # str | The optional instant until which access events are returned (optional)
@@ -303,13 +316,12 @@ from pprint import pprint
try:
# Lists all events for the given identity
api_response = api_instance.get_historical_identity_events(id, x_sail_point_experimental, )
results =IdentityHistoryApi(api_client).get_historical_identity_events(id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_historical_identity_events(id, x_sail_point_experimental, var_from, event_types, access_item_types, limit, offset, count)
# results = IdentityHistoryApi(api_client).get_historical_identity_events(id, x_sail_point_experimental, var_from, event_types, access_item_types, limit, offset, count)
print("The response of IdentityHistoryApi->get_historical_identity_events:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e)
```
@@ -355,10 +367,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_history_response import IdentityHistoryResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
var_date = '2007-03-01T13:00:00Z' # str | The specified date # str | The specified date
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
@@ -366,13 +382,12 @@ from pprint import pprint
try:
# Gets an identity snapshot at a given date
api_response = api_instance.get_identity_snapshot(id, var_date, x_sail_point_experimental)
results =IdentityHistoryApi(api_client).get_identity_snapshot(id, var_date, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_snapshot(id, var_date, x_sail_point_experimental)
# results = IdentityHistoryApi(api_client).get_identity_snapshot(id, var_date, x_sail_point_experimental)
print("The response of IdentityHistoryApi->get_identity_snapshot:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityHistoryApi->get_identity_snapshot: %s\n" % e)
```
@@ -423,10 +438,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.metric_response import MetricResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
before = '2007-03-01T13:00:00Z' # str | The date before which snapshot summary is required (optional) # str | The date before which snapshot summary is required (optional)
@@ -439,13 +458,12 @@ from pprint import pprint
try:
# Gets the summary for the event count for a specific identity
api_response = api_instance.get_identity_snapshot_summary(id, x_sail_point_experimental, )
results =IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_snapshot_summary(id, x_sail_point_experimental, before, interval, time_zone, limit, offset, count)
# results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, x_sail_point_experimental, before, interval, time_zone, limit, offset, count)
print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e)
```
@@ -490,22 +508,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
try:
# Gets the start date of the identity
api_response = api_instance.get_identity_start_date(id, x_sail_point_experimental)
results =IdentityHistoryApi(api_client).get_identity_start_date(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_start_date(id, x_sail_point_experimental)
# results = IdentityHistoryApi(api_client).get_identity_start_date(id, x_sail_point_experimental)
print("The response of IdentityHistoryApi->get_identity_start_date:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityHistoryApi->get_identity_start_date: %s\n" % e)
```
@@ -554,10 +575,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_list_item import IdentityListItem
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
starts_with_query = 'Ada' # str | This param is used for starts-with search for first, last and display name of the identity (optional) # str | This param is used for starts-with search for first, last and display name of the identity (optional)
is_deleted = true # bool | Indicates if we want to only list down deleted identities or not. (optional) # bool | Indicates if we want to only list down deleted identities or not. (optional)
@@ -568,13 +593,12 @@ from pprint import pprint
try:
# Lists all the identities
api_response = api_instance.list_historical_identities(x_sail_point_experimental, )
results =IdentityHistoryApi(api_client).list_historical_identities(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_historical_identities(x_sail_point_experimental, starts_with_query, is_deleted, is_active, limit, offset)
# results = IdentityHistoryApi(api_client).list_historical_identities(x_sail_point_experimental, starts_with_query, is_deleted, is_active, limit, offset)
print("The response of IdentityHistoryApi->list_historical_identities:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e)
```
@@ -625,10 +649,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
type = 'account' # str | The type of access item for the identity. If not provided, it defaults to account (optional) # str | The type of access item for the identity. If not provided, it defaults to account (optional)
@@ -639,13 +667,12 @@ from pprint import pprint
try:
# List Access Items by Identity
api_response = api_instance.list_identity_access_items(id, x_sail_point_experimental, )
results =IdentityHistoryApi(api_client).list_identity_access_items(id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_identity_access_items(id, x_sail_point_experimental, type, limit, count, offset)
# results = IdentityHistoryApi(api_client).list_identity_access_items(id, x_sail_point_experimental, type, limit, count, offset)
print("The response of IdentityHistoryApi->list_identity_access_items:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e)
```
@@ -692,10 +719,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
var_date = '2007-03-01T13:00:00Z' # str | The specified date # str | The specified date
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
@@ -704,13 +735,12 @@ from pprint import pprint
try:
# Gets the list of identity access items at a given date filterd by item type
api_response = api_instance.list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, )
results =IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, type)
# results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, type)
print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e)
```
@@ -760,10 +790,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_snapshot_summary_response import IdentitySnapshotSummaryResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
start = '2007-03-01T13:00:00Z' # str | The specified start date (optional) # str | The specified start date (optional)
@@ -775,13 +809,12 @@ from pprint import pprint
try:
# Lists all the snapshots for the identity
api_response = api_instance.list_identity_snapshots(id, x_sail_point_experimental, )
results =IdentityHistoryApi(api_client).list_identity_snapshots(id, x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_identity_snapshots(id, x_sail_point_experimental, start, interval, limit, offset, count)
# results = IdentityHistoryApi(api_client).list_identity_snapshots(id, x_sail_point_experimental, start, interval, limit, offset, count)
print("The response of IdentityHistoryApi->list_identity_snapshots:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e)
```