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 python SDK docs: 16836068438

Browse Source
This commit is contained in:
developer-relations-sp
2025-08-08 17:01:56 +00:00
parent 79b99e77cd
commit 2062455043
13 changed files with 645 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
docs/tools/sdk/python/Reference/V2025/Models/HealthEvent.md Normal file
View File

@@ -0,0 +1,46 @@
---
id: v2025-health-event
title: HealthEvent
pagination_label: HealthEvent
sidebar_label: HealthEvent
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'HealthEvent', 'V2025HealthEvent']
slug: /tools/sdk/python/v2025/models/health-event
tags: ['SDK', 'Software Development Kit', 'HealthEvent', 'V2025HealthEvent']
---
# HealthEvent
Individual error or warning event
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**detailed_message** | **str** | Description of the issue | [optional]
**uuid** | **str** | Unique identifier for the health event | [optional]
**url** | **str** | Optional URL associated with the issue | [optional]
**timestamp** | **datetime** | Time when the event occurred | [optional]
**last_notified_time_stamp** | **datetime** | Last time notification was sent for this issue | [optional]
**cpu_utilization_percentage** | **float** | CPU usage percentage | [optional]
**free_space_percentage** | **float** | Free memory percentage | [optional]
}
## Example
```python
from sailpoint.v2025.models.health_event import HealthEvent
health_event = HealthEvent(
detailed_message='CPU utilization is high',
uuid='5',
url='https://sample.com:80/',
timestamp='2025-03-25T14:46:58.605Z',
last_notified_time_stamp='2025-08-06T06:53:22.206956Z',
cpu_utilization_percentage=80,
free_space_percentage=8
)
```
[[Back to top]](#)

54
docs/tools/sdk/python/Reference/V2025/Models/HealthIndicatorCategory.md Normal file
View File

@@ -0,0 +1,54 @@
---
id: v2025-health-indicator-category
title: HealthIndicatorCategory
pagination_label: HealthIndicatorCategory
sidebar_label: HealthIndicatorCategory
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'HealthIndicatorCategory', 'V2025HealthIndicatorCategory']
slug: /tools/sdk/python/v2025/models/health-indicator-category
tags: ['SDK', 'Software Development Kit', 'HealthIndicatorCategory', 'V2025HealthIndicatorCategory']
---
# HealthIndicatorCategory
Health indicator category data with errors and warnings
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**errors** | [**[]HealthEvent**](health-event) | List of error events for this category | [optional]
**warnings** | [**[]HealthEvent**](health-event) | List of warning events for this category | [optional]
}
## Example
```python
from sailpoint.v2025.models.health_indicator_category import HealthIndicatorCategory
health_indicator_category = HealthIndicatorCategory(
errors=[
sailpoint.v2025.models.health_event.HealthEvent(
detailed_message = 'CPU utilization is high',
uuid = '5',
url = 'https://sample.com:80/',
timestamp = '2025-03-25T14:46:58.605Z',
last_notified_time_stamp = '2025-08-06T06:53:22.206956Z',
cpu_utilization_percentage = 80,
free_space_percentage = 8, )
],
warnings=[
sailpoint.v2025.models.health_event.HealthEvent(
detailed_message = 'CPU utilization is high',
uuid = '5',
url = 'https://sample.com:80/',
timestamp = '2025-03-25T14:46:58.605Z',
last_notified_time_stamp = '2025-08-06T06:53:22.206956Z',
cpu_utilization_percentage = 80,
free_space_percentage = 8, )
]
)
```
[[Back to top]](#)

90
docs/tools/sdk/python/Reference/V2025/Models/ManagedClientHealthIndicators.md Normal file
View File

@@ -0,0 +1,90 @@
---
id: v2025-managed-client-health-indicators
title: ManagedClientHealthIndicators
pagination_label: ManagedClientHealthIndicators
sidebar_label: ManagedClientHealthIndicators
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ManagedClientHealthIndicators', 'V2025ManagedClientHealthIndicators']
slug: /tools/sdk/python/v2025/models/managed-client-health-indicators
tags: ['SDK', 'Software Development Kit', 'ManagedClientHealthIndicators', 'V2025ManagedClientHealthIndicators']
---
# ManagedClientHealthIndicators
Health Indicators for a Managed Client
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**body** | [**ManagedClientHealthIndicatorsBody**](managed-client-health-indicators-body) | | [required]
**status** | **Enum** [ 'NORMAL', 'UNDEFINED', 'WARNING', 'ERROR', 'FAILED' ] | Top-level status of the Managed Client | [required]
**type** | **Enum** [ 'VA', 'CCG' ] | Type of the Managed Client | [required]
**timestamp** | **datetime** | Timestamp when this report was generated | [required]
}
## Example
```python
from sailpoint.v2025.models.managed_client_health_indicators import ManagedClientHealthIndicators
managed_client_health_indicators = ManagedClientHealthIndicators(
body=sailpoint.v2025.models.managed_client_health_indicators_body.ManagedClientHealthIndicators_body(
alert_key = '',
id = '9fe8f1cc-2fd2-4675-a8cf-af4b43488ca2',
cluster_id = 'c2a2139cbc754e42b4279a69ec5f58ec',
api_user = '9fe8f1cc-2fd2-4675-a8cf-af4b43488ca2',
ccg_etag = 'c95e5c4417952dbcc9b4974999ece14e',
ccg_pin = 'NONE',
cookbook_etag = '3018-master-2ce6ac16-20250717124641-3077-master-a101b5fe-20250722162527',
hostname = 'Testing1',
internal_ip = '172.18.54.5',
last_seen = '1754465728720',
since_seen = '23195',
since_seen_millis = '23195',
local_dev = False,
stacktrace = '',
state = '',
status = 'NORMAL',
uuid = '',
product = 'idn',
va_version = '',
platform_version = '2',
os_version = '4230.2.1',
os_type = 'flatcar',
hypervisor = 'vmware',
consolidated_health_indicators_status = 'ERROR',
last_notified_ccg_version = '1068',
deployed_processes = '',
health_indicators = sailpoint.v2025.models.managed_client_health_indicators_body_health_indicators.ManagedClientHealthIndicators_body_health_indicators(
container = sailpoint.v2025.models.health_indicator_category.HealthIndicatorCategory(
errors = [
sailpoint.v2025.models.health_event.HealthEvent(
detailed_message = 'CPU utilization is high',
uuid = '5',
url = 'https://sample.com:80/',
timestamp = '2025-03-25T14:46:58.605Z',
last_notified_time_stamp = '2025-08-06T06:53:22.206956Z',
cpu_utilization_percentage = 80,
free_space_percentage = 8, )
],
warnings = [
sailpoint.v2025.models.health_event.HealthEvent(
detailed_message = 'CPU utilization is high',
uuid = '5',
url = 'https://sample.com:80/',
timestamp = '2025-03-25T14:46:58.605Z',
last_notified_time_stamp = '2025-08-06T06:53:22.206956Z',
cpu_utilization_percentage = 80,
free_space_percentage = 8, )
], ),
memory = sailpoint.v2025.models.health_indicator_category.HealthIndicatorCategory(),
cpu = , ), ),
status='NORMAL',
type='VA',
timestamp='2025-08-06T07:35:28.722300Z'
)
```
[[Back to top]](#)

109
docs/tools/sdk/python/Reference/V2025/Models/ManagedClientHealthIndicatorsBody.md Normal file
View File

@@ -0,0 +1,109 @@
---
id: v2025-managed-client-health-indicators-body
title: ManagedClientHealthIndicatorsBody
pagination_label: ManagedClientHealthIndicatorsBody
sidebar_label: ManagedClientHealthIndicatorsBody
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ManagedClientHealthIndicatorsBody', 'V2025ManagedClientHealthIndicatorsBody']
slug: /tools/sdk/python/v2025/models/managed-client-health-indicators-body
tags: ['SDK', 'Software Development Kit', 'ManagedClientHealthIndicatorsBody', 'V2025ManagedClientHealthIndicatorsBody']
---
# ManagedClientHealthIndicatorsBody
Health indicator details from the Managed Client
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**alert_key** | **str** | Health indicator alert key | [optional] [readonly]
**id** | **str** | Unique identifier for the health report | [required]
**cluster_id** | **str** | Cluster ID the health report belongs to | [required]
**api_user** | **str** | API user ID sending the health data | [required]
**ccg_etag** | **str** | ETag value for CCG version control | [optional]
**ccg_pin** | **str** | PIN value for CCG validation | [optional]
**cookbook_etag** | **str** | ETag for cookbook version | [optional]
**hostname** | **str** | Hostname of the Managed Client | [required]
**internal_ip** | **str** | Internal IP address of the Managed Client | [optional]
**last_seen** | **str** | Epoch timestamp (in millis) when last seen | [optional]
**since_seen** | **str** | Seconds since last seen | [optional]
**since_seen_millis** | **str** | Milliseconds since last seen | [optional]
**local_dev** | **bool** | Indicates if this is a local development instance | [optional] [default to False]
**stacktrace** | **str** | Stacktrace associated with any error, if available | [optional]
**state** | **str** | Optional state value from the client | [optional]
**status** | **Enum** [ 'NORMAL', 'UNDEFINED', 'WARNING', 'ERROR', 'FAILED' ] | Status of the client at the time of report | [required]
**uuid** | **str** | Optional UUID from the client | [optional]
**product** | **str** | Product type (e.g., idn) | [required]
**va_version** | **str** | VA version installed on the client | [optional]
**platform_version** | **str** | Version of the platform on which VA is running | [required]
**os_version** | **str** | Operating system version | [required]
**os_type** | **str** | Operating system type | [required]
**hypervisor** | **str** | Virtualization platform used | [required]
**consolidated_health_indicators_status** | **Enum** [ 'NORMAL', 'WARNING', 'ERROR' ] | Consolidated health indicator status | [required]
**last_notified_ccg_version** | **str** | The last CCG version for which notification was sent | [optional]
**deployed_processes** | **str** | Information about deployed processes | [optional]
**health_indicators** | [**ManagedClientHealthIndicatorsBodyHealthIndicators**](managed-client-health-indicators-body-health-indicators) | | [required]
}
## Example
```python
from sailpoint.v2025.models.managed_client_health_indicators_body import ManagedClientHealthIndicatorsBody
managed_client_health_indicators_body = ManagedClientHealthIndicatorsBody(
alert_key='',
id='9fe8f1cc-2fd2-4675-a8cf-af4b43488ca2',
cluster_id='c2a2139cbc754e42b4279a69ec5f58ec',
api_user='9fe8f1cc-2fd2-4675-a8cf-af4b43488ca2',
ccg_etag='c95e5c4417952dbcc9b4974999ece14e',
ccg_pin='NONE',
cookbook_etag='3018-master-2ce6ac16-20250717124641-3077-master-a101b5fe-20250722162527',
hostname='Testing1',
internal_ip='172.18.54.5',
last_seen='1754465728720',
since_seen='23195',
since_seen_millis='23195',
local_dev=False,
stacktrace='',
state='',
status='NORMAL',
uuid='',
product='idn',
va_version='',
platform_version='2',
os_version='4230.2.1',
os_type='flatcar',
hypervisor='vmware',
consolidated_health_indicators_status='ERROR',
last_notified_ccg_version='1068',
deployed_processes='',
health_indicators=sailpoint.v2025.models.managed_client_health_indicators_body_health_indicators.ManagedClientHealthIndicators_body_health_indicators(
container = sailpoint.v2025.models.health_indicator_category.HealthIndicatorCategory(
errors = [
sailpoint.v2025.models.health_event.HealthEvent(
detailed_message = 'CPU utilization is high',
uuid = '5',
url = 'https://sample.com:80/',
timestamp = '2025-03-25T14:46:58.605Z',
last_notified_time_stamp = '2025-08-06T06:53:22.206956Z',
cpu_utilization_percentage = 80,
free_space_percentage = 8, )
],
warnings = [
sailpoint.v2025.models.health_event.HealthEvent(
detailed_message = 'CPU utilization is high',
uuid = '5',
url = 'https://sample.com:80/',
timestamp = '2025-03-25T14:46:58.605Z',
last_notified_time_stamp = '2025-08-06T06:53:22.206956Z',
cpu_utilization_percentage = 80,
free_space_percentage = 8, )
], ),
memory = sailpoint.v2025.models.health_indicator_category.HealthIndicatorCategory(),
cpu = , )
)
```
[[Back to top]](#)

98
docs/tools/sdk/python/Reference/V2025/Models/ManagedClientHealthIndicatorsBodyHealthIndicators.md Normal file
View File

@@ -0,0 +1,98 @@
---
id: v2025-managed-client-health-indicators-body-health-indicators
title: ManagedClientHealthIndicatorsBodyHealthIndicators
pagination_label: ManagedClientHealthIndicatorsBodyHealthIndicators
sidebar_label: ManagedClientHealthIndicatorsBodyHealthIndicators
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ManagedClientHealthIndicatorsBodyHealthIndicators', 'V2025ManagedClientHealthIndicatorsBodyHealthIndicators']
slug: /tools/sdk/python/v2025/models/managed-client-health-indicators-body-health-indicators
tags: ['SDK', 'Software Development Kit', 'ManagedClientHealthIndicatorsBodyHealthIndicators', 'V2025ManagedClientHealthIndicatorsBodyHealthIndicators']
---
# ManagedClientHealthIndicatorsBodyHealthIndicators
Health indicators grouped by category
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**container** | [**HealthIndicatorCategory**](health-indicator-category) | | [optional]
**memory** | [**HealthIndicatorCategory**](health-indicator-category) | | [optional]
**cpu** | [**HealthIndicatorCategory**](health-indicator-category) | | [optional]
}
## Example
```python
from sailpoint.v2025.models.managed_client_health_indicators_body_health_indicators import ManagedClientHealthIndicatorsBodyHealthIndicators
managed_client_health_indicators_body_health_indicators = ManagedClientHealthIndicatorsBodyHealthIndicators(
container=sailpoint.v2025.models.health_indicator_category.HealthIndicatorCategory(
errors = [
sailpoint.v2025.models.health_event.HealthEvent(
detailed_message = 'CPU utilization is high',
uuid = '5',
url = 'https://sample.com:80/',
timestamp = '2025-03-25T14:46:58.605Z',
last_notified_time_stamp = '2025-08-06T06:53:22.206956Z',
cpu_utilization_percentage = 80,
free_space_percentage = 8, )
],
warnings = [
sailpoint.v2025.models.health_event.HealthEvent(
detailed_message = 'CPU utilization is high',
uuid = '5',
url = 'https://sample.com:80/',
timestamp = '2025-03-25T14:46:58.605Z',
last_notified_time_stamp = '2025-08-06T06:53:22.206956Z',
cpu_utilization_percentage = 80,
free_space_percentage = 8, )
], ),
memory=sailpoint.v2025.models.health_indicator_category.HealthIndicatorCategory(
errors = [
sailpoint.v2025.models.health_event.HealthEvent(
detailed_message = 'CPU utilization is high',
uuid = '5',
url = 'https://sample.com:80/',
timestamp = '2025-03-25T14:46:58.605Z',
last_notified_time_stamp = '2025-08-06T06:53:22.206956Z',
cpu_utilization_percentage = 80,
free_space_percentage = 8, )
],
warnings = [
sailpoint.v2025.models.health_event.HealthEvent(
detailed_message = 'CPU utilization is high',
uuid = '5',
url = 'https://sample.com:80/',
timestamp = '2025-03-25T14:46:58.605Z',
last_notified_time_stamp = '2025-08-06T06:53:22.206956Z',
cpu_utilization_percentage = 80,
free_space_percentage = 8, )
], ),
cpu=sailpoint.v2025.models.health_indicator_category.HealthIndicatorCategory(
errors = [
sailpoint.v2025.models.health_event.HealthEvent(
detailed_message = 'CPU utilization is high',
uuid = '5',
url = 'https://sample.com:80/',
timestamp = '2025-03-25T14:46:58.605Z',
last_notified_time_stamp = '2025-08-06T06:53:22.206956Z',
cpu_utilization_percentage = 80,
free_space_percentage = 8, )
],
warnings = [
sailpoint.v2025.models.health_event.HealthEvent(
detailed_message = 'CPU utilization is high',
uuid = '5',
url = 'https://sample.com:80/',
timestamp = '2025-03-25T14:46:58.605Z',
last_notified_time_stamp = '2025-08-06T06:53:22.206956Z',
cpu_utilization_percentage = 80,
free_space_percentage = 8, )
], )
)
```
[[Back to top]](#)

37
docs/tools/sdk/python/Reference/V2025/Models/WorkflowExecutionHistory.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: v2025-workflow-execution-history
title: WorkflowExecutionHistory
pagination_label: WorkflowExecutionHistory
sidebar_label: WorkflowExecutionHistory
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'WorkflowExecutionHistory', 'V2025WorkflowExecutionHistory']
slug: /tools/sdk/python/v2025/models/workflow-execution-history
tags: ['SDK', 'Software Development Kit', 'WorkflowExecutionHistory', 'V2025WorkflowExecutionHistory']
---
# WorkflowExecutionHistory
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**definition** | **object** | The workflow definition for the workflow execution | [optional]
**history** | **object** | List of workflow execution events for the given workflow execution | [optional]
**trigger** | **object** | The trigger that initiated the workflow execution | [optional]
}
## Example
```python
from sailpoint.v2025.models.workflow_execution_history import WorkflowExecutionHistory
workflow_execution_history = WorkflowExecutionHistory(
definition=None,
history=None,
trigger=None
)
```
[[Back to top]](#)

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

@@ -18,7 +18,7 @@ The trigger that starts the workflow
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'EVENT', 'EXTERNAL', 'SCHEDULED', '' ] | The trigger type | [required]
**display_name** | **str** | | [optional]
**display_name** | **str** | The trigger display name | [optional]
**attributes** | [**WorkflowTriggerAttributes**](workflow-trigger-attributes) | | [required]
}