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

merge changes from main and pull the latest from python docs

Browse Source
This commit is contained in:
darrell-thobe-sp
2025-03-10 11:34:32 -04:00
parent 6f7d1983fd 8c3bd4fe6f
commit 340c9bb8cd
3122 changed files with 95404 additions and 24060 deletions
Download Patch File Download Diff File Expand all files Collapse all files

89
docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md
View File

@@ -25,9 +25,6 @@ Method | HTTP request | Description
## export-sp-config
:::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.
:::
Initiates configuration objects export job
This post will export objects from the tenant to a JSON configuration file.
For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
@@ -38,7 +35,6 @@ For more information about the object types that currently support export functi
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
Body | export_payload | [**ExportPayload**](../models/export-payload) | True | Export options control what will be included in the export.
### Return type
@@ -72,7 +68,6 @@ 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')
export_payload = {
"description" : "Export Job 1 Test"
} # ExportPayload | Export options control what will be included in the export.
@@ -81,9 +76,9 @@ with ApiClient(configuration) as api_client:
# Initiates configuration objects export job
new_export_payload = ExportPayload()
new_export_payload.from_json(export_payload)
results =SPConfigApi(api_client).export_sp_config(x_sail_point_experimental, new_export_payload)
results =SPConfigApi(api_client).export_sp_config(new_export_payload)
# Below is a request that includes all optional parameters
# results = SPConfigApi(api_client).export_sp_config(x_sail_point_experimental, new_export_payload)
# results = SPConfigApi(api_client).export_sp_config(new_export_payload)
print("The response of SPConfigApi->export_sp_config:\n")
pprint(results)
except Exception as e:
@@ -95,9 +90,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-sp-config-export
:::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.
:::
Download export job result.
This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file.
The request will need one of the following security scopes:
@@ -110,7 +102,6 @@ The request will need one of the following security scopes:
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | The ID of the export job whose results will be downloaded.
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
### Return type
[**SpConfigExportResults**](../models/sp-config-export-results)
@@ -143,14 +134,13 @@ 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.
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:
# Download export job result.
results =SPConfigApi(api_client).get_sp_config_export(id, x_sail_point_experimental)
results =SPConfigApi(api_client).get_sp_config_export(id)
# Below is a request that includes all optional parameters
# results = SPConfigApi(api_client).get_sp_config_export(id, x_sail_point_experimental)
# results = SPConfigApi(api_client).get_sp_config_export(id)
print("The response of SPConfigApi->get_sp_config_export:\n")
pprint(results)
except Exception as e:
@@ -162,9 +152,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-sp-config-export-status
:::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.
:::
Get export job status
This gets the status of the export job identified by the `id` parameter.
The request will need one of the following security scopes:
@@ -177,7 +164,6 @@ The request will need one of the following security scopes:
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | The ID of the export job whose status will be returned.
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
### Return type
[**SpConfigExportJobStatus**](../models/sp-config-export-job-status)
@@ -210,14 +196,13 @@ 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.
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 export job status
results =SPConfigApi(api_client).get_sp_config_export_status(id, x_sail_point_experimental)
results =SPConfigApi(api_client).get_sp_config_export_status(id)
# Below is a request that includes all optional parameters
# results = SPConfigApi(api_client).get_sp_config_export_status(id, x_sail_point_experimental)
# results = SPConfigApi(api_client).get_sp_config_export_status(id)
print("The response of SPConfigApi->get_sp_config_export_status:\n")
pprint(results)
except Exception as e:
@@ -229,9 +214,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-sp-config-import
:::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.
:::
Download import job result
This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import.
The request will need the following security scope:
@@ -244,7 +226,6 @@ The request will need the following security scope:
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | The ID of the import job whose results will be downloaded.
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
### Return type
[**SpConfigImportResults**](../models/sp-config-import-results)
@@ -277,14 +258,13 @@ 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.
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:
# Download import job result
results =SPConfigApi(api_client).get_sp_config_import(id, x_sail_point_experimental)
results =SPConfigApi(api_client).get_sp_config_import(id)
# Below is a request that includes all optional parameters
# results = SPConfigApi(api_client).get_sp_config_import(id, x_sail_point_experimental)
# results = SPConfigApi(api_client).get_sp_config_import(id)
print("The response of SPConfigApi->get_sp_config_import:\n")
pprint(results)
except Exception as e:
@@ -296,9 +276,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-sp-config-import-status
:::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.
:::
Get import job status
'This gets the status of the import job identified by the `id` parameter.
@@ -313,7 +290,6 @@ Get import job status
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | The ID of the import job whose status will be returned.
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
### Return type
[**SpConfigImportJobStatus**](../models/sp-config-import-job-status)
@@ -346,14 +322,13 @@ 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.
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 import job status
results =SPConfigApi(api_client).get_sp_config_import_status(id, x_sail_point_experimental)
results =SPConfigApi(api_client).get_sp_config_import_status(id)
# Below is a request that includes all optional parameters
# results = SPConfigApi(api_client).get_sp_config_import_status(id, x_sail_point_experimental)
# results = SPConfigApi(api_client).get_sp_config_import_status(id)
print("The response of SPConfigApi->get_sp_config_import_status:\n")
pprint(results)
except Exception as e:
@@ -365,22 +340,17 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## import-sp-config
:::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.
:::
Initiates configuration objects import job
"This post will import objects from a JSON configuration file into\
\ a tenant. By default, every import will first export all existing objects supported\
\ by sp-config as a backup before the import is attempted. The backup is provided\
\ so that the state of the configuration prior to the import is available for\
\ inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\"\
\ to true in the import options. If a backup is performed, the id of the backup\
\ will be provided in the ImportResult as the \"exportJobId\". This can be downloaded\
\ using the `/sp-config/export/{exportJobId}/download` endpoint.\nYou cannot currently\
\ import from the Non-Employee Lifecycle Management (NELM) source. You cannot\
\ use this endpoint to back up or store NELM data. \nFor more information about\
\ the object types that currently support import functionality, refer to [SaaS\
\ Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects)."
This post will import objects from a JSON configuration file into a tenant.
By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted.
The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed.
The backup can be skipped by setting "excludeBackup" to true in the import options.
If a backup is performed, the id of the backup will be provided in the ImportResult as the "exportJobId". This can be downloaded
using the `/sp-config/export/{exportJobId}/download` endpoint.
You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data.
For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-sp-config)
@@ -389,7 +359,6 @@ Initiates configuration objects import job
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
| data | **bytearray** | True | JSON file containing the objects to be imported.
Query | preview | **bool** | (optional) (default to False) | 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.
| options | [**ImportOptions**](../models/import-options) | (optional) |
@@ -425,7 +394,6 @@ 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')
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.v2024.ImportOptions() # ImportOptions | (optional)
@@ -433,9 +401,9 @@ with ApiClient(configuration) as api_client:
try:
# Initiates configuration objects import job
results =SPConfigApi(api_client).import_sp_config(x_sail_point_experimental, data, )
results =SPConfigApi(api_client).import_sp_config(data, )
# Below is a request that includes all optional parameters
# results = SPConfigApi(api_client).import_sp_config(x_sail_point_experimental, data, preview, options)
# results = SPConfigApi(api_client).import_sp_config(data, preview, options)
print("The response of SPConfigApi->import_sp_config:\n")
pprint(results)
except Exception as e:
@@ -447,19 +415,13 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-sp-config-objects
:::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.
:::
Get config object details
This gets the list of object configurations which are known to the tenant export/import service. Object configurations that contain "importUrl" and "exportUrl" are available for export/import.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-sp-config-objects)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
This endpoint does not need any parameter.
### Return type
[**List[SpConfigObject]**](../models/sp-config-object)
@@ -491,14 +453,13 @@ 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:
# Get config object details
results =SPConfigApi(api_client).list_sp_config_objects(x_sail_point_experimental)
results =SPConfigApi(api_client).list_sp_config_objects()
# Below is a request that includes all optional parameters
# results = SPConfigApi(api_client).list_sp_config_objects(x_sail_point_experimental)
# results = SPConfigApi(api_client).list_sp_config_objects()
print("The response of SPConfigApi->list_sp_config_objects:\n")
pprint(results)
except Exception as e: