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

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-13 19:55:38 +00:00
parent dec826c738
commit 4d26357dda
28 changed files with 1056 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/tools/sdk/python/Reference/V2024/Methods/CustomFormsApi.md
View File

@@ -957,7 +957,7 @@ Import form definitions from export.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
Body | body | [**[]ExportFormDefinitionsByTenant200ResponseInner**](../models/export-form-definitions-by-tenant200-response-inner) | (optional) | Body is the request payload to import form definitions
Body | body | [**[]ImportFormDefinitionsRequestInner**](../models/import-form-definitions-request-inner) | (optional) | Body is the request payload to import form definitions
### Return type
[**ImportFormDefinitions202Response**](../models/import-form-definitions202-response)
@@ -981,8 +981,8 @@ Code | Description | Data Type | Response headers |
```python
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.export_form_definitions_by_tenant200_response_inner import ExportFormDefinitionsByTenant200ResponseInner
from sailpoint.v2024.models.import_form_definitions202_response import ImportFormDefinitions202Response
from sailpoint.v2024.models.import_form_definitions_request_inner import ImportFormDefinitionsRequestInner
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -991,7 +991,7 @@ configuration.experimental = true
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')
body = '''[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]''' # List[ExportFormDefinitionsByTenant200ResponseInner] | Body is the request payload to import form definitions (optional)
body = '''[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]''' # List[ImportFormDefinitionsRequestInner] | Body is the request payload to import form definitions (optional)
try:
# Import form definitions from export.

62
docs/tools/sdk/python/Reference/V2024/Methods/ManagedClustersApi.md
View File

@@ -23,6 +23,7 @@ Method | HTTP request | Description
[**get-managed-cluster**](#get-managed-cluster) | **GET** `/managed-clusters/{id}` | Get Managed Cluster
[**get-managed-clusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Get Managed Clusters
[**put-client-log-configuration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update Managed Cluster Log Configuration
[**update**](#update) | **POST** `/managed-clusters/{id}/manualUpgrade` | Trigger Manual Upgrade for Managed Cluster
[**update-managed-cluster**](#update-managed-cluster) | **PATCH** `/managed-clusters/{id}` | Update Managed Cluster
@@ -400,6 +401,67 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update
Trigger Manual Upgrade for Managed Cluster
Trigger Manual Upgrade for Managed Cluster.
AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | ID of managed cluster to trigger manual upgrade.
### Return type
[**ClusterManualUpgrade**](../models/cluster-manual-upgrade)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Manual upgrade of managed cluster for given cluster ID. | ClusterManualUpgrade | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```python
from sailpoint.v2024.api.managed_clusters_api import ManagedClustersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.cluster_manual_upgrade import ClusterManualUpgrade
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to trigger manual upgrade. # str | ID of managed cluster to trigger manual upgrade.
try:
# Trigger Manual Upgrade for Managed Cluster
results = ManagedClustersApi(api_client).update(id=id)
# Below is a request that includes all optional parameters
# results = ManagedClustersApi(api_client).update(id)
print("The response of ManagedClustersApi->update:\n")
pprint(results)
except Exception as e:
print("Exception when calling ManagedClustersApi->update: %s\n" % e)
```
[[Back to top]](#)
## update-managed-cluster

61
docs/tools/sdk/python/Reference/V2024/Methods/SourcesApi.md
View File

@@ -90,6 +90,7 @@ Method | HTTP request | Description
[**get-source**](#get-source) | **GET** `/sources/{id}` | Get Source by ID
[**get-source-attr-sync-config**](#get-source-attr-sync-config) | **GET** `/sources/{id}/attribute-sync-config` | Attribute Sync Config
[**get-source-config**](#get-source-config) | **GET** `/sources/{id}/connectors/source-config` | Gets source config with language translations
[**get-source-connections**](#get-source-connections) | **GET** `/sources/{sourceId}/connections` | Get Source Connections by ID
[**get-source-entitlement-request-config**](#get-source-entitlement-request-config) | **GET** `/sources/{id}/entitlement-request-config` | Get Source Entitlement Request Configuration
[**get-source-health**](#get-source-health) | **GET** `/sources/{sourceId}/source-health` | Fetches source health by id
[**get-source-schedule**](#get-source-schedule) | **GET** `/sources/{sourceId}/schedules/{scheduleType}` | Get Source Schedule by Type
@@ -1405,6 +1406,66 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-source-connections
Get Source Connections by ID
Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC).
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-connections)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | source_id | **str** | True | Source ID.
### Return type
[**SourceConnectionsDto**](../models/source-connections-dto)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Source Connections object. | SourceConnectionsDto | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```python
from sailpoint.v2024.api.sources_api import SourcesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.source_connections_dto import SourceConnectionsDto
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID.
try:
# Get Source Connections by ID
results = SourcesApi(api_client).get_source_connections(source_id=source_id)
# Below is a request that includes all optional parameters
# results = SourcesApi(api_client).get_source_connections(source_id)
print("The response of SourcesApi->get_source_connections:\n")
pprint(results)
except Exception as e:
print("Exception when calling SourcesApi->get_source_connections: %s\n" % e)
```
[[Back to top]](#)
## get-source-entitlement-request-config

68
docs/tools/sdk/python/Reference/V2024/Models/ClusterManualUpgrade.md Normal file
View File

@@ -0,0 +1,68 @@
---
id: v2024-cluster-manual-upgrade
title: ClusterManualUpgrade
pagination_label: ClusterManualUpgrade
sidebar_label: ClusterManualUpgrade
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ClusterManualUpgrade', 'V2024ClusterManualUpgrade']
slug: /tools/sdk/python/v2024/models/cluster-manual-upgrade
tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgrade', 'V2024ClusterManualUpgrade']
---
# ClusterManualUpgrade
Manual Upgrade Job Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**jobs** | [**[]ClusterManualUpgradeJobsInner**](cluster-manual-upgrade-jobs-inner) | List of job objects for the upgrade request. | [optional]
}
## Example
```python
from sailpoint.v2024.models.cluster_manual_upgrade import ClusterManualUpgrade
cluster_manual_upgrade = ClusterManualUpgrade(
jobs=[
sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner.ClusterManualUpgrade_jobs_inner(
uuid = '4732440c-dacb-45b2-b2f8-ee2fa1327a07',
cookbook = '4732440c-dacb-45b2-b2f8-ee2fa1327a07',
state = 'PENDING',
type = 'VA_UPGRADE',
target_id = '9fe8f1cc-2fd2-4675-a8cf-af4b43488ca2',
managed_process_configuration = sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner_managed_process_configuration.ClusterManualUpgrade_jobs_inner_managedProcessConfiguration(
charon = sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner_managed_process_configuration_charon.ClusterManualUpgrade_jobs_inner_managedProcessConfiguration_charon(
version = '3047',
path = 'sailpoint/charon',
description = 'version of charon used by the va',
restart_needed = True, ),
ccg = sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner_managed_process_configuration_ccg.ClusterManualUpgrade_jobs_inner_managedProcessConfiguration_ccg(
version = '1798_1054_241.0.0',
path = 'sailpoint/ccg',
description = 'CCG Deployment through ops-cli',
restart_needed = True,
dependencies = {IQService=743/IQService-743.zip, connector-bundle-jdbc=432/connector-bundle-jdbc-432.zip, connector-bundle-misc=437/connector-bundle-misc-437.zip, connector-bundle-unix=242/connector-bundle-unix-242.zip, connector-common-config=208/connector-common-config-208.zip, connector-bundle-filebased=222/connector-bundle-filebased-222.zip, connector-bundle-imprivata=3/connector-bundle-imprivata-3.zip, connector-bundle-mainframe=211/connector-bundle-mainframe-211.zip, connector-bundle-directories=681/connector-bundle-directories-681.zip, connector-bundle-sap-on-prem=196/connector-bundle-sap-on-prem-196.zip, connector-bundle-webservices=1535/connector-bundle-webservices-1535.zip, connector-bundle-sap-cloud-app=175/connector-bundle-sap-cloud-app-175.zip, connector-bundle-healthcare-epic=302/connector-bundle-healthcare-epic-302.zip, connector-bundle-hrms-oraclefusionhcm=166/connector-bundle-hrms-oraclefusionhcm-166.zip, connector-bundle-collaboration-connectors=246/connector-bundle-collaboration-connectors-246.zip}, ),
otel_agent = sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner_managed_process_configuration_otel_agent.ClusterManualUpgrade_jobs_inner_managedProcessConfiguration_otel_agent(
version = '3003',
path = 'sailpoint/otel_agent',
description = 'version of otel_agent used by the va',
restart_needed = True, ),
relay = sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner_managed_process_configuration_relay.ClusterManualUpgrade_jobs_inner_managedProcessConfiguration_relay(
version = '3000',
path = 'sailpoint/relay',
description = 'version of relay used by the va',
restart_needed = True, ),
toolbox = sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner_managed_process_configuration_toolbox.ClusterManualUpgrade_jobs_inner_managedProcessConfiguration_toolbox(
version = '3004',
path = 'sailpoint/toolbox',
description = 'version of toolbox used by the va',
restart_needed = True, ), ), )
]
)
```
[[Back to top]](#)

69
docs/tools/sdk/python/Reference/V2024/Models/ClusterManualUpgradeJobsInner.md Normal file
View File

@@ -0,0 +1,69 @@
---
id: v2024-cluster-manual-upgrade-jobs-inner
title: ClusterManualUpgradeJobsInner
pagination_label: ClusterManualUpgradeJobsInner
sidebar_label: ClusterManualUpgradeJobsInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ClusterManualUpgradeJobsInner', 'V2024ClusterManualUpgradeJobsInner']
slug: /tools/sdk/python/v2024/models/cluster-manual-upgrade-jobs-inner
tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInner', 'V2024ClusterManualUpgradeJobsInner']
---
# ClusterManualUpgradeJobsInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**uuid** | **str** | Unique identifier for the upgrade job. | [required]
**cookbook** | **str** | Identifier for the cookbook used in the upgrade job. | [required]
**state** | **str** | Current state of the upgrade job. | [required]
**type** | **str** | The type of upgrade job (e.g., VA_UPGRADE). | [required]
**target_id** | **str** | Unique identifier of the target for the upgrade job. | [required]
**managed_process_configuration** | [**ClusterManualUpgradeJobsInnerManagedProcessConfiguration**](cluster-manual-upgrade-jobs-inner-managed-process-configuration) | | [required]
}
## Example
```python
from sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner import ClusterManualUpgradeJobsInner
cluster_manual_upgrade_jobs_inner = ClusterManualUpgradeJobsInner(
uuid='4732440c-dacb-45b2-b2f8-ee2fa1327a07',
cookbook='4732440c-dacb-45b2-b2f8-ee2fa1327a07',
state='PENDING',
type='VA_UPGRADE',
target_id='9fe8f1cc-2fd2-4675-a8cf-af4b43488ca2',
managed_process_configuration=sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner_managed_process_configuration.ClusterManualUpgrade_jobs_inner_managedProcessConfiguration(
charon = sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner_managed_process_configuration_charon.ClusterManualUpgrade_jobs_inner_managedProcessConfiguration_charon(
version = '3047',
path = 'sailpoint/charon',
description = 'version of charon used by the va',
restart_needed = True, ),
ccg = sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner_managed_process_configuration_ccg.ClusterManualUpgrade_jobs_inner_managedProcessConfiguration_ccg(
version = '1798_1054_241.0.0',
path = 'sailpoint/ccg',
description = 'CCG Deployment through ops-cli',
restart_needed = True,
dependencies = {IQService=743/IQService-743.zip, connector-bundle-jdbc=432/connector-bundle-jdbc-432.zip, connector-bundle-misc=437/connector-bundle-misc-437.zip, connector-bundle-unix=242/connector-bundle-unix-242.zip, connector-common-config=208/connector-common-config-208.zip, connector-bundle-filebased=222/connector-bundle-filebased-222.zip, connector-bundle-imprivata=3/connector-bundle-imprivata-3.zip, connector-bundle-mainframe=211/connector-bundle-mainframe-211.zip, connector-bundle-directories=681/connector-bundle-directories-681.zip, connector-bundle-sap-on-prem=196/connector-bundle-sap-on-prem-196.zip, connector-bundle-webservices=1535/connector-bundle-webservices-1535.zip, connector-bundle-sap-cloud-app=175/connector-bundle-sap-cloud-app-175.zip, connector-bundle-healthcare-epic=302/connector-bundle-healthcare-epic-302.zip, connector-bundle-hrms-oraclefusionhcm=166/connector-bundle-hrms-oraclefusionhcm-166.zip, connector-bundle-collaboration-connectors=246/connector-bundle-collaboration-connectors-246.zip}, ),
otel_agent = sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner_managed_process_configuration_otel_agent.ClusterManualUpgrade_jobs_inner_managedProcessConfiguration_otel_agent(
version = '3003',
path = 'sailpoint/otel_agent',
description = 'version of otel_agent used by the va',
restart_needed = True, ),
relay = sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner_managed_process_configuration_relay.ClusterManualUpgrade_jobs_inner_managedProcessConfiguration_relay(
version = '3000',
path = 'sailpoint/relay',
description = 'version of relay used by the va',
restart_needed = True, ),
toolbox = sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner_managed_process_configuration_toolbox.ClusterManualUpgrade_jobs_inner_managedProcessConfiguration_toolbox(
version = '3004',
path = 'sailpoint/toolbox',
description = 'version of toolbox used by the va',
restart_needed = True, ), )
)
```
[[Back to top]](#)

63
docs/tools/sdk/python/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfiguration.md Normal file
View File

@@ -0,0 +1,63 @@
---
id: v2024-cluster-manual-upgrade-jobs-inner-managed-process-configuration
title: ClusterManualUpgradeJobsInnerManagedProcessConfiguration
pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfiguration
sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfiguration
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfiguration', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfiguration']
slug: /tools/sdk/python/v2024/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration
tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfiguration', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfiguration']
---
# ClusterManualUpgradeJobsInnerManagedProcessConfiguration
Configuration of the managed processes involved in the upgrade.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**charon** | [**ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon**](cluster-manual-upgrade-jobs-inner-managed-process-configuration-charon) | | [optional]
**ccg** | [**ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg**](cluster-manual-upgrade-jobs-inner-managed-process-configuration-ccg) | | [optional]
**otel_agent** | [**ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent**](cluster-manual-upgrade-jobs-inner-managed-process-configuration-otel-agent) | | [optional]
**relay** | [**ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay**](cluster-manual-upgrade-jobs-inner-managed-process-configuration-relay) | | [optional]
**toolbox** | [**ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox**](cluster-manual-upgrade-jobs-inner-managed-process-configuration-toolbox) | | [optional]
}
## Example
```python
from sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner_managed_process_configuration import ClusterManualUpgradeJobsInnerManagedProcessConfiguration
cluster_manual_upgrade_jobs_inner_managed_process_configuration = ClusterManualUpgradeJobsInnerManagedProcessConfiguration(
charon=sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner_managed_process_configuration_charon.ClusterManualUpgrade_jobs_inner_managedProcessConfiguration_charon(
version = '3047',
path = 'sailpoint/charon',
description = 'version of charon used by the va',
restart_needed = True, ),
ccg=sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner_managed_process_configuration_ccg.ClusterManualUpgrade_jobs_inner_managedProcessConfiguration_ccg(
version = '1798_1054_241.0.0',
path = 'sailpoint/ccg',
description = 'CCG Deployment through ops-cli',
restart_needed = True,
dependencies = {IQService=743/IQService-743.zip, connector-bundle-jdbc=432/connector-bundle-jdbc-432.zip, connector-bundle-misc=437/connector-bundle-misc-437.zip, connector-bundle-unix=242/connector-bundle-unix-242.zip, connector-common-config=208/connector-common-config-208.zip, connector-bundle-filebased=222/connector-bundle-filebased-222.zip, connector-bundle-imprivata=3/connector-bundle-imprivata-3.zip, connector-bundle-mainframe=211/connector-bundle-mainframe-211.zip, connector-bundle-directories=681/connector-bundle-directories-681.zip, connector-bundle-sap-on-prem=196/connector-bundle-sap-on-prem-196.zip, connector-bundle-webservices=1535/connector-bundle-webservices-1535.zip, connector-bundle-sap-cloud-app=175/connector-bundle-sap-cloud-app-175.zip, connector-bundle-healthcare-epic=302/connector-bundle-healthcare-epic-302.zip, connector-bundle-hrms-oraclefusionhcm=166/connector-bundle-hrms-oraclefusionhcm-166.zip, connector-bundle-collaboration-connectors=246/connector-bundle-collaboration-connectors-246.zip}, ),
otel_agent=sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner_managed_process_configuration_otel_agent.ClusterManualUpgrade_jobs_inner_managedProcessConfiguration_otel_agent(
version = '3003',
path = 'sailpoint/otel_agent',
description = 'version of otel_agent used by the va',
restart_needed = True, ),
relay=sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner_managed_process_configuration_relay.ClusterManualUpgrade_jobs_inner_managedProcessConfiguration_relay(
version = '3000',
path = 'sailpoint/relay',
description = 'version of relay used by the va',
restart_needed = True, ),
toolbox=sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner_managed_process_configuration_toolbox.ClusterManualUpgrade_jobs_inner_managedProcessConfiguration_toolbox(
version = '3004',
path = 'sailpoint/toolbox',
description = 'version of toolbox used by the va',
restart_needed = True, )
)
```
[[Back to top]](#)

42
docs/tools/sdk/python/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg.md Normal file
View File

@@ -0,0 +1,42 @@
---
id: v2024-cluster-manual-upgrade-jobs-inner-managed-process-configuration-ccg
title: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg
pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg
sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg']
slug: /tools/sdk/python/v2024/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration-ccg
tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg']
---
# ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg
Configuration details for the 'ccg' process.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**version** | **str** | Version of the 'ccg' process. | [required]
**path** | **str** | Path to the 'ccg' process. | [required]
**description** | **str** | A brief description of the 'ccg' process. | [required]
**restart_needed** | **bool** | Indicates whether the process needs to be restarted. | [required]
**dependencies** | **map[string]str** | A map of dependencies for the 'ccg' process. | [required]
}
## Example
```python
from sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner_managed_process_configuration_ccg import ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg
cluster_manual_upgrade_jobs_inner_managed_process_configuration_ccg = ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg(
version='1798_1054_241.0.0',
path='sailpoint/ccg',
description='CCG Deployment through ops-cli',
restart_needed=True,
dependencies={IQService=743/IQService-743.zip, connector-bundle-jdbc=432/connector-bundle-jdbc-432.zip, connector-bundle-misc=437/connector-bundle-misc-437.zip, connector-bundle-unix=242/connector-bundle-unix-242.zip, connector-common-config=208/connector-common-config-208.zip, connector-bundle-filebased=222/connector-bundle-filebased-222.zip, connector-bundle-imprivata=3/connector-bundle-imprivata-3.zip, connector-bundle-mainframe=211/connector-bundle-mainframe-211.zip, connector-bundle-directories=681/connector-bundle-directories-681.zip, connector-bundle-sap-on-prem=196/connector-bundle-sap-on-prem-196.zip, connector-bundle-webservices=1535/connector-bundle-webservices-1535.zip, connector-bundle-sap-cloud-app=175/connector-bundle-sap-cloud-app-175.zip, connector-bundle-healthcare-epic=302/connector-bundle-healthcare-epic-302.zip, connector-bundle-hrms-oraclefusionhcm=166/connector-bundle-hrms-oraclefusionhcm-166.zip, connector-bundle-collaboration-connectors=246/connector-bundle-collaboration-connectors-246.zip}
)
```
[[Back to top]](#)

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

@@ -0,0 +1,40 @@
---
id: v2024-cluster-manual-upgrade-jobs-inner-managed-process-configuration-charon
title: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon
pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon
sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon']
slug: /tools/sdk/python/v2024/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration-charon
tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon']
---
# ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon
Configuration details for the 'charon' process.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**version** | **str** | Version of the 'charon' process. | [required]
**path** | **str** | Path to the 'charon' process. | [required]
**description** | **str** | A brief description of the 'charon' process. | [required]
**restart_needed** | **bool** | Indicates whether the process needs to be restarted. | [required]
}
## Example
```python
from sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner_managed_process_configuration_charon import ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon
cluster_manual_upgrade_jobs_inner_managed_process_configuration_charon = ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon(
version='3047',
path='sailpoint/charon',
description='version of charon used by the va',
restart_needed=True
)
```
[[Back to top]](#)

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

@@ -0,0 +1,40 @@
---
id: v2024-cluster-manual-upgrade-jobs-inner-managed-process-configuration-otel-agent
title: ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent
pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent
sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent']
slug: /tools/sdk/python/v2024/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration-otel-agent
tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent']
---
# ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent
Configuration details for the 'otel_agent' process.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**version** | **str** | Version of the 'otel_agent' process. | [required]
**path** | **str** | Path to the 'otel_agent' process. | [required]
**description** | **str** | A brief description of the 'otel_agent' process. | [required]
**restart_needed** | **bool** | Indicates whether the process needs to be restarted. | [required]
}
## Example
```python
from sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner_managed_process_configuration_otel_agent import ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent
cluster_manual_upgrade_jobs_inner_managed_process_configuration_otel_agent = ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent(
version='3003',
path='sailpoint/otel_agent',
description='version of otel_agent used by the va',
restart_needed=True
)
```
[[Back to top]](#)

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

@@ -0,0 +1,40 @@
---
id: v2024-cluster-manual-upgrade-jobs-inner-managed-process-configuration-relay
title: ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay
pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay
sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay']
slug: /tools/sdk/python/v2024/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration-relay
tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay']
---
# ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay
Configuration details for the 'relay' process.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**version** | **str** | Version of the 'relay' process. | [required]
**path** | **str** | Path to the 'relay' process. | [required]
**description** | **str** | A brief description of the 'relay' process. | [required]
**restart_needed** | **bool** | Indicates whether the process needs to be restarted. | [required]
}
## Example
```python
from sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner_managed_process_configuration_relay import ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay
cluster_manual_upgrade_jobs_inner_managed_process_configuration_relay = ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay(
version='3000',
path='sailpoint/relay',
description='version of relay used by the va',
restart_needed=True
)
```
[[Back to top]](#)

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

@@ -0,0 +1,40 @@
---
id: v2024-cluster-manual-upgrade-jobs-inner-managed-process-configuration-toolbox
title: ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox
pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox
sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox']
slug: /tools/sdk/python/v2024/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration-toolbox
tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox']
---
# ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox
Configuration details for the 'toolbox' process.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**version** | **str** | Version of the 'toolbox' process. | [required]
**path** | **str** | Path to the 'toolbox' process. | [required]
**description** | **str** | A brief description of the 'toolbox' process. | [required]
**restart_needed** | **bool** | Indicates whether the process needs to be restarted. | [required]
}
## Example
```python
from sailpoint.v2024.models.cluster_manual_upgrade_jobs_inner_managed_process_configuration_toolbox import ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox
cluster_manual_upgrade_jobs_inner_managed_process_configuration_toolbox = ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox(
version='3004',
path='sailpoint/toolbox',
description='version of toolbox used by the va',
restart_needed=True
)
```
[[Back to top]](#)

61
docs/tools/sdk/python/Reference/V2024/Models/DependantAppConnections.md Normal file
View File

@@ -0,0 +1,61 @@
---
id: v2024-dependant-app-connections
title: DependantAppConnections
pagination_label: DependantAppConnections
sidebar_label: DependantAppConnections
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'DependantAppConnections', 'V2024DependantAppConnections']
slug: /tools/sdk/python/v2024/models/dependant-app-connections
tags: ['SDK', 'Software Development Kit', 'DependantAppConnections', 'V2024DependantAppConnections']
---
# DependantAppConnections
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cloud_app_id** | **str** | Id of the connected Application | [optional]
**description** | **str** | Description of the connected Application | [optional]
**enabled** | **bool** | Is the Application enabled | [optional] [default to True]
**provision_request_enabled** | **bool** | Is Provisioning enabled for connected Application | [optional] [default to True]
**account_source** | [**DependantAppConnectionsAccountSource**](dependant-app-connections-account-source) | | [optional]
**launcher_count** | **int** | The amount of launchers for connected Application (long type) | [optional]
**match_all_account** | **bool** | Is Provisioning enabled for connected Application | [optional] [default to False]
**owner** | [**[]BaseReferenceDto**](base-reference-dto) | The owner of the connected Application | [optional]
**app_center_enabled** | **bool** | Is App Center enabled for connected Application | [optional] [default to False]
}
## Example
```python
from sailpoint.v2024.models.dependant_app_connections import DependantAppConnections
dependant_app_connections = DependantAppConnections(
cloud_app_id='9e3cdd80edf84f119327df8bbd5bb5ac',
description='This is a Sailpoint application',
enabled=True,
provision_request_enabled=True,
account_source=sailpoint.v2024.models.dependant_app_connections_account_source.DependantAppConnections_accountSource(
use_for_password_management = False,
password_policies = [
sailpoint.v2024.models.dependant_app_connections_account_source_password_policies_inner.DependantAppConnections_accountSource_passwordPolicies_inner(
type = 'PASSWORD_POLICY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'Policy ODS', )
], ),
launcher_count=100,
match_all_account=True,
owner=[
sailpoint.v2024.models.base_reference_dto.BaseReferenceDto(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', )
],
app_center_enabled=False
)
```
[[Back to top]](#)

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

@@ -0,0 +1,41 @@
---
id: v2024-dependant-app-connections-account-source
title: DependantAppConnectionsAccountSource
pagination_label: DependantAppConnectionsAccountSource
sidebar_label: DependantAppConnectionsAccountSource
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'DependantAppConnectionsAccountSource', 'V2024DependantAppConnectionsAccountSource']
slug: /tools/sdk/python/v2024/models/dependant-app-connections-account-source
tags: ['SDK', 'Software Development Kit', 'DependantAppConnectionsAccountSource', 'V2024DependantAppConnectionsAccountSource']
---
# DependantAppConnectionsAccountSource
The Account Source of the connected Application
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**use_for_password_management** | **bool** | Use this Account Source for password management | [optional] [default to False]
**password_policies** | [**[]DependantAppConnectionsAccountSourcePasswordPoliciesInner**](dependant-app-connections-account-source-password-policies-inner) | A list of Password Policies for this Account Source | [optional]
}
## Example
```python
from sailpoint.v2024.models.dependant_app_connections_account_source import DependantAppConnectionsAccountSource
dependant_app_connections_account_source = DependantAppConnectionsAccountSource(
use_for_password_management=False,
password_policies=[
sailpoint.v2024.models.dependant_app_connections_account_source_password_policies_inner.DependantAppConnections_accountSource_passwordPolicies_inner(
type = 'PASSWORD_POLICY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'Policy ODS', )
]
)
```
[[Back to top]](#)

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

@@ -0,0 +1,37 @@
---
id: v2024-dependant-app-connections-account-source-password-policies-inner
title: DependantAppConnectionsAccountSourcePasswordPoliciesInner
pagination_label: DependantAppConnectionsAccountSourcePasswordPoliciesInner
sidebar_label: DependantAppConnectionsAccountSourcePasswordPoliciesInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner', 'V2024DependantAppConnectionsAccountSourcePasswordPoliciesInner']
slug: /tools/sdk/python/v2024/models/dependant-app-connections-account-source-password-policies-inner
tags: ['SDK', 'Software Development Kit', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner', 'V2024DependantAppConnectionsAccountSourcePasswordPoliciesInner']
---
# DependantAppConnectionsAccountSourcePasswordPoliciesInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | DTO type | [optional]
**id** | **str** | ID of the object to which this reference applies | [optional]
**name** | **str** | Human-readable display name of the object to which this reference applies | [optional]
}
## Example
```python
from sailpoint.v2024.models.dependant_app_connections_account_source_password_policies_inner import DependantAppConnectionsAccountSourcePasswordPoliciesInner
dependant_app_connections_account_source_password_policies_inner = DependantAppConnectionsAccountSourcePasswordPoliciesInner(
type='PASSWORD_POLICY',
id='2c91808568c529c60168cca6f90c1313',
name='Policy ODS'
)
```
[[Back to top]](#)

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

@@ -0,0 +1,35 @@
---
id: v2024-dependant-connections-missing-dto
title: DependantConnectionsMissingDto
pagination_label: DependantConnectionsMissingDto
sidebar_label: DependantConnectionsMissingDto
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'DependantConnectionsMissingDto', 'V2024DependantConnectionsMissingDto']
slug: /tools/sdk/python/v2024/models/dependant-connections-missing-dto
tags: ['SDK', 'Software Development Kit', 'DependantConnectionsMissingDto', 'V2024DependantConnectionsMissingDto']
---
# DependantConnectionsMissingDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**dependency_type** | **Enum** [ 'identityProfiles', 'credentialProfiles', 'mappingProfiles', 'sourceAttributes', 'dependantCustomTransforms', 'dependantApps' ] | The type of dependency type that is missing in the SourceConnections | [optional]
**reason** | **str** | The reason why this dependency is missing | [optional]
}
## Example
```python
from sailpoint.v2024.models.dependant_connections_missing_dto import DependantConnectionsMissingDto
dependant_connections_missing_dto = DependantConnectionsMissingDto(
dependency_type='dependantApps',
reason='If there was an error retrieving any dependencies, it would lbe listed here'
)
```
[[Back to top]](#)

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

@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'ExportFormDefinitionsByTenant200Respo
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**object** | [**FormDefinitionResponse**](form-definition-response) | | [optional]
**var_self** | **str** | | [optional]
**var_self** | [**ExportFormDefinitionsByTenant200ResponseInnerSelf**](export-form-definitions-by-tenant200-response-inner-self) | | [optional]
**version** | **int** | | [optional]
}
@@ -80,7 +80,11 @@ object=sailpoint.v2024.models.form_definition_response.FormDefinitionResponse(
],
created = '2023-07-12T20:14:57.744860Z',
modified = '2023-07-12T20:14:57.744860Z', ),
var_self='',
var_self=sailpoint.v2024.models.export_form_definitions_by_tenant_200_response_inner_self.exportFormDefinitionsByTenant_200_response_inner_self(
object = sailpoint.v2024.models.form_definition_self_import_export_dto.FormDefinitionSelfImportExportDto(
type = 'FORM_DEFINITION',
id = '2c9180835d191a86015d28455b4b232a',
name = 'Temporary User Level Permissions - Requester', ), ),
version=56
)

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

@@ -0,0 +1,36 @@
---
id: v2024-export-form-definitions-by-tenant200-response-inner-self
title: ExportFormDefinitionsByTenant200ResponseInnerSelf
pagination_label: ExportFormDefinitionsByTenant200ResponseInnerSelf
sidebar_label: ExportFormDefinitionsByTenant200ResponseInnerSelf
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ExportFormDefinitionsByTenant200ResponseInnerSelf', 'V2024ExportFormDefinitionsByTenant200ResponseInnerSelf']
slug: /tools/sdk/python/v2024/models/export-form-definitions-by-tenant200-response-inner-self
tags: ['SDK', 'Software Development Kit', 'ExportFormDefinitionsByTenant200ResponseInnerSelf', 'V2024ExportFormDefinitionsByTenant200ResponseInnerSelf']
---
# ExportFormDefinitionsByTenant200ResponseInnerSelf
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**object** | [**FormDefinitionSelfImportExportDto**](form-definition-self-import-export-dto) | | [optional]
}
## Example
```python
from sailpoint.v2024.models.export_form_definitions_by_tenant200_response_inner_self import ExportFormDefinitionsByTenant200ResponseInnerSelf
export_form_definitions_by_tenant200_response_inner_self = ExportFormDefinitionsByTenant200ResponseInnerSelf(
object=sailpoint.v2024.models.form_definition_self_import_export_dto.FormDefinitionSelfImportExportDto(
type = 'FORM_DEFINITION',
id = '2c9180835d191a86015d28455b4b232a',
name = 'Temporary User Level Permissions - Requester', )
)
```
[[Back to top]](#)

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

@@ -0,0 +1,38 @@
---
id: v2024-form-definition-self-import-export-dto
title: FormDefinitionSelfImportExportDto
pagination_label: FormDefinitionSelfImportExportDto
sidebar_label: FormDefinitionSelfImportExportDto
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'FormDefinitionSelfImportExportDto', 'V2024FormDefinitionSelfImportExportDto']
slug: /tools/sdk/python/v2024/models/form-definition-self-import-export-dto
tags: ['SDK', 'Software Development Kit', 'FormDefinitionSelfImportExportDto', 'V2024FormDefinitionSelfImportExportDto']
---
# FormDefinitionSelfImportExportDto
Self block for imported/exported object.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'FORM_DEFINITION' ] | Imported/exported object's DTO type. | [optional]
**id** | **str** | Imported/exported object's ID. | [optional]
**name** | **str** | Imported/exported object's display name. | [optional]
}
## Example
```python
from sailpoint.v2024.models.form_definition_self_import_export_dto import FormDefinitionSelfImportExportDto
form_definition_self_import_export_dto = FormDefinitionSelfImportExportDto(
type='FORM_DEFINITION',
id='2c9180835d191a86015d28455b4b232a',
name='Temporary User Level Permissions - Requester'
)
```
[[Back to top]](#)

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

@@ -0,0 +1,37 @@
---
id: v2024-identity-profiles-connections
title: IdentityProfilesConnections
pagination_label: IdentityProfilesConnections
sidebar_label: IdentityProfilesConnections
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'IdentityProfilesConnections', 'V2024IdentityProfilesConnections']
slug: /tools/sdk/python/v2024/models/identity-profiles-connections
tags: ['SDK', 'Software Development Kit', 'IdentityProfilesConnections', 'V2024IdentityProfilesConnections']
---
# IdentityProfilesConnections
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | ID of the IdentityProfile this reference applies | [optional]
**name** | **str** | Human-readable display name of the IdentityProfile to which this reference applies | [optional]
**identity_count** | **int** | The Number of Identities managed by this IdentityProfile | [optional]
}
## Example
```python
from sailpoint.v2024.models.identity_profiles_connections import IdentityProfilesConnections
identity_profiles_connections = IdentityProfilesConnections(
id='76cfddb62818416f816bc494410f46c4',
name='ODS-Identity-Profile',
identity_count=100
)
```
[[Back to top]](#)

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

@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitions202Response', 'V
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**errors** | [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional]
**imported_objects** | [**[]ExportFormDefinitionsByTenant200ResponseInner**](export-form-definitions-by-tenant200-response-inner) | | [optional]
**imported_objects** | [**[]ImportFormDefinitionsRequestInner**](import-form-definitions-request-inner) | | [optional]
**infos** | [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional]
**warnings** | [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional]
}
@@ -37,7 +37,7 @@ errors=[
text = '', )
],
imported_objects=[
sailpoint.v2024.models.export_form_definitions_by_tenant_200_response_inner.exportFormDefinitionsByTenant_200_response_inner(
sailpoint.v2024.models.import_form_definitions_request_inner.importFormDefinitions_request_inner(
object = sailpoint.v2024.models.form_definition_response.FormDefinitionResponse(
id = '00000000-0000-0000-0000-000000000000',
name = 'My form',

89
docs/tools/sdk/python/Reference/V2024/Models/ImportFormDefinitionsRequestInner.md Normal file
View File

@@ -0,0 +1,89 @@
---
id: v2024-import-form-definitions-request-inner
title: ImportFormDefinitionsRequestInner
pagination_label: ImportFormDefinitionsRequestInner
sidebar_label: ImportFormDefinitionsRequestInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ImportFormDefinitionsRequestInner', 'V2024ImportFormDefinitionsRequestInner']
slug: /tools/sdk/python/v2024/models/import-form-definitions-request-inner
tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitionsRequestInner', 'V2024ImportFormDefinitionsRequestInner']
---
# ImportFormDefinitionsRequestInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**object** | [**FormDefinitionResponse**](form-definition-response) | | [optional]
**var_self** | **str** | | [optional]
**version** | **int** | | [optional]
}
## Example
```python
from sailpoint.v2024.models.import_form_definitions_request_inner import ImportFormDefinitionsRequestInner
import_form_definitions_request_inner = ImportFormDefinitionsRequestInner(
object=sailpoint.v2024.models.form_definition_response.FormDefinitionResponse(
id = '00000000-0000-0000-0000-000000000000',
name = 'My form',
description = 'My form description',
owner = sailpoint.v2024.models.form_owner.FormOwner(
type = 'IDENTITY',
id = '2c9180867624cbd7017642d8c8c81f67',
name = 'Grant Smith', ),
used_by = [
sailpoint.v2024.models.form_used_by.FormUsedBy(
type = 'WORKFLOW',
id = '61940a92-5484-42bc-bc10-b9982b218cdf',
name = 'Access Request Form', )
],
form_input = [
sailpoint.v2024.models.form_definition_input.FormDefinitionInput(
id = '00000000-0000-0000-0000-000000000000',
type = 'STRING',
label = 'input1',
description = 'A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic', )
],
form_elements = [
sailpoint.v2024.models.form_element.FormElement(
id = '00000000-0000-0000-0000-000000000000',
element_type = 'TEXT',
config = {label=Department},
key = 'department',
validations = [
sailpoint.v2024.models.form_element_validations_set.FormElementValidationsSet(
validation_type = 'REQUIRED', )
], )
],
form_conditions = [
sailpoint.v2024.models.form_condition.FormCondition(
rule_operator = 'AND',
rules = [
sailpoint.v2024.models.condition_rule.ConditionRule(
source_type = 'ELEMENT',
source = 'department',
operator = 'EQ',
value_type = 'STRING',
value = 'Engineering', )
],
effects = [
sailpoint.v2024.models.condition_effect.ConditionEffect(
effect_type = 'HIDE',
config = sailpoint.v2024.models.condition_effect_config.ConditionEffect_config(
default_value_label = 'Access to Remove',
element = '8110662963316867', ), )
], )
],
created = '2023-07-12T20:14:57.744860Z',
modified = '2023-07-12T20:14:57.744860Z', ),
var_self='',
version=56
)
```
[[Back to top]](#)

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

@@ -32,7 +32,7 @@ Name | Type | Description | Notes
**pinned_config** | **bool** | boolean flag indiacting whether or not the cluster configuration is pinned | [optional] [default to False]
**log_configuration** | [**ClientLogConfiguration**](client-log-configuration) | | [optional]
**operational** | **bool** | Whether or not the cluster is operational or not | [optional] [default to False]
**status** | **str** | Cluster status | [optional]
**status** | **Enum** [ 'CONFIGURING', 'FAILED', 'NO_CLIENTS', 'NORMAL', 'WARNING' ] | Cluster status | [optional]
**public_key_certificate** | **str** | Public key certificate | [optional]
**public_key_thumbprint** | **str** | Public key thumbprint | [optional]
**public_key** | **str** | Public key | [optional]

81
docs/tools/sdk/python/Reference/V2024/Models/SourceConnectionsDto.md Normal file
View File

@@ -0,0 +1,81 @@
---
id: v2024-source-connections-dto
title: SourceConnectionsDto
pagination_label: SourceConnectionsDto
sidebar_label: SourceConnectionsDto
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'SourceConnectionsDto', 'V2024SourceConnectionsDto']
slug: /tools/sdk/python/v2024/models/source-connections-dto
tags: ['SDK', 'Software Development Kit', 'SourceConnectionsDto', 'V2024SourceConnectionsDto']
---
# SourceConnectionsDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identity_profiles** | [**[]IdentityProfilesConnections**](identity-profiles-connections) | The IdentityProfile attached to this source | [optional]
**credential_profiles** | **[]str** | Name of the CredentialProfile attached to this source | [optional]
**source_attributes** | **[]str** | The attributes attached to this source | [optional]
**mapping_profiles** | **[]str** | The profiles attached to this source | [optional]
**dependent_custom_transforms** | [**[]TransformRead**](transform-read) | A list of custom transforms associated with this source. A transform will be considered associated with a source if any attributes of the transform specify the source as the sourceName. | [optional]
**dependent_apps** | [**[]DependantAppConnections**](dependant-app-connections) | | [optional]
**missing_dependents** | [**[]DependantConnectionsMissingDto**](dependant-connections-missing-dto) | | [optional]
}
## Example
```python
from sailpoint.v2024.models.source_connections_dto import SourceConnectionsDto
source_connections_dto = SourceConnectionsDto(
identity_profiles=[
sailpoint.v2024.models.identity_profiles_connections.IdentityProfilesConnections(
id = '76cfddb62818416f816bc494410f46c4',
name = 'ODS-Identity-Profile',
identity_count = 100, )
],
credential_profiles=[
'[Profile ODS]'
],
source_attributes=[
'[sAMAccountName, mail, sn, givenName, displayName, employeeNumber, manager, telephoneNumber]'
],
mapping_profiles=[ODS-AD-Profile, ODS-Profile2],
dependent_custom_transforms=[{id=61190eae-290b-4335-aeb8-7335f1fd99cb, name=Split Transform, type=split, attributes={delimiter=-, index=1, input={attributes={sourceName=Example CSV Source, attributeName=last_name}, type=accountAttribute}}, internal=false}],
dependent_apps=[
sailpoint.v2024.models.dependant_app_connections.DependantAppConnections(
cloud_app_id = '9e3cdd80edf84f119327df8bbd5bb5ac',
description = 'This is a Sailpoint application',
enabled = True,
provision_request_enabled = True,
account_source = sailpoint.v2024.models.dependant_app_connections_account_source.DependantAppConnections_accountSource(
use_for_password_management = False,
password_policies = [
sailpoint.v2024.models.dependant_app_connections_account_source_password_policies_inner.DependantAppConnections_accountSource_passwordPolicies_inner(
type = 'PASSWORD_POLICY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'Policy ODS', )
], ),
launcher_count = 100,
match_all_account = True,
owner = [
sailpoint.v2024.models.base_reference_dto.BaseReferenceDto(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', )
],
app_center_enabled = False, )
],
missing_dependents=[
sailpoint.v2024.models.dependant_connections_missing_dto.DependantConnectionsMissingDto(
dependency_type = 'dependantApps',
reason = 'If there was an error retrieving any dependencies, it would lbe listed here', )
]
)
```
[[Back to top]](#)

8
docs/tools/sdk/python/Reference/V3/Methods/SourcesApi.md
View File

@@ -840,7 +840,7 @@ Use this API to get all dependent Profiles, Attributes, Applications and Custom
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Source ID.
Path | source_id | **str** | True | Source ID.
### Return type
[**SourceConnectionsDto**](../models/source-connections-dto)
@@ -872,14 +872,14 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID.
source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID.
try:
# Get Source Connections by ID
results = SourcesApi(api_client).get_source_connections(id=id)
results = SourcesApi(api_client).get_source_connections(source_id=source_id)
# Below is a request that includes all optional parameters
# results = SourcesApi(api_client).get_source_connections(id)
# results = SourcesApi(api_client).get_source_connections(source_id)
print("The response of SourcesApi->get_source_connections:\n")
pprint(results)
except Exception as e:

2
docs/tools/sdk/python/Reference/V3/Models/ManagedCluster.md
View File

@@ -32,7 +32,7 @@ Name | Type | Description | Notes
**pinned_config** | **bool** | boolean flag indiacting whether or not the cluster configuration is pinned | [optional] [default to False]
**log_configuration** | [**ClientLogConfiguration**](client-log-configuration) | | [optional]
**operational** | **bool** | Whether or not the cluster is operational or not | [optional] [default to False]
**status** | **str** | Cluster status | [optional]
**status** | **Enum** [ 'CONFIGURING', 'FAILED', 'NO_CLIENTS', 'NORMAL', 'WARNING' ] | Cluster status | [optional]
**public_key_certificate** | **str** | Public key certificate | [optional]
**public_key_thumbprint** | **str** | Public key thumbprint | [optional]
**public_key** | **str** | Public key | [optional]

9
docs/tools/sdk/python/Reference/V3/Models/SourceConnectionsDto.md
View File

@@ -20,7 +20,7 @@ Name | Type | Description | Notes
**credential_profiles** | **[]str** | Name of the CredentialProfile attached to this source | [optional]
**source_attributes** | **[]str** | The attributes attached to this source | [optional]
**mapping_profiles** | **[]str** | The profiles attached to this source | [optional]
**dependent_custom_transforms** | [**[]Transform**](transform) | | [optional]
**dependent_custom_transforms** | [**[]TransformRead**](transform-read) | A list of custom transforms associated with this source. A transform will be considered associated with a source if any attributes of the transform specify the source as the sourceName. | [optional]
**dependent_apps** | [**[]DependantAppConnections**](dependant-app-connections) | | [optional]
**missing_dependents** | [**[]DependantConnectionsMissingDto**](dependant-connections-missing-dto) | | [optional]
}
@@ -44,12 +44,7 @@ source_attributes=[
'[sAMAccountName, mail, sn, givenName, displayName, employeeNumber, manager, telephoneNumber]'
],
mapping_profiles=[ODS-AD-Profile, ODS-Profile2],
dependent_custom_transforms=[
sailpoint.v3.models.transform.Transform(
name = 'Timestamp To Date',
type = 'dateFormat',
attributes = sailpoint.v3.models.attributes.attributes(), )
],
dependent_custom_transforms=[{id=61190eae-290b-4335-aeb8-7335f1fd99cb, name=Split Transform, type=split, attributes={delimiter=-, index=1, input={attributes={sourceName=Example CSV Source, attributeName=last_name}, type=accountAttribute}}, internal=false}],
dependent_apps=[
sailpoint.v3.models.dependant_app_connections.DependantAppConnections(
cloud_app_id = '9e3cdd80edf84f119327df8bbd5bb5ac',