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

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-12 19:41:45 +00:00
parent 184517209d
commit 113200f5fe
221 changed files with 8723 additions and 7883 deletions
Download Patch File Download Diff File Expand all files Collapse all files

124
docs/tools/sdk/python/Reference/V2024/Methods/ConfigurationHubApi.md
View File

@@ -76,7 +76,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.deploy_request import DeployRequest
@@ -85,21 +84,21 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
deploy_request = {
deploy_request = '''{
"draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b"
} # DeployRequest | The deploy request body.
}''' # DeployRequest | The deploy request body.
try:
# Create a Deploy
new_deploy_request = DeployRequest()
new_deploy_request.from_json(deploy_request)
results =ConfigurationHubApi(api_client).create_deploy(new_deploy_request)
new_deploy_request = DeployRequest.from_json(deploy_request)
results = ConfigurationHubApi(api_client).create_deploy(deploy_request=new_deploy_request)
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).create_deploy(new_deploy_request)
print("The response of ConfigurationHubApi->create_deploy:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConfigurationHubApi->create_deploy: %s\n" % e)
```
@@ -144,7 +143,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.object_mapping_request import ObjectMappingRequest
@@ -153,26 +151,26 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_org = 'source-org' # str | The name of the source org. # str | The name of the source org.
object_mapping_request = {
object_mapping_request = '''{
"targetValue" : "My New Governance Group Name",
"jsonPath" : "$.name",
"sourceValue" : "My Governance Group Name",
"enabled" : false,
"objectType" : "IDENTITY"
} # ObjectMappingRequest | The object mapping request body.
}''' # ObjectMappingRequest | The object mapping request body.
try:
# Creates an object mapping
new_object_mapping_request = ObjectMappingRequest()
new_object_mapping_request.from_json(object_mapping_request)
results =ConfigurationHubApi(api_client).create_object_mapping(source_org, new_object_mapping_request)
new_object_mapping_request = ObjectMappingRequest.from_json(object_mapping_request)
results = ConfigurationHubApi(api_client).create_object_mapping(source_org=source_org, object_mapping_request=new_object_mapping_request)
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).create_object_mapping(source_org, new_object_mapping_request)
print("The response of ConfigurationHubApi->create_object_mapping:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConfigurationHubApi->create_object_mapping: %s\n" % e)
```
@@ -217,7 +215,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.object_mapping_bulk_create_request import ObjectMappingBulkCreateRequest
@@ -226,9 +223,10 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_org = 'source-org' # str | The name of the source org. # str | The name of the source org.
object_mapping_bulk_create_request = {
object_mapping_bulk_create_request = '''{
"newObjectsMappings" : [ {
"targetValue" : "My New Governance Group Name",
"jsonPath" : "$.name",
@@ -242,18 +240,17 @@ with ApiClient(configuration) as api_client:
"enabled" : false,
"objectType" : "IDENTITY"
} ]
} # ObjectMappingBulkCreateRequest | The bulk create object mapping request body.
}''' # ObjectMappingBulkCreateRequest | The bulk create object mapping request body.
try:
# Bulk creates object mappings
new_object_mapping_bulk_create_request = ObjectMappingBulkCreateRequest()
new_object_mapping_bulk_create_request.from_json(object_mapping_bulk_create_request)
results =ConfigurationHubApi(api_client).create_object_mappings(source_org, new_object_mapping_bulk_create_request)
new_object_mapping_bulk_create_request = ObjectMappingBulkCreateRequest.from_json(object_mapping_bulk_create_request)
results = ConfigurationHubApi(api_client).create_object_mappings(source_org=source_org, object_mapping_bulk_create_request=new_object_mapping_bulk_create_request)
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).create_object_mappings(source_org, new_object_mapping_bulk_create_request)
print("The response of ConfigurationHubApi->create_object_mappings:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConfigurationHubApi->create_object_mappings: %s\n" % e)
```
@@ -298,7 +295,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.backup_response import BackupResponse
@@ -306,6 +302,7 @@ 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.
name = 'name_example' # str | Name that will be assigned to the uploaded configuration file. # str | Name that will be assigned to the uploaded configuration file.
@@ -313,12 +310,12 @@ with ApiClient(configuration) as api_client:
try:
# Upload a Configuration
results =ConfigurationHubApi(api_client).create_uploaded_configuration(data, name)
results = ConfigurationHubApi(api_client).create_uploaded_configuration(data=data, name=name)
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).create_uploaded_configuration(data, name)
print("The response of ConfigurationHubApi->create_uploaded_configuration:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConfigurationHubApi->create_uploaded_configuration: %s\n" % e)
```
@@ -363,23 +360,23 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
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 = '07659d7d-2cce-47c0-9e49-185787ee565a' # str | The id of the backup to delete. # str | The id of the backup to delete.
try:
# Delete a Backup
ConfigurationHubApi(api_client).delete_backup(id)
ConfigurationHubApi(api_client).delete_backup(id=id)
# Below is a request that includes all optional parameters
# ConfigurationHubApi(api_client).delete_backup(id)
except Exception as e:
except Exception as e:
print("Exception when calling ConfigurationHubApi->delete_backup: %s\n" % e)
```
@@ -424,23 +421,23 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
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 = '07659d7d-2cce-47c0-9e49-185787ee565a' # str | The id of the draft to delete. # str | The id of the draft to delete.
try:
# Delete a draft
ConfigurationHubApi(api_client).delete_draft(id)
ConfigurationHubApi(api_client).delete_draft(id=id)
# Below is a request that includes all optional parameters
# ConfigurationHubApi(api_client).delete_draft(id)
except Exception as e:
except Exception as e:
print("Exception when calling ConfigurationHubApi->delete_draft: %s\n" % e)
```
@@ -485,13 +482,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_org = 'source-org' # str | The name of the source org. # str | The name of the source org.
object_mapping_id = '3d6e0144-963f-4bd6-8d8d-d77b4e507ce4' # str | The id of the object mapping to be deleted. # str | The id of the object mapping to be deleted.
@@ -499,10 +496,10 @@ with ApiClient(configuration) as api_client:
try:
# Deletes an object mapping
ConfigurationHubApi(api_client).delete_object_mapping(source_org, object_mapping_id)
ConfigurationHubApi(api_client).delete_object_mapping(source_org=source_org, object_mapping_id=object_mapping_id)
# Below is a request that includes all optional parameters
# ConfigurationHubApi(api_client).delete_object_mapping(source_org, object_mapping_id)
except Exception as e:
except Exception as e:
print("Exception when calling ConfigurationHubApi->delete_object_mapping: %s\n" % e)
```
@@ -547,23 +544,23 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
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 = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b' # str | The id of the uploaded configuration. # str | The id of the uploaded configuration.
try:
# Delete an Uploaded Configuration
ConfigurationHubApi(api_client).delete_uploaded_configuration(id)
ConfigurationHubApi(api_client).delete_uploaded_configuration(id=id)
# Below is a request that includes all optional parameters
# ConfigurationHubApi(api_client).delete_uploaded_configuration(id)
except Exception as e:
except Exception as e:
print("Exception when calling ConfigurationHubApi->delete_uploaded_configuration: %s\n" % e)
```
@@ -604,7 +601,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.deploy_response import DeployResponse
@@ -612,18 +608,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b' # str | The id of the deploy. # str | The id of the deploy.
try:
# Get a Deploy
results =ConfigurationHubApi(api_client).get_deploy(id)
results = ConfigurationHubApi(api_client).get_deploy(id=id)
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).get_deploy(id)
print("The response of ConfigurationHubApi->get_deploy:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConfigurationHubApi->get_deploy: %s\n" % e)
```
@@ -667,7 +664,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.object_mapping_response import ObjectMappingResponse
@@ -675,18 +671,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_org = 'source-org' # str | The name of the source org. # str | The name of the source org.
try:
# Gets list of object mappings
results =ConfigurationHubApi(api_client).get_object_mappings(source_org)
results = ConfigurationHubApi(api_client).get_object_mappings(source_org=source_org)
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).get_object_mappings(source_org)
print("The response of ConfigurationHubApi->get_object_mappings:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e)
```
@@ -727,7 +724,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.backup_response import BackupResponse
@@ -735,18 +731,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b' # str | The id of the uploaded configuration. # str | The id of the uploaded configuration.
try:
# Get an Uploaded Configuration
results =ConfigurationHubApi(api_client).get_uploaded_configuration(id)
results = ConfigurationHubApi(api_client).get_uploaded_configuration(id=id)
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).get_uploaded_configuration(id)
print("The response of ConfigurationHubApi->get_uploaded_configuration:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConfigurationHubApi->get_uploaded_configuration: %s\n" % e)
```
@@ -786,7 +783,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.backup_response import BackupResponse
@@ -794,18 +790,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
filters = 'status eq \"COMPLETE\"' # 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: **status**: *eq* (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: **status**: *eq* (optional)
try:
# List Backups
results =ConfigurationHubApi(api_client).list_backups()
results = ConfigurationHubApi(api_client).list_backups()
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).list_backups(filters)
print("The response of ConfigurationHubApi->list_backups:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConfigurationHubApi->list_backups: %s\n" % e)
```
@@ -842,7 +839,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.list_deploys200_response import ListDeploys200Response
@@ -850,17 +846,18 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Deploys
results =ConfigurationHubApi(api_client).list_deploys()
results = ConfigurationHubApi(api_client).list_deploys()
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).list_deploys()
print("The response of ConfigurationHubApi->list_deploys:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConfigurationHubApi->list_deploys: %s\n" % e)
```
@@ -900,7 +897,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.draft_response import DraftResponse
@@ -908,18 +904,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
filters = 'status eq \"COMPLETE\"' # 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: **status**: *eq* **approvalStatus**: *eq* (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: **status**: *eq* **approvalStatus**: *eq* (optional)
try:
# List Drafts
results =ConfigurationHubApi(api_client).list_drafts()
results = ConfigurationHubApi(api_client).list_drafts()
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).list_drafts(filters)
print("The response of ConfigurationHubApi->list_drafts:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConfigurationHubApi->list_drafts: %s\n" % e)
```
@@ -960,7 +957,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.backup_response import BackupResponse
@@ -968,18 +964,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
filters = 'status eq \"COMPLETE\"' # 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: **status**: *eq* (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: **status**: *eq* (optional)
try:
# List Uploaded Configurations
results =ConfigurationHubApi(api_client).list_uploaded_configurations()
results = ConfigurationHubApi(api_client).list_uploaded_configurations()
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).list_uploaded_configurations(filters)
print("The response of ConfigurationHubApi->list_uploaded_configurations:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e)
```
@@ -1024,7 +1021,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.object_mapping_bulk_patch_request import ObjectMappingBulkPatchRequest
@@ -1033,9 +1029,10 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_org = 'source-org' # str | The name of the source org. # str | The name of the source org.
object_mapping_bulk_patch_request = {
object_mapping_bulk_patch_request = '''{
"patches" : {
"603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ {
"op" : "replace",
@@ -1048,18 +1045,17 @@ with ApiClient(configuration) as api_client:
"value" : "New Target Value"
} ]
}
} # ObjectMappingBulkPatchRequest | The object mapping request body.
}''' # ObjectMappingBulkPatchRequest | The object mapping request body.
try:
# Bulk updates object mappings
new_object_mapping_bulk_patch_request = ObjectMappingBulkPatchRequest()
new_object_mapping_bulk_patch_request.from_json(object_mapping_bulk_patch_request)
results =ConfigurationHubApi(api_client).update_object_mappings(source_org, new_object_mapping_bulk_patch_request)
new_object_mapping_bulk_patch_request = ObjectMappingBulkPatchRequest.from_json(object_mapping_bulk_patch_request)
results = ConfigurationHubApi(api_client).update_object_mappings(source_org=source_org, object_mapping_bulk_patch_request=new_object_mapping_bulk_patch_request)
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).update_object_mappings(source_org, new_object_mapping_bulk_patch_request)
print("The response of ConfigurationHubApi->update_object_mappings:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConfigurationHubApi->update_object_mappings: %s\n" % e)
```