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

update layout for method examples

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

115
docs/tools/sdk/python/Reference/V2024/Methods/SIMIntegrationsApi.md
View File

@@ -69,11 +69,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
sim_integration_details = {
"cluster" : "xyzzy999",
@@ -96,14 +100,14 @@ from pprint import pprint
try:
# Create new SIM integration
Result = sim_integration_details.from_json(sim_integration_details)
api_response = api_instance.create_sim_integration(x_sail_point_experimental, Result)
new_sim_integration_details = SimIntegrationDetails()
new_sim_integration_details.from_json(sim_integration_details)
results =SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_sim_integration(x_sail_point_experimental, Result)
# results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details)
print("The response of SIMIntegrationsApi->create_sim_integration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e)
```
@@ -149,20 +153,23 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '12345' # str | The id of the integration to delete. # str | The id of the integration 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 a SIM integration
api_instance.delete_sim_integration(id, x_sail_point_experimental)
SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_instance.delete_sim_integration(id, x_sail_point_experimental)
except Exception as e:
# SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental)
except Exception as e:
print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e)
```
@@ -208,23 +215,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '12345' # str | The id of the integration. # str | The id of the integration.
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 a SIM integration details.
api_response = api_instance.get_sim_integration(id, x_sail_point_experimental)
results =SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sim_integration(id, x_sail_point_experimental)
# results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental)
print("The response of SIMIntegrationsApi->get_sim_integration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e)
```
@@ -269,22 +279,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
try:
# List the existing SIM integrations.
api_response = api_instance.get_sim_integrations(x_sail_point_experimental)
results =SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sim_integrations(x_sail_point_experimental)
# results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental)
print("The response of SIMIntegrationsApi->get_sim_integrations:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e)
```
@@ -331,25 +344,29 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch import JsonPatch
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '12345' # str | SIM integration id # str | SIM integration 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')
json_patch = "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule.
try:
# Patch a SIM beforeProvisioningRule attribute.
Result = json_patch.from_json(json_patch)
api_response = api_instance.patch_before_provisioning_rule(id, x_sail_point_experimental, Result)
new_json_patch = JsonPatch()
new_json_patch.from_json(json_patch)
results =SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_before_provisioning_rule(id, x_sail_point_experimental, Result)
# results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch)
print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e)
```
@@ -396,25 +413,29 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch import JsonPatch
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '12345' # str | SIM integration id # str | SIM integration 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')
json_patch = "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" # JsonPatch | The JsonPatch object that describes the changes of SIM
try:
# Patch a SIM attribute.
Result = json_patch.from_json(json_patch)
api_response = api_instance.patch_sim_attributes(id, x_sail_point_experimental, Result)
new_json_patch = JsonPatch()
new_json_patch.from_json(json_patch)
results =SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_sim_attributes(id, x_sail_point_experimental, Result)
# results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch)
print("The response of SIMIntegrationsApi->patch_sim_attributes:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e)
```
@@ -461,11 +482,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '12345' # str | The id of the integration. # str | The id of the integration.
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')
sim_integration_details = {
@@ -489,14 +514,14 @@ from pprint import pprint
try:
# Update an existing SIM integration
Result = sim_integration_details.from_json(sim_integration_details)
api_response = api_instance.put_sim_integration(id, x_sail_point_experimental, Result)
new_sim_integration_details = SimIntegrationDetails()
new_sim_integration_details.from_json(sim_integration_details)
results =SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_sim_integration(id, x_sail_point_experimental, Result)
# results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details)
print("The response of SIMIntegrationsApi->put_sim_integration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e)
```