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

update 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

108
docs/tools/sdk/python/Reference/Beta/Methods/SPConfigApi.md
View File

@@ -59,25 +59,29 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.sp_config_api import SPConfigApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.export_payload import ExportPayload
from sailpoint.beta.models.sp_config_export_job import SpConfigExportJob
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
export_payload = {
"description" : "Export Job 1 Test"
} # ExportPayload | Export options control what will be included in the export.
try:
# Initiates configuration objects export job
Result = export_payload.from_json(export_payload)
api_response = api_instance.export_sp_config(Result)
new_export_payload = ExportPayload()
new_export_payload.from_json(export_payload)
results =SPConfigApi(api_client).export_sp_config(new_export_payload)
# Below is a request that includes all optional parameters
# api_response = api_instance.export_sp_config(Result)
# results = SPConfigApi(api_client).export_sp_config(new_export_payload)
print("The response of SPConfigApi->export_sp_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e)
```
@@ -121,22 +125,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.sp_config_api import SPConfigApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sp_config_export_results import SpConfigExportResults
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded.
try:
# Download export job result.
api_response = api_instance.get_sp_config_export(id)
results =SPConfigApi(api_client).get_sp_config_export(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sp_config_export(id)
# results = SPConfigApi(api_client).get_sp_config_export(id)
print("The response of SPConfigApi->get_sp_config_export:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e)
```
@@ -180,22 +187,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.sp_config_api import SPConfigApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sp_config_export_job_status import SpConfigExportJobStatus
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned.
try:
# Get export job status
api_response = api_instance.get_sp_config_export_status(id)
results =SPConfigApi(api_client).get_sp_config_export_status(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sp_config_export_status(id)
# results = SPConfigApi(api_client).get_sp_config_export_status(id)
print("The response of SPConfigApi->get_sp_config_export_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e)
```
@@ -239,22 +249,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.sp_config_api import SPConfigApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sp_config_import_results import SpConfigImportResults
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded.
try:
# Download import job result
api_response = api_instance.get_sp_config_import(id)
results =SPConfigApi(api_client).get_sp_config_import(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sp_config_import(id)
# results = SPConfigApi(api_client).get_sp_config_import(id)
print("The response of SPConfigApi->get_sp_config_import:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e)
```
@@ -297,22 +310,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.sp_config_api import SPConfigApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sp_config_import_job_status import SpConfigImportJobStatus
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned.
try:
# Get import job status
api_response = api_instance.get_sp_config_import_status(id)
results =SPConfigApi(api_client).get_sp_config_import_status(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sp_config_import_status(id)
# results = SPConfigApi(api_client).get_sp_config_import_status(id)
print("The response of SPConfigApi->get_sp_config_import_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e)
```
@@ -366,11 +382,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.sp_config_api import SPConfigApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.import_options import ImportOptions
from sailpoint.beta.models.sp_config_job import SpConfigJob
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported.
preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False)
options = sailpoint.beta.ImportOptions() # ImportOptions | (optional)
@@ -378,13 +398,12 @@ from pprint import pprint
try:
# Initiates configuration objects import job
api_response = api_instance.import_sp_config(data, )
results =SPConfigApi(api_client).import_sp_config(data, )
# Below is a request that includes all optional parameters
# api_response = api_instance.import_sp_config(data, preview, options)
# results = SPConfigApi(api_client).import_sp_config(data, preview, options)
print("The response of SPConfigApi->import_sp_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e)
```
@@ -423,21 +442,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.api.sp_config_api import SPConfigApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sp_config_object import SpConfigObject
from sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get config object details
api_response = api_instance.list_sp_config_objects()
results =SPConfigApi(api_client).list_sp_config_objects()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_sp_config_objects()
# results = SPConfigApi(api_client).list_sp_config_objects()
print("The response of SPConfigApi->list_sp_config_objects:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e)
```