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

Update to python SDK docs: 14132739659

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-28 15:47:40 +00:00
parent 505a2245eb
commit 6fd7c779cc
31 changed files with 3471 additions and 354 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
docs/tools/sdk/python/Reference/V2024/Models/ConnectorCustomizerCreateRequest.md Normal file
View File

@@ -0,0 +1,33 @@
---
id: v2024-connector-customizer-create-request
title: ConnectorCustomizerCreateRequest
pagination_label: ConnectorCustomizerCreateRequest
sidebar_label: ConnectorCustomizerCreateRequest
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ConnectorCustomizerCreateRequest', 'V2024ConnectorCustomizerCreateRequest']
slug: /tools/sdk/python/v2024/models/connector-customizer-create-request
tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerCreateRequest', 'V2024ConnectorCustomizerCreateRequest']
---
# ConnectorCustomizerCreateRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Connector customizer name. | [optional]
}
## Example
```python
from sailpoint.v2024.models.connector_customizer_create_request import ConnectorCustomizerCreateRequest
connector_customizer_create_request = ConnectorCustomizerCreateRequest(
name='My Custom Connector'
)
```
[[Back to top]](#)

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

@@ -0,0 +1,40 @@
---
id: v2024-connector-customizer-create-response
title: ConnectorCustomizerCreateResponse
pagination_label: ConnectorCustomizerCreateResponse
sidebar_label: ConnectorCustomizerCreateResponse
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ConnectorCustomizerCreateResponse', 'V2024ConnectorCustomizerCreateResponse']
slug: /tools/sdk/python/v2024/models/connector-customizer-create-response
tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerCreateResponse', 'V2024ConnectorCustomizerCreateResponse']
---
# ConnectorCustomizerCreateResponse
ConnectorCustomizerResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | the ID of connector customizer. | [optional]
**name** | **str** | name of the connector customizer. | [optional]
**tenant_id** | **str** | Connector customizer tenant id. | [optional]
**created** | **datetime** | Date-time when the connector customizer was created. | [optional]
}
## Example
```python
from sailpoint.v2024.models.connector_customizer_create_response import ConnectorCustomizerCreateResponse
connector_customizer_create_response = ConnectorCustomizerCreateResponse(
id='b07dc46a-1498-4de8-bfbb-259a68e70c8a',
name='connector-customizer-name',
tenant_id='2c91808568c529c60168cca6f90c1324',
created=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f')
)
```
[[Back to top]](#)

34
docs/tools/sdk/python/Reference/V2024/Models/ConnectorCustomizerUpdateRequest.md Normal file
View File

@@ -0,0 +1,34 @@
---
id: v2024-connector-customizer-update-request
title: ConnectorCustomizerUpdateRequest
pagination_label: ConnectorCustomizerUpdateRequest
sidebar_label: ConnectorCustomizerUpdateRequest
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ConnectorCustomizerUpdateRequest', 'V2024ConnectorCustomizerUpdateRequest']
slug: /tools/sdk/python/v2024/models/connector-customizer-update-request
tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerUpdateRequest', 'V2024ConnectorCustomizerUpdateRequest']
---
# ConnectorCustomizerUpdateRequest
ConnectorCustomizerUpdateRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Connector customizer name. | [optional]
}
## Example
```python
from sailpoint.v2024.models.connector_customizer_update_request import ConnectorCustomizerUpdateRequest
connector_customizer_update_request = ConnectorCustomizerUpdateRequest(
name='My Custom Connector'
)
```
[[Back to top]](#)

44
docs/tools/sdk/python/Reference/V2024/Models/ConnectorCustomizerUpdateResponse.md Normal file
View File

@@ -0,0 +1,44 @@
---
id: v2024-connector-customizer-update-response
title: ConnectorCustomizerUpdateResponse
pagination_label: ConnectorCustomizerUpdateResponse
sidebar_label: ConnectorCustomizerUpdateResponse
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ConnectorCustomizerUpdateResponse', 'V2024ConnectorCustomizerUpdateResponse']
slug: /tools/sdk/python/v2024/models/connector-customizer-update-response
tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerUpdateResponse', 'V2024ConnectorCustomizerUpdateResponse']
---
# ConnectorCustomizerUpdateResponse
ConnectorCustomizerUpdateResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | the ID of connector customizer. | [optional]
**name** | **str** | name of the connector customizer. | [optional]
**tenant_id** | **str** | Connector customizer tenant id. | [optional]
**created** | **datetime** | Date-time when the connector customizer was created. | [optional]
**image_version** | **int** | Connector customizer image version. | [optional]
**image_id** | **str** | Connector customizer image id. | [optional]
}
## Example
```python
from sailpoint.v2024.models.connector_customizer_update_response import ConnectorCustomizerUpdateResponse
connector_customizer_update_response = ConnectorCustomizerUpdateResponse(
id='b07dc46a-1498-4de8-bfbb-259a68e70c8a',
name='connector-customizer-name',
tenant_id='2c91808568c529c60168cca6f90c1324',
created=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'),
image_version=1,
image_id='2c91808568c529c60168cca6f90c1324'
)
```
[[Back to top]](#)

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

@@ -0,0 +1,40 @@
---
id: v2024-connector-customizer-version-create-response
title: ConnectorCustomizerVersionCreateResponse
pagination_label: ConnectorCustomizerVersionCreateResponse
sidebar_label: ConnectorCustomizerVersionCreateResponse
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ConnectorCustomizerVersionCreateResponse', 'V2024ConnectorCustomizerVersionCreateResponse']
slug: /tools/sdk/python/v2024/models/connector-customizer-version-create-response
tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerVersionCreateResponse', 'V2024ConnectorCustomizerVersionCreateResponse']
---
# ConnectorCustomizerVersionCreateResponse
ConnectorCustomizerVersionCreateResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**customizer_id** | **str** | ID of connector customizer. | [optional]
**image_id** | **str** | ImageID of the connector customizer. | [optional]
**version** | **int** | Image version of the connector customizer. | [optional]
**created** | **datetime** | Date-time when the connector customizer version was created. | [optional]
}
## Example
```python
from sailpoint.v2024.models.connector_customizer_version_create_response import ConnectorCustomizerVersionCreateResponse
connector_customizer_version_create_response = ConnectorCustomizerVersionCreateResponse(
customizer_id='b07dc46a-1498-4de8-bfbb-259a68e70c8a',
image_id='2c91808568c529c60168cca6f90c1324',
version=1,
created='2022-02-08T14:50:03.827Z'
)
```
[[Back to top]](#)

43
docs/tools/sdk/python/Reference/V2024/Models/ConnectorCustomizersResponse.md Normal file
View File

@@ -0,0 +1,43 @@
---
id: v2024-connector-customizers-response
title: ConnectorCustomizersResponse
pagination_label: ConnectorCustomizersResponse
sidebar_label: ConnectorCustomizersResponse
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ConnectorCustomizersResponse', 'V2024ConnectorCustomizersResponse']
slug: /tools/sdk/python/v2024/models/connector-customizers-response
tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizersResponse', 'V2024ConnectorCustomizersResponse']
---
# ConnectorCustomizersResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Connector customizer ID. | [optional] [readonly]
**name** | **str** | Connector customizer name. | [optional]
**image_version** | **int** | Connector customizer image version. | [optional]
**image_id** | **str** | Connector customizer image id. | [optional]
**tenant_id** | **str** | Connector customizer tenant id. | [optional]
**created** | **datetime** | Date-time when the connector customizer was created | [optional]
}
## Example
```python
from sailpoint.v2024.models.connector_customizers_response import ConnectorCustomizersResponse
connector_customizers_response = ConnectorCustomizersResponse(
id='b07dc46a-1498-4de8-bfbb-259a68e70c8a',
name='connector-customizer-name',
image_version=1,
image_id='2c91808568c529c60168cca6f90c1324',
tenant_id='2c91808568c529c60168cca6f90c1324',
created=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f')
)
```
[[Back to top]](#)

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

@@ -19,7 +19,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**op** | **Enum** [ 'add', 'remove', 'replace', 'move', 'copy', 'test' ] | The operation to be performed | [required]
**path** | **str** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required]
**value** | [**JsonPatchOperationValue**](json-patch-operation-value) | | [optional]
**value** | [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional]
}
## Example

32
docs/tools/sdk/python/Reference/V2024/Models/JsonPatchOperationValue.md
View File

@@ -1,32 +0,0 @@
---
id: v2024-json-patch-operation-value
title: JsonPatchOperationValue
pagination_label: JsonPatchOperationValue
sidebar_label: JsonPatchOperationValue
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'JsonPatchOperationValue', 'V2024JsonPatchOperationValue']
slug: /tools/sdk/python/v2024/models/json-patch-operation-value
tags: ['SDK', 'Software Development Kit', 'JsonPatchOperationValue', 'V2024JsonPatchOperationValue']
---
# JsonPatchOperationValue
The value to be used for the operation, required for \"add\" and \"replace\" operations
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
}
## Example
```python
from sailpoint.v2024.models.json_patch_operation_value import JsonPatchOperationValue
json_patch_operation_value = JsonPatchOperationValue(
)
```
[[Back to top]](#)

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

@@ -0,0 +1,42 @@
---
id: v2024-managed-cluster-type
title: ManagedClusterType
pagination_label: ManagedClusterType
sidebar_label: ManagedClusterType
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ManagedClusterType', 'V2024ManagedClusterType']
slug: /tools/sdk/python/v2024/models/managed-cluster-type
tags: ['SDK', 'Software Development Kit', 'ManagedClusterType', 'V2024ManagedClusterType']
---
# ManagedClusterType
Managed Cluster Type for Cluster upgrade configuration information
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | ManagedClusterType ID | [optional] [readonly]
**type** | **str** | ManagedClusterType type name | [required]
**pod** | **str** | ManagedClusterType pod | [required]
**org** | **str** | ManagedClusterType org | [required]
**managed_process_ids** | **[]str** | List of processes for the cluster type | [optional]
}
## Example
```python
from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType
managed_cluster_type = ManagedClusterType(
id='aClusterTypeId',
type='idn',
pod='megapod-useast1',
org='denali-cjh',
managed_process_ids=[someId, someId2]
)
```
[[Back to top]](#)

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

@@ -0,0 +1,38 @@
---
id: v2024-multi-host-integration-template-type
title: MultiHostIntegrationTemplateType
pagination_label: MultiHostIntegrationTemplateType
sidebar_label: MultiHostIntegrationTemplateType
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationTemplateType', 'V2024MultiHostIntegrationTemplateType']
slug: /tools/sdk/python/v2024/models/multi-host-integration-template-type
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationTemplateType', 'V2024MultiHostIntegrationTemplateType']
---
# MultiHostIntegrationTemplateType
This represents a Multi-Host Integration template type.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | This is the name of the type. | [optional]
**type** | **str** | This is the type value for the type. | [required]
**script_name** | **str** | This is the scriptName attribute value for the type. | [required]
}
## Example
```python
from sailpoint.v2024.models.multi_host_integration_template_type import MultiHostIntegrationTemplateType
multi_host_integration_template_type = MultiHostIntegrationTemplateType(
name='aName',
type='aType',
script_name='aScriptName'
)
```
[[Back to top]](#)

121
docs/tools/sdk/python/Reference/V2024/Models/MultiHostIntegrations.md Normal file
View File

@@ -0,0 +1,121 @@
---
id: v2024-multi-host-integrations
title: MultiHostIntegrations
pagination_label: MultiHostIntegrations
sidebar_label: MultiHostIntegrations
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrations', 'V2024MultiHostIntegrations']
slug: /tools/sdk/python/v2024/models/multi-host-integrations
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrations', 'V2024MultiHostIntegrations']
---
# MultiHostIntegrations
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Multi-Host Integration ID. | [required][readonly]
**name** | **str** | Multi-Host Integration's human-readable name. | [required]
**description** | **str** | Multi-Host Integration's human-readable description. | [required]
**owner** | [**SourceOwner**](source-owner) | | [required]
**cluster** | [**SourceCluster**](source-cluster) | | [optional]
**account_correlation_config** | [**SourceAccountCorrelationConfig**](source-account-correlation-config) | | [optional]
**account_correlation_rule** | [**SourceAccountCorrelationRule**](source-account-correlation-rule) | | [optional]
**manager_correlation_mapping** | [**SourceManagerCorrelationMapping**](source-manager-correlation-mapping) | | [optional]
**manager_correlation_rule** | [**SourceManagerCorrelationRule**](source-manager-correlation-rule) | | [optional]
**before_provisioning_rule** | [**MultiHostIntegrationsBeforeProvisioningRule**](multi-host-integrations-before-provisioning-rule) | | [optional]
**schemas** | [**[]SourceSchemasInner**](source-schemas-inner) | List of references to schema objects. | [optional]
**password_policies** | [**[]SourcePasswordPoliciesInner**](source-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional]
**features** | **[]str** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional]
**type** | **str** | Specifies the type of system being managed e.g. Workday, Multi-Host - Microsoft SQL Server, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional]
**connector** | **str** | Connector script name. | [required]
**connector_class** | **str** | Fully qualified name of the Java class that implements the connector interface. | [optional]
**connector_attributes** | [**MultiHostIntegrationsConnectorAttributes**](multi-host-integrations-connector-attributes) | | [optional]
**delete_threshold** | **int** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional]
**authoritative** | **bool** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to False]
**management_workgroup** | [**SourceManagementWorkgroup**](source-management-workgroup) | | [optional]
**healthy** | **bool** | When this is true, it indicates that the source is healthy. | [optional] [default to False]
**status** | **Enum** [ 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', 'SOURCE_STATE_ERROR_CLUSTER', 'SOURCE_STATE_ERROR_SOURCE', 'SOURCE_STATE_ERROR_VA', 'SOURCE_STATE_FAILURE_CLUSTER', 'SOURCE_STATE_FAILURE_SOURCE', 'SOURCE_STATE_HEALTHY', 'SOURCE_STATE_UNCHECKED_CLUSTER', 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', 'SOURCE_STATE_UNCHECKED_SOURCE', 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' ] | Status identifier that gives specific information about why a source is or isn't healthy. | [optional]
**since** | **datetime** | Timestamp that shows when a source health check was last performed. | [optional]
**connector_id** | **str** | Connector ID | [optional]
**connector_name** | **str** | Name of the connector that was chosen during source creation. | [optional]
**connection_type** | **Enum** [ 'direct', 'file' ] | Type of connection (direct or file). | [optional]
**connector_implementation_id** | **str** | Connector implementation ID. | [optional]
**created** | **datetime** | Date-time when the source was created | [optional]
**modified** | **datetime** | Date-time when the source was last modified. | [optional]
**credential_provider_enabled** | **bool** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to False]
**category** | **str** | Source category (e.g. null, CredentialProvider). | [optional]
**accounts_file** | [**MultiHostIntegrationsAccountsFile**](multi-host-integrations-accounts-file) | | [optional]
}
## Example
```python
from sailpoint.v2024.models.multi_host_integrations import MultiHostIntegrations
multi_host_integrations = MultiHostIntegrations(
id='2c91808568c529c60168cca6f90c1324',
name='My Multi-Host Integration',
description='This is a Multi-Host Integration.',
owner=sailpoint.v2024.models.source_owner.Source_owner(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'MyName', ),
cluster=sailpoint.v2024.models.source_cluster.Source_cluster(
type = 'CLUSTER',
id = '2c9180866166b5b0016167c32ef31a66',
name = 'Corporate Cluster', ),
account_correlation_config=sailpoint.v2024.models.source_account_correlation_config.Source_accountCorrelationConfig(
type = 'ACCOUNT_CORRELATION_CONFIG',
id = '2c9180855d191c59015d28583727245a',
name = 'Directory [source-62867] Account Correlation', ),
account_correlation_rule=sailpoint.v2024.models.source_account_correlation_rule.Source_accountCorrelationRule(
type = 'RULE',
id = '2c918085708c274401708c2a8a760001',
name = 'Example Rule', ),
manager_correlation_mapping=,
manager_correlation_rule=sailpoint.v2024.models.source_manager_correlation_rule.Source_managerCorrelationRule(
type = 'RULE',
id = '2c918085708c274401708c2a8a760001',
name = 'Example Rule', ),
before_provisioning_rule=sailpoint.v2024.models.multi_host_integrations_before_provisioning_rule.MultiHostIntegrations_beforeProvisioningRule(
type = 'RULE',
id = '2c918085708c274401708c2a8a760001',
name = 'Example Rule', ),
schemas=[{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}],
password_policies=[{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}],
features=[PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS],
type='Multi-Host - Microsoft SQL Server',
connector='multihost-microsoft-sql-server',
connector_class='sailpoint.connector.OpenConnectorAdapter',
connector_attributes={multiHostAttributes={password=Password, user=Username, connector_files=mssql-jdbc-8.4.1.jre8.jar, authType=SQLAuthentication}, connectorFileUploadHistory={connectorFileNameUploadedDate=2024-08-29T10:20:38.896479Z}, maxAllowedSources=30, lastSourceUploadCount=50, showEntitlementSchema=true, showAccountSchema=true, multihost_status=ready},
delete_threshold=10,
authoritative=False,
management_workgroup=sailpoint.v2024.models.source_management_workgroup.Source_managementWorkgroup(
type = 'GOVERNANCE_GROUP',
id = '2c91808568c529c60168cca6f90c2222',
name = 'My Management Workgroup', ),
healthy=True,
status='SOURCE_STATE_HEALTHY',
since=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'),
connector_id='multihost-microsoft-sql-server',
connector_name='Multi-Host Microsoft SQL Server',
connection_type='direct',
connector_implementation_id='multihost-microsoft-sql-server',
created='2022-02-08T14:50:03.827Z',
modified='2024-01-23T18:08:50.897Z',
credential_provider_enabled=False,
category='CredentialProvider',
accounts_file=sailpoint.v2024.models.multi_host_integrations_accounts_file.MultiHostIntegrations_accountsFile(
name = 'My Accounts File',
key = '2c91808568c529c60168cca6f90c2222',
upload_time = '2022-02-08T14:50:03.827Z',
expiry = '2022-02-08T14:50:03.827Z',
expired = False, )
)
```
[[Back to top]](#)

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

@@ -0,0 +1,42 @@
---
id: v2024-multi-host-integrations-accounts-file
title: MultiHostIntegrationsAccountsFile
pagination_label: MultiHostIntegrationsAccountsFile
sidebar_label: MultiHostIntegrationsAccountsFile
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsAccountsFile', 'V2024MultiHostIntegrationsAccountsFile']
slug: /tools/sdk/python/v2024/models/multi-host-integrations-accounts-file
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsAccountsFile', 'V2024MultiHostIntegrationsAccountsFile']
---
# MultiHostIntegrationsAccountsFile
Reference to accounts file for the source.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Name of the accounts file. | [optional]
**key** | **str** | The accounts file key. | [optional]
**upload_time** | **datetime** | Date-time when the file was uploaded | [optional]
**expiry** | **datetime** | Date-time when the accounts file expired. | [optional]
**expired** | **bool** | If this is true, it indicates that the accounts file has expired. | [optional] [default to False]
}
## Example
```python
from sailpoint.v2024.models.multi_host_integrations_accounts_file import MultiHostIntegrationsAccountsFile
multi_host_integrations_accounts_file = MultiHostIntegrationsAccountsFile(
name='My Accounts File',
key='2c91808568c529c60168cca6f90c2222',
upload_time='2022-02-08T14:50:03.827Z',
expiry='2022-02-08T14:50:03.827Z',
expired=False
)
```
[[Back to top]](#)

47
docs/tools/sdk/python/Reference/V2024/Models/MultiHostIntegrationsAggScheduleUpdate.md Normal file
View File

@@ -0,0 +1,47 @@
---
id: v2024-multi-host-integrations-agg-schedule-update
title: MultiHostIntegrationsAggScheduleUpdate
pagination_label: MultiHostIntegrationsAggScheduleUpdate
sidebar_label: MultiHostIntegrationsAggScheduleUpdate
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsAggScheduleUpdate', 'V2024MultiHostIntegrationsAggScheduleUpdate']
slug: /tools/sdk/python/v2024/models/multi-host-integrations-agg-schedule-update
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsAggScheduleUpdate', 'V2024MultiHostIntegrationsAggScheduleUpdate']
---
# MultiHostIntegrationsAggScheduleUpdate
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**multihost_id** | **str** | Multi-Host Integration ID. The ID must be unique | [required]
**aggregation_grp_id** | **str** | Multi-Host Integration aggregation group ID | [required]
**aggregation_grp_name** | **str** | Multi-Host Integration name | [required]
**aggregation_cron_schedule** | **str** | Cron expression to schedule aggregation | [required]
**enable_schedule** | **bool** | Boolean value for Multi-Host Integration aggregation schedule. This specifies if scheduled aggregation is enabled or disabled. | [required][default to False]
**source_id_list** | **[]str** | Source IDs of the Multi-Host Integration | [required]
**created** | **datetime** | Created date of Multi-Host Integration aggregation schedule | [optional]
**modified** | **datetime** | Modified date of Multi-Host Integration aggregation schedule | [optional]
}
## Example
```python
from sailpoint.v2024.models.multi_host_integrations_agg_schedule_update import MultiHostIntegrationsAggScheduleUpdate
multi_host_integrations_agg_schedule_update = MultiHostIntegrationsAggScheduleUpdate(
multihost_id='004091cb79b04636b88662afa50a4456',
aggregation_grp_id='004091cb79b04636b88662afa50a4448',
aggregation_grp_name='Multi-Host Integration aggregation group name',
aggregation_cron_schedule='0 0 0 * * ?',
enable_schedule=False,
source_id_list=[004091cb79b04636b88662afa50a4440, 00af6d0d562a49b591c47be908740542],
created='2024-01-23T18:08:50.897Z',
modified='2024-01-23T18:08:50.897Z'
)
```
[[Back to top]](#)

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

@@ -0,0 +1,38 @@
---
id: v2024-multi-host-integrations-before-provisioning-rule
title: MultiHostIntegrationsBeforeProvisioningRule
pagination_label: MultiHostIntegrationsBeforeProvisioningRule
sidebar_label: MultiHostIntegrationsBeforeProvisioningRule
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsBeforeProvisioningRule', 'V2024MultiHostIntegrationsBeforeProvisioningRule']
slug: /tools/sdk/python/v2024/models/multi-host-integrations-before-provisioning-rule
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsBeforeProvisioningRule', 'V2024MultiHostIntegrationsBeforeProvisioningRule']
---
# MultiHostIntegrationsBeforeProvisioningRule
Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'RULE' ] | Type of object being referenced. | [optional]
**id** | **str** | Rule ID. | [optional]
**name** | **str** | Rule's human-readable display name. | [optional]
}
## Example
```python
from sailpoint.v2024.models.multi_host_integrations_before_provisioning_rule import MultiHostIntegrationsBeforeProvisioningRule
multi_host_integrations_before_provisioning_rule = MultiHostIntegrationsBeforeProvisioningRule(
type='RULE',
id='2c918085708c274401708c2a8a760001',
name='Example Rule'
)
```
[[Back to top]](#)

51
docs/tools/sdk/python/Reference/V2024/Models/MultiHostIntegrationsConnectorAttributes.md Normal file
View File

@@ -0,0 +1,51 @@
---
id: v2024-multi-host-integrations-connector-attributes
title: MultiHostIntegrationsConnectorAttributes
pagination_label: MultiHostIntegrationsConnectorAttributes
sidebar_label: MultiHostIntegrationsConnectorAttributes
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsConnectorAttributes', 'V2024MultiHostIntegrationsConnectorAttributes']
slug: /tools/sdk/python/v2024/models/multi-host-integrations-connector-attributes
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributes', 'V2024MultiHostIntegrationsConnectorAttributes']
---
# MultiHostIntegrationsConnectorAttributes
Connector specific configuration. This configuration will differ for Multi-Host Integration type.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**max_allowed_sources** | **int** | Maximum sources allowed count of a Multi-Host Integration | [optional]
**last_source_upload_count** | **int** | Last upload sources count of a Multi-Host Integration | [optional]
**connector_file_upload_history** | [**MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory**](multi-host-integrations-connector-attributes-connector-file-upload-history) | | [optional]
**multihost_status** | **Enum** [ 'ready', 'processing', 'fileUploadInProgress', 'sourceCreationInProgress', 'aggregationGroupingInProgress', 'aggregationScheduleInProgress', 'deleteInProgress', 'deleteFailed' ] | Multi-Host integration status. | [optional]
**show_account_schema** | **bool** | Show account schema | [optional] [default to True]
**show_entitlement_schema** | **bool** | Show entitlement schema | [optional] [default to True]
**multi_host_attributes** | [**MultiHostIntegrationsConnectorAttributesMultiHostAttributes**](multi-host-integrations-connector-attributes-multi-host-attributes) | | [optional]
}
## Example
```python
from sailpoint.v2024.models.multi_host_integrations_connector_attributes import MultiHostIntegrationsConnectorAttributes
multi_host_integrations_connector_attributes = MultiHostIntegrationsConnectorAttributes(
max_allowed_sources=250,
last_source_upload_count=40,
connector_file_upload_history=sailpoint.v2024.models.multi_host_integrations_connector_attributes_connector_file_upload_history.MultiHostIntegrations_connectorAttributes_connectorFileUploadHistory(
connector_file_name_uploaded_date = '2024-08-29T10:20:38.896479Z', ),
multihost_status='ready',
show_account_schema=True,
show_entitlement_schema=True,
multi_host_attributes=sailpoint.v2024.models.multi_host_integrations_connector_attributes_multi_host_attributes.MultiHostIntegrations_connectorAttributes_multiHostAttributes(
password = 'Password',
connector_files = 'mssql-jdbc-8.4.1.jre8.jar',
auth_type = 'SQLAuthentication',
user = 'My Username', )
)
```
[[Back to top]](#)

33
docs/tools/sdk/python/Reference/V2024/Models/MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory.md Normal file
View File

@@ -0,0 +1,33 @@
---
id: v2024-multi-host-integrations-connector-attributes-connector-file-upload-history
title: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory
pagination_label: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory
sidebar_label: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory', 'V2024MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory']
slug: /tools/sdk/python/v2024/models/multi-host-integrations-connector-attributes-connector-file-upload-history
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory', 'V2024MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory']
---
# MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**connector_file_name_uploaded_date** | **str** | File name of the connector JAR | [optional]
}
## Example
```python
from sailpoint.v2024.models.multi_host_integrations_connector_attributes_connector_file_upload_history import MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory
multi_host_integrations_connector_attributes_connector_file_upload_history = MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory(
connector_file_name_uploaded_date='2024-08-29T10:20:38.896479Z'
)
```
[[Back to top]](#)

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

@@ -0,0 +1,40 @@
---
id: v2024-multi-host-integrations-connector-attributes-multi-host-attributes
title: MultiHostIntegrationsConnectorAttributesMultiHostAttributes
pagination_label: MultiHostIntegrationsConnectorAttributesMultiHostAttributes
sidebar_label: MultiHostIntegrationsConnectorAttributesMultiHostAttributes
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsConnectorAttributesMultiHostAttributes', 'V2024MultiHostIntegrationsConnectorAttributesMultiHostAttributes']
slug: /tools/sdk/python/v2024/models/multi-host-integrations-connector-attributes-multi-host-attributes
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributesMultiHostAttributes', 'V2024MultiHostIntegrationsConnectorAttributesMultiHostAttributes']
---
# MultiHostIntegrationsConnectorAttributesMultiHostAttributes
Attributes of Multi-Host Integration
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**password** | **str** | Password. | [optional]
**connector_files** | **str** | Connector file. | [optional]
**auth_type** | **str** | Authentication type. | [optional]
**user** | **str** | Username. | [optional]
}
## Example
```python
from sailpoint.v2024.models.multi_host_integrations_connector_attributes_multi_host_attributes import MultiHostIntegrationsConnectorAttributesMultiHostAttributes
multi_host_integrations_connector_attributes_multi_host_attributes = MultiHostIntegrationsConnectorAttributesMultiHostAttributes(
password='Password',
connector_files='mssql-jdbc-8.4.1.jre8.jar',
auth_type='SQLAuthentication',
user='My Username'
)
```
[[Back to top]](#)

58
docs/tools/sdk/python/Reference/V2024/Models/MultiHostIntegrationsCreate.md Normal file
View File

@@ -0,0 +1,58 @@
---
id: v2024-multi-host-integrations-create
title: MultiHostIntegrationsCreate
pagination_label: MultiHostIntegrationsCreate
sidebar_label: MultiHostIntegrationsCreate
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsCreate', 'V2024MultiHostIntegrationsCreate']
slug: /tools/sdk/python/v2024/models/multi-host-integrations-create
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsCreate', 'V2024MultiHostIntegrationsCreate']
---
# MultiHostIntegrationsCreate
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Multi-Host Integration's human-readable name. | [required]
**description** | **str** | Multi-Host Integration's human-readable description. | [required]
**owner** | [**SourceOwner**](source-owner) | | [required]
**cluster** | [**SourceCluster**](source-cluster) | | [optional]
**connector** | **str** | Connector script name. | [required]
**connector_attributes** | **map[string]object** | Multi-Host Integration specific configuration. User can add any number of additional attributes. e.g. maxSourcesPerAggGroup, maxAllowedSources etc. | [optional]
**management_workgroup** | [**SourceManagementWorkgroup**](source-management-workgroup) | | [optional]
**created** | **datetime** | Date-time when the source was created | [optional]
**modified** | **datetime** | Date-time when the source was last modified. | [optional]
}
## Example
```python
from sailpoint.v2024.models.multi_host_integrations_create import MultiHostIntegrationsCreate
multi_host_integrations_create = MultiHostIntegrationsCreate(
name='My Multi-Host Integration',
description='This is the Multi-Host Integration.',
owner=sailpoint.v2024.models.source_owner.Source_owner(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'MyName', ),
cluster=sailpoint.v2024.models.source_cluster.Source_cluster(
type = 'CLUSTER',
id = '2c9180866166b5b0016167c32ef31a66',
name = 'Corporate Cluster', ),
connector='multihost-microsoft-sql-server',
connector_attributes={maxSourcesPerAggGroup=10, maxAllowedSources=300},
management_workgroup=sailpoint.v2024.models.source_management_workgroup.Source_managementWorkgroup(
type = 'GOVERNANCE_GROUP',
id = '2c91808568c529c60168cca6f90c2222',
name = 'My Management Workgroup', ),
created='2022-02-08T14:50:03.827Z',
modified='2024-01-23T18:08:50.897Z'
)
```
[[Back to top]](#)

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

@@ -0,0 +1,38 @@
---
id: v2024-multi-host-integrations-create-sources
title: MultiHostIntegrationsCreateSources
pagination_label: MultiHostIntegrationsCreateSources
sidebar_label: MultiHostIntegrationsCreateSources
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsCreateSources', 'V2024MultiHostIntegrationsCreateSources']
slug: /tools/sdk/python/v2024/models/multi-host-integrations-create-sources
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsCreateSources', 'V2024MultiHostIntegrationsCreateSources']
---
# MultiHostIntegrationsCreateSources
This represents sources to be created of same type.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Source's human-readable name. | [required]
**description** | **str** | Source's human-readable description. | [optional]
**connector_attributes** | **map[string]object** | Connector specific configuration. This configuration will differ from type to type. | [optional]
}
## Example
```python
from sailpoint.v2024.models.multi_host_integrations_create_sources import MultiHostIntegrationsCreateSources
multi_host_integrations_create_sources = MultiHostIntegrationsCreateSources(
name='My Source',
description='This is the corporate directory.',
connector_attributes={authType=SQLAuthentication, url=jdbc:sqlserver://178.18.41.118:1433, user=username, driverClass=com.microsoft.sqlserver.jdbc.SQLServerDriver, maxSourcesPerAggGroup=10, maxAllowedSources=300}
)
```
[[Back to top]](#)

116
docs/tools/sdk/python/Reference/V2024/Models/MultiHostSources.md Normal file
View File

@@ -0,0 +1,116 @@
---
id: v2024-multi-host-sources
title: MultiHostSources
pagination_label: MultiHostSources
sidebar_label: MultiHostSources
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'MultiHostSources', 'V2024MultiHostSources']
slug: /tools/sdk/python/v2024/models/multi-host-sources
tags: ['SDK', 'Software Development Kit', 'MultiHostSources', 'V2024MultiHostSources']
---
# MultiHostSources
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Source ID. | [required][readonly]
**name** | **str** | Source's human-readable name. | [required]
**description** | **str** | Source's human-readable description. | [optional]
**owner** | [**SourceOwner**](source-owner) | | [required]
**cluster** | [**SourceCluster**](source-cluster) | | [optional]
**account_correlation_config** | [**SourceAccountCorrelationConfig**](source-account-correlation-config) | | [optional]
**account_correlation_rule** | [**SourceAccountCorrelationRule**](source-account-correlation-rule) | | [optional]
**manager_correlation_mapping** | [**ManagerCorrelationMapping**](manager-correlation-mapping) | | [optional]
**manager_correlation_rule** | [**SourceManagerCorrelationRule**](source-manager-correlation-rule) | | [optional]
**before_provisioning_rule** | [**SourceBeforeProvisioningRule**](source-before-provisioning-rule) | | [optional]
**schemas** | [**[]SourceSchemasInner**](source-schemas-inner) | List of references to schema objects. | [optional]
**password_policies** | [**[]SourcePasswordPoliciesInner**](source-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional]
**features** | **[]str** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional]
**type** | **str** | Specifies the type of system being managed e.g. Multi-Host - Microsoft SQL Server, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional]
**connector** | **str** | Connector script name. | [required]
**connector_class** | **str** | Fully qualified name of the Java class that implements the connector interface. | [optional]
**connector_attributes** | **map[string]object** | Connector specific configuration. This configuration will differ from type to type. | [optional]
**delete_threshold** | **int** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional]
**authoritative** | **bool** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to False]
**management_workgroup** | [**SourceManagementWorkgroup**](source-management-workgroup) | | [optional]
**healthy** | **bool** | When this is true, it indicates that the source is healthy. | [optional] [default to False]
**status** | **Enum** [ 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', 'SOURCE_STATE_ERROR_CLUSTER', 'SOURCE_STATE_ERROR_SOURCE', 'SOURCE_STATE_ERROR_VA', 'SOURCE_STATE_FAILURE_CLUSTER', 'SOURCE_STATE_FAILURE_SOURCE', 'SOURCE_STATE_HEALTHY', 'SOURCE_STATE_UNCHECKED_CLUSTER', 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', 'SOURCE_STATE_UNCHECKED_SOURCE', 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' ] | Status identifier that gives specific information about why a source is or isn't healthy. | [optional]
**since** | **datetime** | Timestamp that shows when a source health check was last performed. | [optional]
**connector_id** | **str** | Connector ID | [optional]
**connector_name** | **str** | Name of the connector that was chosen during source creation. | [required]
**connection_type** | **str** | Type of connection (direct or file). | [optional]
**connector_implementation_id** | **str** | Connector implementation ID. | [optional]
**created** | **datetime** | Date-time when the source was created | [optional]
**modified** | **datetime** | Date-time when the source was last modified. | [optional]
**credential_provider_enabled** | **bool** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to False]
**category** | **str** | Source category (e.g. null, CredentialProvider). | [optional]
}
## Example
```python
from sailpoint.v2024.models.multi_host_sources import MultiHostSources
multi_host_sources = MultiHostSources(
id='2c91808568c529c60168cca6f90c1324',
name='My Source',
description='This is the Source.',
owner=sailpoint.v2024.models.source_owner.Source_owner(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'MyName', ),
cluster=sailpoint.v2024.models.source_cluster.Source_cluster(
type = 'CLUSTER',
id = '2c9180866166b5b0016167c32ef31a66',
name = 'Corporate Cluster', ),
account_correlation_config=sailpoint.v2024.models.source_account_correlation_config.Source_accountCorrelationConfig(
type = 'ACCOUNT_CORRELATION_CONFIG',
id = '2c9180855d191c59015d28583727245a',
name = 'Directory [source-62867] Account Correlation', ),
account_correlation_rule=sailpoint.v2024.models.source_account_correlation_rule.Source_accountCorrelationRule(
type = 'RULE',
id = '2c918085708c274401708c2a8a760001',
name = 'Example Rule', ),
manager_correlation_mapping=sailpoint.v2024.models.manager_correlation_mapping.ManagerCorrelationMapping(
account_attribute_name = 'manager',
identity_attribute_name = 'manager', ),
manager_correlation_rule=sailpoint.v2024.models.source_manager_correlation_rule.Source_managerCorrelationRule(
type = 'RULE',
id = '2c918085708c274401708c2a8a760001',
name = 'Example Rule', ),
before_provisioning_rule=sailpoint.v2024.models.source_before_provisioning_rule.Source_beforeProvisioningRule(
type = 'RULE',
id = '2c918085708c274401708c2a8a760001',
name = 'Example Rule', ),
schemas=[{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}],
password_policies=[{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}],
features=[PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS],
type='Multi-Host - Microsoft SQL Server',
connector='multihost-microsoft-sql-server',
connector_class='sailpoint.connector.OpenConnectorAdapter',
connector_attributes={healthCheckTimeout=30, authSearchAttributes=[cn, uid, mail]},
delete_threshold=10,
authoritative=False,
management_workgroup=sailpoint.v2024.models.source_management_workgroup.Source_managementWorkgroup(
type = 'GOVERNANCE_GROUP',
id = '2c91808568c529c60168cca6f90c2222',
name = 'My Management Workgroup', ),
healthy=True,
status='SOURCE_STATE_HEALTHY',
since=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'),
connector_id='multihost-microsoft-sql-server',
connector_name='Multi-Host Microsoft SQL Server',
connection_type='file',
connector_implementation_id='multihost-microsoft-sql-server',
created='2022-02-08T14:50:03.827Z',
modified='2024-01-23T18:08:50.897Z',
credential_provider_enabled=False,
category='CredentialProvider'
)
```
[[Back to top]](#)

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

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**op** | **Enum** [ 'remove', 'replace' ] | The operation to be performed | [optional]
**path** | **str** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required]
**value** | [**JsonPatchOperationValue**](json-patch-operation-value) | | [optional]
**value** | [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional]
}
## Example

43
docs/tools/sdk/python/Reference/V2024/Models/SourceCreationErrors.md Normal file
View File

@@ -0,0 +1,43 @@
---
id: v2024-source-creation-errors
title: SourceCreationErrors
pagination_label: SourceCreationErrors
sidebar_label: SourceCreationErrors
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'SourceCreationErrors', 'V2024SourceCreationErrors']
slug: /tools/sdk/python/v2024/models/source-creation-errors
tags: ['SDK', 'Software Development Kit', 'SourceCreationErrors', 'V2024SourceCreationErrors']
---
# SourceCreationErrors
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**multihost_id** | **str** | Multi-Host Integration ID. | [optional] [readonly]
**source_name** | **str** | Source's human-readable name. | [optional]
**source_error** | **str** | Source's human-readable description. | [optional]
**created** | **datetime** | Date-time when the source was created | [optional]
**modified** | **datetime** | Date-time when the source was last modified. | [optional]
**operation** | **str** | operation category (e.g. DELETE). | [optional]
}
## Example
```python
from sailpoint.v2024.models.source_creation_errors import SourceCreationErrors
source_creation_errors = SourceCreationErrors(
multihost_id='2c91808568c529c60168cca6f90c1324',
source_name='My Source',
source_error='Source with internal name "My Source [source]" already exists.',
created='2022-02-08T14:50:03.827Z',
modified='2024-01-23T18:08:50.897Z',
operation='DELETE'
)
```
[[Back to top]](#)

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

@@ -0,0 +1,41 @@
---
id: v2024-test-source-connection-multihost200-response
title: TestSourceConnectionMultihost200Response
pagination_label: TestSourceConnectionMultihost200Response
sidebar_label: TestSourceConnectionMultihost200Response
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'TestSourceConnectionMultihost200Response', 'V2024TestSourceConnectionMultihost200Response']
slug: /tools/sdk/python/v2024/models/test-source-connection-multihost200-response
tags: ['SDK', 'Software Development Kit', 'TestSourceConnectionMultihost200Response', 'V2024TestSourceConnectionMultihost200Response']
---
# TestSourceConnectionMultihost200Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**success** | **bool** | Source's test connection status. | [optional]
**message** | **str** | Source's test connection message. | [optional]
**timing** | **int** | Source's test connection timing. | [optional]
**result_type** | **Enum** [ 'SOURCE_STATE_ERROR_CLUSTER', 'SOURCE_STATE_ERROR_SOURCE', 'SOURCE_STATE_ERROR_VA', 'SOURCE_STATE_FAILURE_CLUSTER', 'SOURCE_STATE_FAILURE_SOURCE', 'SOURCE_STATE_HEALTHY', 'SOURCE_STATE_UNCHECKED_CLUSTER', 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', 'SOURCE_STATE_UNCHECKED_SOURCE', 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS', 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT' ] | Source's human-readable result type. | [optional]
**test_connection_details** | **str** | Source's human-readable test connection details. | [optional]
}
## Example
```python
from sailpoint.v2024.models.test_source_connection_multihost200_response import TestSourceConnectionMultihost200Response
test_source_connection_multihost200_response = TestSourceConnectionMultihost200Response(
success=True,
message='Tes.',
timing=56,
result_type=SOURCE_STATE_HEALTHY,
test_connection_details=''
)
```
[[Back to top]](#)

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

@@ -0,0 +1,38 @@
---
id: v2024-update-multi-host-sources-request-inner
title: UpdateMultiHostSourcesRequestInner
pagination_label: UpdateMultiHostSourcesRequestInner
sidebar_label: UpdateMultiHostSourcesRequestInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'UpdateMultiHostSourcesRequestInner', 'V2024UpdateMultiHostSourcesRequestInner']
slug: /tools/sdk/python/v2024/models/update-multi-host-sources-request-inner
tags: ['SDK', 'Software Development Kit', 'UpdateMultiHostSourcesRequestInner', 'V2024UpdateMultiHostSourcesRequestInner']
---
# UpdateMultiHostSourcesRequestInner
A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**op** | **Enum** [ 'add', 'replace' ] | The operation to be performed | [required]
**path** | **str** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required]
**value** | [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional]
}
## Example
```python
from sailpoint.v2024.models.update_multi_host_sources_request_inner import UpdateMultiHostSourcesRequestInner
update_multi_host_sources_request_inner = UpdateMultiHostSourcesRequestInner(
op='replace',
path='/description',
value=New description
)
```
[[Back to top]](#)

32
docs/tools/sdk/python/Reference/V2024/Models/UpdateMultiHostSourcesRequestInnerValue.md Normal file
View File

@@ -0,0 +1,32 @@
---
id: v2024-update-multi-host-sources-request-inner-value
title: UpdateMultiHostSourcesRequestInnerValue
pagination_label: UpdateMultiHostSourcesRequestInnerValue
sidebar_label: UpdateMultiHostSourcesRequestInnerValue
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'UpdateMultiHostSourcesRequestInnerValue', 'V2024UpdateMultiHostSourcesRequestInnerValue']
slug: /tools/sdk/python/v2024/models/update-multi-host-sources-request-inner-value
tags: ['SDK', 'Software Development Kit', 'UpdateMultiHostSourcesRequestInnerValue', 'V2024UpdateMultiHostSourcesRequestInnerValue']
---
# UpdateMultiHostSourcesRequestInnerValue
The value to be used for the operation, required for \"add\" and \"replace\" operations
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
}
## Example
```python
from sailpoint.v2024.models.update_multi_host_sources_request_inner_value import UpdateMultiHostSourcesRequestInnerValue
update_multi_host_sources_request_inner_value = UpdateMultiHostSourcesRequestInnerValue(
)
```
[[Back to top]](#)