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

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

@@ -77,25 +77,29 @@ Code | Description | Data Type | Response headers |
```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
from sailpoint.v2024.models.deploy_response import DeployResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
deploy_request = {
"draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b"
} # DeployRequest | The deploy request body.
try:
# Create a Deploy
Result = deploy_request.from_json(deploy_request)
api_response = api_instance.create_deploy(Result)
new_deploy_request = DeployRequest()
new_deploy_request.from_json(deploy_request)
results =ConfigurationHubApi(api_client).create_deploy(new_deploy_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_deploy(Result)
# results = ConfigurationHubApi(api_client).create_deploy(new_deploy_request)
print("The response of ConfigurationHubApi->create_deploy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->create_deploy: %s\n" % e)
```
@@ -141,11 +145,15 @@ Code | Description | Data Type | Response headers |
```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
from sailpoint.v2024.models.object_mapping_response import ObjectMappingResponse
from sailpoint.v2024.rest import ApiException
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 = {
"targetValue" : "My New Governance Group Name",
@@ -157,14 +165,14 @@ from pprint import pprint
try:
# Creates an object mapping
Result = object_mapping_request.from_json(object_mapping_request)
api_response = api_instance.create_object_mapping(source_org, Result)
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)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_object_mapping(source_org, Result)
# results = ConfigurationHubApi(api_client).create_object_mapping(source_org, new_object_mapping_request)
print("The response of ConfigurationHubApi->create_object_mapping:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->create_object_mapping: %s\n" % e)
```
@@ -210,11 +218,15 @@ Code | Description | Data Type | Response headers |
```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
from sailpoint.v2024.models.object_mapping_bulk_create_response import ObjectMappingBulkCreateResponse
from sailpoint.v2024.rest import ApiException
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 = {
"newObjectsMappings" : [ {
@@ -234,14 +246,14 @@ from pprint import pprint
try:
# Bulk creates object mappings
Result = object_mapping_bulk_create_request.from_json(object_mapping_bulk_create_request)
api_response = api_instance.create_object_mappings(source_org, Result)
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)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_object_mappings(source_org, Result)
# 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(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->create_object_mappings: %s\n" % e)
```
@@ -287,23 +299,26 @@ Code | Description | Data Type | Response headers |
```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
from sailpoint.v2024.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.
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.
try:
# Upload a Configuration
api_response = api_instance.create_uploaded_configuration(data, name)
results =ConfigurationHubApi(api_client).create_uploaded_configuration(data, name)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_uploaded_configuration(data, name)
# results = ConfigurationHubApi(api_client).create_uploaded_configuration(data, name)
print("The response of ConfigurationHubApi->create_uploaded_configuration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->create_uploaded_configuration: %s\n" % e)
```
@@ -349,19 +364,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
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
api_instance.delete_backup(id)
ConfigurationHubApi(api_client).delete_backup(id)
# Below is a request that includes all optional parameters
# api_instance.delete_backup(id)
except Exception as e:
# ConfigurationHubApi(api_client).delete_backup(id)
except Exception as e:
print("Exception when calling ConfigurationHubApi->delete_backup: %s\n" % e)
```
@@ -407,19 +425,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
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
api_instance.delete_draft(id)
ConfigurationHubApi(api_client).delete_draft(id)
# Below is a request that includes all optional parameters
# api_instance.delete_draft(id)
except Exception as e:
# ConfigurationHubApi(api_client).delete_draft(id)
except Exception as e:
print("Exception when calling ConfigurationHubApi->delete_draft: %s\n" % e)
```
@@ -465,20 +486,23 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
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.
try:
# Deletes an object mapping
api_instance.delete_object_mapping(source_org, object_mapping_id)
ConfigurationHubApi(api_client).delete_object_mapping(source_org, object_mapping_id)
# Below is a request that includes all optional parameters
# api_instance.delete_object_mapping(source_org, object_mapping_id)
except Exception as e:
# ConfigurationHubApi(api_client).delete_object_mapping(source_org, object_mapping_id)
except Exception as e:
print("Exception when calling ConfigurationHubApi->delete_object_mapping: %s\n" % e)
```
@@ -524,19 +548,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
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
api_instance.delete_uploaded_configuration(id)
ConfigurationHubApi(api_client).delete_uploaded_configuration(id)
# Below is a request that includes all optional parameters
# api_instance.delete_uploaded_configuration(id)
except Exception as e:
# ConfigurationHubApi(api_client).delete_uploaded_configuration(id)
except Exception as e:
print("Exception when calling ConfigurationHubApi->delete_uploaded_configuration: %s\n" % e)
```
@@ -578,22 +605,25 @@ Code | Description | Data Type | Response headers |
```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
from sailpoint.v2024.rest import ApiException
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
api_response = api_instance.get_deploy(id)
results =ConfigurationHubApi(api_client).get_deploy(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_deploy(id)
# results = ConfigurationHubApi(api_client).get_deploy(id)
print("The response of ConfigurationHubApi->get_deploy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->get_deploy: %s\n" % e)
```
@@ -638,22 +668,25 @@ Code | Description | Data Type | Response headers |
```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
from sailpoint.v2024.rest import ApiException
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
api_response = api_instance.get_object_mappings(source_org)
results =ConfigurationHubApi(api_client).get_object_mappings(source_org)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_object_mappings(source_org)
# results = ConfigurationHubApi(api_client).get_object_mappings(source_org)
print("The response of ConfigurationHubApi->get_object_mappings:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e)
```
@@ -695,22 +728,25 @@ Code | Description | Data Type | Response headers |
```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
from sailpoint.v2024.rest import ApiException
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
api_response = api_instance.get_uploaded_configuration(id)
results =ConfigurationHubApi(api_client).get_uploaded_configuration(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_uploaded_configuration(id)
# results = ConfigurationHubApi(api_client).get_uploaded_configuration(id)
print("The response of ConfigurationHubApi->get_uploaded_configuration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->get_uploaded_configuration: %s\n" % e)
```
@@ -751,22 +787,25 @@ Code | Description | Data Type | Response headers |
```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
from sailpoint.v2024.rest import ApiException
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
api_response = api_instance.list_backups()
results =ConfigurationHubApi(api_client).list_backups()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_backups(filters)
# results = ConfigurationHubApi(api_client).list_backups(filters)
print("The response of ConfigurationHubApi->list_backups:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->list_backups: %s\n" % e)
```
@@ -804,21 +843,24 @@ Code | Description | Data Type | Response headers |
```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
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Deploys
api_response = api_instance.list_deploys()
results =ConfigurationHubApi(api_client).list_deploys()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_deploys()
# results = ConfigurationHubApi(api_client).list_deploys()
print("The response of ConfigurationHubApi->list_deploys:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->list_deploys: %s\n" % e)
```
@@ -859,22 +901,25 @@ Code | Description | Data Type | Response headers |
```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
from sailpoint.v2024.rest import ApiException
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
api_response = api_instance.list_drafts()
results =ConfigurationHubApi(api_client).list_drafts()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_drafts(filters)
# results = ConfigurationHubApi(api_client).list_drafts(filters)
print("The response of ConfigurationHubApi->list_drafts:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->list_drafts: %s\n" % e)
```
@@ -916,22 +961,25 @@ Code | Description | Data Type | Response headers |
```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
from sailpoint.v2024.rest import ApiException
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
api_response = api_instance.list_uploaded_configurations()
results =ConfigurationHubApi(api_client).list_uploaded_configurations()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_uploaded_configurations(filters)
# results = ConfigurationHubApi(api_client).list_uploaded_configurations(filters)
print("The response of ConfigurationHubApi->list_uploaded_configurations:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e)
```
@@ -977,11 +1025,15 @@ Code | Description | Data Type | Response headers |
```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
from sailpoint.v2024.models.object_mapping_bulk_patch_response import ObjectMappingBulkPatchResponse
from sailpoint.v2024.rest import ApiException
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 = {
"patches" : {
@@ -1000,14 +1052,14 @@ from pprint import pprint
try:
# Bulk updates object mappings
Result = object_mapping_bulk_patch_request.from_json(object_mapping_bulk_patch_request)
api_response = api_instance.update_object_mappings(source_org, Result)
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)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_object_mappings(source_org, Result)
# 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(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->update_object_mappings: %s\n" % e)
```