Update to python SDK docs: 14132739659

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

View File

@@ -4370,6 +4370,161 @@
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling ConfigurationHubApi->update_scheduled_action: %s\n" % e)
- path: /connector-customizers
method: POST
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/connector-customizers#create-connector-customizer
source: |
from sailpoint.v2024.api.connector_customizers_api import ConnectorCustomizersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.connector_customizer_create_request import ConnectorCustomizerCreateRequest
from sailpoint.v2024.models.connector_customizer_create_response import ConnectorCustomizerCreateResponse
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
connector_customizer_create_request = '''{
"name" : "My Custom Connector"
}''' # ConnectorCustomizerCreateRequest | Connector customizer to create.
try:
# Create Connector Customizer
new_connector_customizer_create_request = ConnectorCustomizerCreateRequest.from_json(connector_customizer_create_request)
results = ConnectorCustomizersApi(api_client).create_connector_customizer(connector_customizer_create_request=new_connector_customizer_create_request)
# Below is a request that includes all optional parameters
# results = ConnectorCustomizersApi(api_client).create_connector_customizer(new_connector_customizer_create_request)
print("The response of ConnectorCustomizersApi->create_connector_customizer:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling ConnectorCustomizersApi->create_connector_customizer: %s\n" % e)
- path: /connector-customizers/{id}/versions
method: POST
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/connector-customizers#create-connector-customizer-version
source: |
from sailpoint.v2024.api.connector_customizers_api import ConnectorCustomizersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.connector_customizer_version_create_response import ConnectorCustomizerVersionCreateResponse
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'b07dc46a-1498-4de8-bfbb-259a68e70c8a' # str | The id of the connector customizer. # str | The id of the connector customizer.
try:
# Creates a connector customizer version
results = ConnectorCustomizersApi(api_client).create_connector_customizer_version(id=id)
# Below is a request that includes all optional parameters
# results = ConnectorCustomizersApi(api_client).create_connector_customizer_version(id)
print("The response of ConnectorCustomizersApi->create_connector_customizer_version:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling ConnectorCustomizersApi->create_connector_customizer_version: %s\n" % e)
- path: /connector-customizers/{id}
method: DELETE
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/connector-customizers#delete-connector-customizer
source: |
from sailpoint.v2024.api.connector_customizers_api import ConnectorCustomizersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'b07dc46a-1498-4de8-bfbb-259a68e70c8a' # str | ID of the connector customizer to delete. # str | ID of the connector customizer to delete.
try:
# Delete Connector Customizer
ConnectorCustomizersApi(api_client).delete_connector_customizer(id=id)
# Below is a request that includes all optional parameters
# ConnectorCustomizersApi(api_client).delete_connector_customizer(id)
except Exception as e:
print("Exception when calling ConnectorCustomizersApi->delete_connector_customizer: %s\n" % e)
- path: /connector-customizers/{id}
method: GET
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/connector-customizers#get-connector-customizer
source: |
from sailpoint.v2024.api.connector_customizers_api import ConnectorCustomizersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.connector_customizers_response import ConnectorCustomizersResponse
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'b07dc46a-1498-4de8-bfbb-259a68e70c8a' # str | ID of the connector customizer to get. # str | ID of the connector customizer to get.
try:
# Get connector customizer
results = ConnectorCustomizersApi(api_client).get_connector_customizer(id=id)
# Below is a request that includes all optional parameters
# results = ConnectorCustomizersApi(api_client).get_connector_customizer(id)
print("The response of ConnectorCustomizersApi->get_connector_customizer:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling ConnectorCustomizersApi->get_connector_customizer: %s\n" % e)
- path: /connector-customizers
method: GET
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/connector-customizers#list-connector-customizers
source: |
from sailpoint.v2024.api.connector_customizers_api import ConnectorCustomizersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.connector_customizers_response import ConnectorCustomizersResponse
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
try:
# List All Connector Customizers
results = ConnectorCustomizersApi(api_client).list_connector_customizers()
# Below is a request that includes all optional parameters
# results = ConnectorCustomizersApi(api_client).list_connector_customizers(offset, limit)
print("The response of ConnectorCustomizersApi->list_connector_customizers:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling ConnectorCustomizersApi->list_connector_customizers: %s\n" % e)
- path: /connector-customizers/{id}
method: PUT
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/connector-customizers#put-connector-customizer
source: |
from sailpoint.v2024.api.connector_customizers_api import ConnectorCustomizersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.connector_customizer_update_request import ConnectorCustomizerUpdateRequest
from sailpoint.v2024.models.connector_customizer_update_response import ConnectorCustomizerUpdateResponse
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'b07dc46a-1498-4de8-bfbb-259a68e70c8a' # str | ID of the connector customizer to update. # str | ID of the connector customizer to update.
connector_customizer_update_request = '''{
"name" : "My Custom Connector"
}''' # ConnectorCustomizerUpdateRequest | Connector rule with updated data. (optional)
try:
# Update Connector Customizer
results = ConnectorCustomizersApi(api_client).put_connector_customizer(id=id)
# Below is a request that includes all optional parameters
# results = ConnectorCustomizersApi(api_client).put_connector_customizer(id, new_connector_customizer_update_request)
print("The response of ConnectorCustomizersApi->put_connector_customizer:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling ConnectorCustomizersApi->put_connector_customizer: %s\n" % e)
- path: /connector-rules
method: POST
xCodeSample:
@@ -4383,10 +4538,8 @@
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
connector_rule_create_request = '''{
"sourceCode" : {
"version" : "1.0",
@@ -4416,9 +4569,9 @@
try:
# Create Connector Rule
new_connector_rule_create_request = ConnectorRuleCreateRequest.from_json(connector_rule_create_request)
results = ConnectorRuleManagementApi(api_client).create_connector_rule(x_sail_point_experimental=x_sail_point_experimental, connector_rule_create_request=new_connector_rule_create_request)
results = ConnectorRuleManagementApi(api_client).create_connector_rule(connector_rule_create_request=new_connector_rule_create_request)
# Below is a request that includes all optional parameters
# results = ConnectorRuleManagementApi(api_client).create_connector_rule(x_sail_point_experimental, new_connector_rule_create_request)
# results = ConnectorRuleManagementApi(api_client).create_connector_rule(new_connector_rule_create_request)
print("The response of ConnectorRuleManagementApi->create_connector_rule:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
@@ -4434,17 +4587,15 @@
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to delete. # str | ID of the connector rule to delete.
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
try:
# Delete Connector Rule
ConnectorRuleManagementApi(api_client).delete_connector_rule(id=id, x_sail_point_experimental=x_sail_point_experimental)
ConnectorRuleManagementApi(api_client).delete_connector_rule(id=id)
# Below is a request that includes all optional parameters
# ConnectorRuleManagementApi(api_client).delete_connector_rule(id, x_sail_point_experimental)
# ConnectorRuleManagementApi(api_client).delete_connector_rule(id)
except Exception as e:
print("Exception when calling ConnectorRuleManagementApi->delete_connector_rule: %s\n" % e)
- path: /connector-rules/{id}
@@ -4459,17 +4610,15 @@
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to get. # str | ID of the connector rule to get.
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
try:
# Get Connector Rule
results = ConnectorRuleManagementApi(api_client).get_connector_rule(id=id, x_sail_point_experimental=x_sail_point_experimental)
results = ConnectorRuleManagementApi(api_client).get_connector_rule(id=id)
# Below is a request that includes all optional parameters
# results = ConnectorRuleManagementApi(api_client).get_connector_rule(id, x_sail_point_experimental)
# results = ConnectorRuleManagementApi(api_client).get_connector_rule(id)
print("The response of ConnectorRuleManagementApi->get_connector_rule:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
@@ -4486,19 +4635,17 @@
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50)
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)
try:
# List Connector Rules
results = ConnectorRuleManagementApi(api_client).get_connector_rule_list(x_sail_point_experimental=x_sail_point_experimental)
results = ConnectorRuleManagementApi(api_client).get_connector_rule_list()
# Below is a request that includes all optional parameters
# results = ConnectorRuleManagementApi(api_client).get_connector_rule_list(x_sail_point_experimental, limit, offset, count)
# results = ConnectorRuleManagementApi(api_client).get_connector_rule_list(limit, offset, count)
print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
@@ -4516,11 +4663,9 @@
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to update. # str | ID of the connector rule to update.
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')
connector_rule_update_request = '''{
"sourceCode" : {
"version" : "1.0",
@@ -4551,9 +4696,9 @@
try:
# Update Connector Rule
results = ConnectorRuleManagementApi(api_client).put_connector_rule(id=id, x_sail_point_experimental=x_sail_point_experimental)
results = ConnectorRuleManagementApi(api_client).put_connector_rule(id=id)
# Below is a request that includes all optional parameters
# results = ConnectorRuleManagementApi(api_client).put_connector_rule(id, x_sail_point_experimental, new_connector_rule_update_request)
# results = ConnectorRuleManagementApi(api_client).put_connector_rule(id, new_connector_rule_update_request)
print("The response of ConnectorRuleManagementApi->put_connector_rule:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
@@ -4571,10 +4716,8 @@
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
source_code = '''{
"version" : "1.0",
"script" : "return \"Mr. \" + firstName;"
@@ -4582,9 +4725,9 @@
try:
# Validate Connector Rule
new_source_code = SourceCode.from_json(source_code)
results = ConnectorRuleManagementApi(api_client).test_connector_rule(x_sail_point_experimental=x_sail_point_experimental, source_code=new_source_code)
results = ConnectorRuleManagementApi(api_client).test_connector_rule(source_code=new_source_code)
# Below is a request that includes all optional parameters
# results = ConnectorRuleManagementApi(api_client).test_connector_rule(x_sail_point_experimental, new_source_code)
# results = ConnectorRuleManagementApi(api_client).test_connector_rule(new_source_code)
print("The response of ConnectorRuleManagementApi->test_connector_rule:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
@@ -10522,6 +10665,150 @@
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e)
- path: /managed-cluster-types
method: POST
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#create-managed-cluster-type
source: |
from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
managed_cluster_type = '''{
"managedProcessIds" : [ "someId", "someId2" ],
"pod" : "megapod-useast1",
"org" : "denali-cjh",
"id" : "aClusterTypeId",
"type" : "idn"
}''' # ManagedClusterType |
try:
# Create new Managed Cluster Type
new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type)
results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type)
# Below is a request that includes all optional parameters
# results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type)
print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e)
- path: /managed-cluster-types/{id}
method: DELETE
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#delete-managed-cluster-type
source: |
from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID
try:
# Delete a Managed Cluster Type
ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id)
# Below is a request that includes all optional parameters
# ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id)
except Exception as e:
print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e)
- path: /managed-cluster-types/{id}
method: GET
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#get-managed-cluster-type
source: |
from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID
try:
# Get a Managed Cluster Type
results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id)
# Below is a request that includes all optional parameters
# results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id)
print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e)
- path: /managed-cluster-types
method: GET
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#get-managed-cluster-types
source: |
from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional)
pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional)
org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional)
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
try:
# Get Managed Cluster Types
results = ManagedClusterTypesApi(api_client).get_managed_cluster_types()
# Below is a request that includes all optional parameters
# results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit)
print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e)
- path: /managed-cluster-types/{id}
method: PATCH
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/managed-cluster-types#update-managed-cluster-type
source: |
from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch import JsonPatch
from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID
json_patch = '''{
"operations" : [ {
"op" : "replace",
"path" : "/description",
"value" : "New description"
}, {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} ]
}''' # JsonPatch | The JSONPatch payload used to update the schema.
try:
# Update a Managed Cluster Type
new_json_patch = JsonPatch.from_json(json_patch)
results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch)
# Below is a request that includes all optional parameters
# results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch)
print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e)
- path: /managed-clusters
method: POST
xCodeSample:
@@ -10736,6 +11023,363 @@
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e)
- path: /multihosts
method: POST
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/multi-host-integration#create-multi-host-integration
source: |
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.multi_host_integrations import MultiHostIntegrations
from sailpoint.v2024.models.multi_host_integrations_create import MultiHostIntegrationsCreate
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multi_host_integrations_create = '''{
"owner" : {
"name" : "MyName",
"id" : "2c91808568c529c60168cca6f90c1313",
"type" : "IDENTITY"
},
"managementWorkgroup" : {
"name" : "My Management Workgroup",
"id" : "2c91808568c529c60168cca6f90c2222",
"type" : "GOVERNANCE_GROUP"
},
"cluster" : {
"name" : "Corporate Cluster",
"id" : "2c9180866166b5b0016167c32ef31a66",
"type" : "CLUSTER"
},
"connector" : "multihost-microsoft-sql-server",
"connectorAttributes" : {
"maxSourcesPerAggGroup" : 10,
"maxAllowedSources" : 300
},
"created" : "2022-02-08T14:50:03.827Z",
"name" : "My Multi-Host Integration",
"description" : "This is the Multi-Host Integration.",
"modified" : "2024-01-23T18:08:50.897Z"
}''' # MultiHostIntegrationsCreate | The specifics of the Multi-Host Integration to create
try:
# Create Multi-Host Integration
new_multi_host_integrations_create = MultiHostIntegrationsCreate.from_json(multi_host_integrations_create)
results = MultiHostIntegrationApi(api_client).create_multi_host_integration(multi_host_integrations_create=new_multi_host_integrations_create)
# Below is a request that includes all optional parameters
# results = MultiHostIntegrationApi(api_client).create_multi_host_integration(new_multi_host_integrations_create)
print("The response of MultiHostIntegrationApi->create_multi_host_integration:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MultiHostIntegrationApi->create_multi_host_integration: %s\n" % e)
- path: /multihosts/{multihostId}
method: POST
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/multi-host-integration#create-sources-within-multi-host
source: |
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.multi_host_integrations_create_sources import MultiHostIntegrationsCreateSources
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration. # str | ID of the Multi-Host Integration.
multi_host_integrations_create_sources = '''[sailpoint.v2024.MultiHostIntegrationsCreateSources()]''' # List[MultiHostIntegrationsCreateSources] | The specifics of the sources to create within Multi-Host Integration.
try:
# Create Sources Within Multi-Host Integration
new_multi_host_integrations_create_sources = MultiHostIntegrationsCreateSources.from_json(multi_host_integrations_create_sources)
MultiHostIntegrationApi(api_client).create_sources_within_multi_host(multihost_id=multihost_id, multi_host_integrations_create_sources=new_multi_host_integrations_create_sources)
# Below is a request that includes all optional parameters
# MultiHostIntegrationApi(api_client).create_sources_within_multi_host(multihost_id, new_multi_host_integrations_create_sources)
except Exception as e:
print("Exception when calling MultiHostIntegrationApi->create_sources_within_multi_host: %s\n" % e)
- path: /multihosts/{multihostId}
method: DELETE
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/multi-host-integration#delete-multi-host
source: |
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of Multi-Host Integration to delete. # str | ID of Multi-Host Integration to delete.
try:
# Delete Multi-Host Integration
MultiHostIntegrationApi(api_client).delete_multi_host(multihost_id=multihost_id)
# Below is a request that includes all optional parameters
# MultiHostIntegrationApi(api_client).delete_multi_host(multihost_id)
except Exception as e:
print("Exception when calling MultiHostIntegrationApi->delete_multi_host: %s\n" % e)
- path: /multihosts/{multihostId}/acctAggregationGroups
method: GET
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/multi-host-integration#get-acct-aggregation-groups
source: |
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.multi_host_integrations_agg_schedule_update import MultiHostIntegrationsAggScheduleUpdate
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multihost_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
try:
# List Account-Aggregation-Groups by Multi-Host ID
results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id=multihost_id)
# Below is a request that includes all optional parameters
# results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id, offset, limit)
print("The response of MultiHostIntegrationApi->get_acct_aggregation_groups:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MultiHostIntegrationApi->get_acct_aggregation_groups: %s\n" % e)
- path: /multihosts/{multiHostId}/entitlementAggregationGroups
method: GET
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/multi-host-integration#get-entitlement-aggregation-groups
source: |
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.multi_host_integrations_agg_schedule_update import MultiHostIntegrationsAggScheduleUpdate
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multi_host_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
try:
# List Entitlement-Aggregation-Groups by Integration ID
results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id=multi_host_id)
# Below is a request that includes all optional parameters
# results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id, offset, limit)
print("The response of MultiHostIntegrationApi->get_entitlement_aggregation_groups:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MultiHostIntegrationApi->get_entitlement_aggregation_groups: %s\n" % e)
- path: /multihosts/{multihostId}
method: GET
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/multi-host-integration#get-multi-host-integrations
source: |
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.multi_host_integrations import MultiHostIntegrations
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration. # str | ID of the Multi-Host Integration.
try:
# Get Multi-Host Integration By ID
results = MultiHostIntegrationApi(api_client).get_multi_host_integrations(multihost_id=multihost_id)
# Below is a request that includes all optional parameters
# results = MultiHostIntegrationApi(api_client).get_multi_host_integrations(multihost_id)
print("The response of MultiHostIntegrationApi->get_multi_host_integrations:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations: %s\n" % e)
- path: /multihosts
method: GET
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/multi-host-integration#get-multi-host-integrations-list
source: |
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.multi_host_integrations import MultiHostIntegrations
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional)
filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *in* (optional)
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)
for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional)
try:
# List All Existing Multi-Host Integrations
results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list()
# Below is a request that includes all optional parameters
# results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin)
print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e)
- path: /multihosts/{multiHostId}/sources/errors
method: GET
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/multi-host-integration#get-multi-host-source-creation-errors
source: |
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.source_creation_errors import SourceCreationErrors
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multi_host_id = '004091cb79b04636b88662afa50a4440' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration
try:
# List Multi-Host Source Creation Errors
results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id=multi_host_id)
# Below is a request that includes all optional parameters
# results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id)
print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e)
- path: /multihosts/types
method: GET
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/multi-host-integration#get-multihost-integration-types
source: |
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.multi_host_integration_template_type import MultiHostIntegrationTemplateType
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Multi-Host Integration Types
results = MultiHostIntegrationApi(api_client).get_multihost_integration_types()
# Below is a request that includes all optional parameters
# results = MultiHostIntegrationApi(api_client).get_multihost_integration_types()
print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e)
- path: /multihosts/{multihostId}/sources
method: GET
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/multi-host-integration#get-sources-within-multi-host
source: |
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.multi_host_sources import MultiHostSources
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multihost_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional)
filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional)
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)
try:
# List Sources Within Multi-Host Integration
results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id=multihost_id)
# Below is a request that includes all optional parameters
# results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count)
print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e)
- path: /multihosts/{multihostId}/sources/testConnection
method: POST
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/multi-host-integration#test-connection-multi-host-sources
source: |
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multihost_id = '2c91808568c529c60168cca6f90c1324' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration
try:
# Test Configuration For Multi-Host Integration
MultiHostIntegrationApi(api_client).test_connection_multi_host_sources(multihost_id=multihost_id)
# Below is a request that includes all optional parameters
# MultiHostIntegrationApi(api_client).test_connection_multi_host_sources(multihost_id)
except Exception as e:
print("Exception when calling MultiHostIntegrationApi->test_connection_multi_host_sources: %s\n" % e)
- path: /multihosts/{multihostId}/sources/{sourceId}/testConnection
method: GET
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/multi-host-integration#test-source-connection-multihost
source: |
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.test_source_connection_multihost200_response import TestSourceConnectionMultihost200Response
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration
source_id = '2c91808568c529f60168cca6f90c1324' # str | ID of the source within the Multi-Host Integration # str | ID of the source within the Multi-Host Integration
try:
# Test Configuration For Multi-Host Integration's Single Source
results = MultiHostIntegrationApi(api_client).test_source_connection_multihost(multihost_id=multihost_id, source_id=source_id)
# Below is a request that includes all optional parameters
# results = MultiHostIntegrationApi(api_client).test_source_connection_multihost(multihost_id, source_id)
print("The response of MultiHostIntegrationApi->test_source_connection_multihost:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MultiHostIntegrationApi->test_source_connection_multihost: %s\n" % e)
- path: /multihosts/{multihostId}
method: PATCH
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/multi-host-integration#update-multi-host-sources
source: |
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.update_multi_host_sources_request_inner import UpdateMultiHostSourcesRequestInner
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multihost_id = 'anId' # str | ID of the Multi-Host Integration to update. # str | ID of the Multi-Host Integration to update.
update_multi_host_sources_request_inner = '''[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]''' # List[UpdateMultiHostSourcesRequestInner] | This endpoint allows you to update a Multi-Host Integration.
try:
# Update Multi-Host Integration
new_update_multi_host_sources_request_inner = UpdateMultiHostSourcesRequestInner.from_json(update_multi_host_sources_request_inner)
MultiHostIntegrationApi(api_client).update_multi_host_sources(multihost_id=multihost_id, update_multi_host_sources_request_inner=new_update_multi_host_sources_request_inner)
# Below is a request that includes all optional parameters
# MultiHostIntegrationApi(api_client).update_multi_host_sources(multihost_id, new_update_multi_host_sources_request_inner)
except Exception as e:
print("Exception when calling MultiHostIntegrationApi->update_multi_host_sources: %s\n" % e)
- path: /non-employee-approvals/{id}/approve
method: POST
xCodeSample:
@@ -17332,18 +17976,16 @@
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
id = 'id_example' # str | The Source id # str | The Source id
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
locale = 'locale_example' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional)
id = 'cef3ee201db947c5912551015ba0c679' # str | The Source id # str | The Source id
locale = 'en' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional)
try:
# Gets source config with language translations
# Gets source config with language-translations
results = SourcesApi(api_client).get_source_config(id=id, x_sail_point_experimental=x_sail_point_experimental)
results = SourcesApi(api_client).get_source_config(id=id)
# Below is a request that includes all optional parameters
# results = SourcesApi(api_client).get_source_config(id, x_sail_point_experimental, locale)
# results = SourcesApi(api_client).get_source_config(id, locale)
print("The response of SourcesApi->get_source_config:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
@@ -17720,38 +18362,6 @@
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling SourcesApi->list_sources: %s\n" % e)
- path: /sources/{sourceId}/connector/peek-resource-objects
method: POST
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/sources#peek-resource-objects
source: |
from sailpoint.v2024.api.sources_api import SourcesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.resource_objects_request import ResourceObjectsRequest
from sailpoint.v2024.models.resource_objects_response import ResourceObjectsResponse
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source
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')
resource_objects_request = '''{
"maxCount" : 100,
"objectType" : "group"
}''' # ResourceObjectsRequest |
try:
# Peek source connector's resource objects
new_resource_objects_request = ResourceObjectsRequest.from_json(resource_objects_request)
results = SourcesApi(api_client).peek_resource_objects(source_id=source_id, x_sail_point_experimental=x_sail_point_experimental, resource_objects_request=new_resource_objects_request)
# Below is a request that includes all optional parameters
# results = SourcesApi(api_client).peek_resource_objects(source_id, x_sail_point_experimental, new_resource_objects_request)
print("The response of SourcesApi->peek_resource_objects:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling SourcesApi->peek_resource_objects: %s\n" % e)
- path: /sources/{sourceId}/connector/ping-cluster
method: POST
xCodeSample:
@@ -17764,17 +18374,15 @@
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
try:
# Ping cluster for source connector
results = SourcesApi(api_client).ping_cluster(source_id=source_id, x_sail_point_experimental=x_sail_point_experimental)
results = SourcesApi(api_client).ping_cluster(source_id=source_id)
# Below is a request that includes all optional parameters
# results = SourcesApi(api_client).ping_cluster(source_id, x_sail_point_experimental)
# results = SourcesApi(api_client).ping_cluster(source_id)
print("The response of SourcesApi->ping_cluster:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
@@ -18107,6 +18715,36 @@
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling SourcesApi->put_source_schema: %s\n" % e)
- path: /sources/{sourceId}/connector/peek-resource-objects
method: POST
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/sources#search-resource-objects
source: |
from sailpoint.v2024.api.sources_api import SourcesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.resource_objects_request import ResourceObjectsRequest
from sailpoint.v2024.models.resource_objects_response import ResourceObjectsResponse
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source
resource_objects_request = '''{
"maxCount" : 100,
"objectType" : "group"
}''' # ResourceObjectsRequest |
try:
# Peek source connector's resource objects
new_resource_objects_request = ResourceObjectsRequest.from_json(resource_objects_request)
results = SourcesApi(api_client).search_resource_objects(source_id=source_id, resource_objects_request=new_resource_objects_request)
# Below is a request that includes all optional parameters
# results = SourcesApi(api_client).search_resource_objects(source_id, new_resource_objects_request)
print("The response of SourcesApi->search_resource_objects:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling SourcesApi->search_resource_objects: %s\n" % e)
- path: /sources/{id}/synchronize-attributes
method: POST
xCodeSample:
@@ -18146,17 +18784,15 @@
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
try:
# Test configuration for source connector
results = SourcesApi(api_client).test_source_configuration(source_id=source_id, x_sail_point_experimental=x_sail_point_experimental)
results = SourcesApi(api_client).test_source_configuration(source_id=source_id)
# Below is a request that includes all optional parameters
# results = SourcesApi(api_client).test_source_configuration(source_id, x_sail_point_experimental)
# results = SourcesApi(api_client).test_source_configuration(source_id)
print("The response of SourcesApi->test_source_configuration:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
@@ -18173,17 +18809,15 @@
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source. # str | The ID of the Source.
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
try:
# Check connection for source connector.
results = SourcesApi(api_client).test_source_connection(source_id=source_id, x_sail_point_experimental=x_sail_point_experimental)
results = SourcesApi(api_client).test_source_connection(source_id=source_id)
# Below is a request that includes all optional parameters
# results = SourcesApi(api_client).test_source_connection(source_id, x_sail_point_experimental)
# results = SourcesApi(api_client).test_source_connection(source_id)
print("The response of SourcesApi->test_source_connection:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: