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: 14756983852

Browse Source
This commit is contained in:
developer-relations-sp
2025-04-30 14:26:13 +00:00
parent cbe4076092
commit e9f62a9cd9
13 changed files with 48 additions and 220 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/tools/sdk/python/Reference/V2025/Methods/ServiceDeskIntegrationApi.md
View File

@@ -507,7 +507,7 @@ Update an existing Service Desk integration by ID with a PATCH request.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | ID of the Service Desk integration to update
Body | patch_service_desk_integration_request | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed.
Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed.
### Return type
[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto)
@@ -532,7 +532,7 @@ Code | Description | Data Type | Response headers |
```python
from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest
from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation
from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -540,14 +540,14 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update
patch_service_desk_integration_request = '''sailpoint.v2025.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed.
json_patch_operation = '''[sailpoint.v2025.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed.
try:
# Patch a Service Desk Integration
new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request)
results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request)
# results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_json_patch_operation)
print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:

18
docs/tools/sdk/python/Reference/V2025/Methods/SourcesApi.md
View File

@@ -1826,17 +1826,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## import-accounts
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Account Aggregation
Starts an account aggregation on the specified source.
If the target source is a delimited file source, then the CSV file needs to be included in the request body.
@@ -1849,7 +1838,6 @@ You will also need to set the Content-Type header to `multipart/form-data`.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Source Id
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
| file | **bytearray** | (optional) | The CSV file containing the source accounts to aggregate.
| disable_optimization | **str** | (optional) | Use this flag to reprocess every account whether or not the data has changed.
@@ -1879,20 +1867,18 @@ from sailpoint.v2025.models.load_accounts_task import LoadAccountsTask
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | 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')
file = None # bytearray | The CSV file containing the source accounts to aggregate. (optional) # bytearray | The CSV file containing the source accounts to aggregate. (optional)
disable_optimization = 'disable_optimization_example' # str | Use this flag to reprocess every account whether or not the data has changed. (optional) # str | Use this flag to reprocess every account whether or not the data has changed. (optional)
try:
# Account Aggregation
results = SourcesApi(api_client).import_accounts(id=id, x_sail_point_experimental=x_sail_point_experimental)
results = SourcesApi(api_client).import_accounts(id=id)
# Below is a request that includes all optional parameters
# results = SourcesApi(api_client).import_accounts(id, x_sail_point_experimental, file, disable_optimization)
# results = SourcesApi(api_client).import_accounts(id, file, disable_optimization)
print("The response of SourcesApi->import_accounts:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: