Update python SDK docs: 15116515953

2025-12-08 12:27:47 +00:00 · 2025-05-19 15:05:01 +00:00
parent d73e77c393
commit c8938e0862
279 changed files with 7276 additions and 7276 deletions
--- a/docs/tools/sdk/python/Reference/Beta/Methods/MultiHostIntegrationApi.md
+++ b/docs/tools/sdk/python/Reference/Beta/Methods/MultiHostIntegrationApi.md
@@ -18,23 +18,23 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*

 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**create-multi-host-integration**](#create-multi-host-integration) | **POST** `/multihosts` | Create Multi-Host Integration
-[**create-sources-within-multi-host**](#create-sources-within-multi-host) | **POST** `/multihosts/{multihostId}` | Create Sources Within Multi-Host Integration
-[**delete-multi-host**](#delete-multi-host) | **DELETE** `/multihosts/{multihostId}` | Delete Multi-Host Integration
-[**get-acct-aggregation-groups**](#get-acct-aggregation-groups) | **GET** `/multihosts/{multihostId}/acctAggregationGroups` | Get Account Aggregation Groups Within Multi-Host Integration ID
-[**get-entitlement-aggregation-groups**](#get-entitlement-aggregation-groups) | **GET** `/multihosts/{multiHostId}/entitlementAggregationGroups` | Get Entitlement Aggregation Groups Within Multi-Host Integration ID
-[**get-multi-host-integrations**](#get-multi-host-integrations) | **GET** `/multihosts/{multihostId}` | Get Multi-Host Integration By ID
-[**get-multi-host-integrations-list**](#get-multi-host-integrations-list) | **GET** `/multihosts` | List All Existing Multi-Host Integrations
-[**get-multi-host-source-creation-errors**](#get-multi-host-source-creation-errors) | **GET** `/multihosts/{multiHostId}/sources/errors` | List Multi-Host Source Creation Errors
-[**get-multihost-integration-types**](#get-multihost-integration-types) | **GET** `/multihosts/types` | List Multi-Host Integration Types
-[**get-sources-within-multi-host**](#get-sources-within-multi-host) | **GET** `/multihosts/{multihostId}/sources` | List Sources Within Multi-Host Integration
-[**test-connection-multi-host-sources**](#test-connection-multi-host-sources) | **POST** `/multihosts/{multihostId}/sources/testConnection` | Test Configuration For Multi-Host Integration
-[**test-source-connection-multihost**](#test-source-connection-multihost) | **GET** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test Configuration For Multi-Host Integration&#39;s Single Source
-[**update-multi-host-sources**](#update-multi-host-sources) | **PATCH** `/multihosts/{multihostId}` | Update Multi-Host Integration
+[**create-multi-host-integration**](#create-multi-host-integration) | **POST** `/multihosts` | Create multi-host integration
+[**create-sources-within-multi-host**](#create-sources-within-multi-host) | **POST** `/multihosts/{multihostId}` | Create sources within multi-host integration
+[**delete-multi-host**](#delete-multi-host) | **DELETE** `/multihosts/{multihostId}` | Delete multi-host integration
+[**get-acct-aggregation-groups**](#get-acct-aggregation-groups) | **GET** `/multihosts/{multihostId}/acctAggregationGroups` | Get account aggregation groups within multi-host integration id
+[**get-entitlement-aggregation-groups**](#get-entitlement-aggregation-groups) | **GET** `/multihosts/{multiHostId}/entitlementAggregationGroups` | Get entitlement aggregation groups within multi-host integration id
+[**get-multi-host-integrations**](#get-multi-host-integrations) | **GET** `/multihosts/{multihostId}` | Get multi-host integration by id
+[**get-multi-host-integrations-list**](#get-multi-host-integrations-list) | **GET** `/multihosts` | List all existing multi-host integrations
+[**get-multi-host-source-creation-errors**](#get-multi-host-source-creation-errors) | **GET** `/multihosts/{multiHostId}/sources/errors` | List multi-host source creation errors
+[**get-multihost-integration-types**](#get-multihost-integration-types) | **GET** `/multihosts/types` | List multi-host integration types
+[**get-sources-within-multi-host**](#get-sources-within-multi-host) | **GET** `/multihosts/{multihostId}/sources` | List sources within multi-host integration
+[**test-connection-multi-host-sources**](#test-connection-multi-host-sources) | **POST** `/multihosts/{multihostId}/sources/testConnection` | Test configuration for multi-host integration
+[**test-source-connection-multihost**](#test-source-connection-multihost) | **GET** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test configuration for multi-host integration&#39;s single source
+[**update-multi-host-sources**](#update-multi-host-sources) | **PATCH** `/multihosts/{multihostId}` | Update multi-host integration


 ## create-multi-host-integration
-Create Multi-Host Integration
+Create multi-host integration
 This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources.

 A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -105,7 +105,7 @@ with ApiClient(configuration) as api_client:
        }''' # MultiHostIntegrationsCreate | The specifics of the Multi-Host Integration to create

    try:
-        # Create Multi-Host Integration
+        # Create multi-host integration
        new_multi_host_integrations_create = MultiHostIntegrationsCreate.from_json(multi_host_integrations_create)
        results = MultiHostIntegrationApi(api_client).create_multi_host_integration(multi_host_integrations_create=new_multi_host_integrations_create)
        # Below is a request that includes all optional parameters
@@ -121,7 +121,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## create-sources-within-multi-host
-Create Sources Within Multi-Host Integration
+Create sources within multi-host integration
 This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources.

 A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -168,7 +168,7 @@ with ApiClient(configuration) as api_client:
    multi_host_integrations_create_sources = '''[sailpoint.beta.MultiHostIntegrationsCreateSources()]''' # List[MultiHostIntegrationsCreateSources] | The specifics of the sources to create within Multi-Host Integration.

    try:
-        # Create Sources Within Multi-Host Integration
+        # Create sources within multi-host integration
        new_multi_host_integrations_create_sources = MultiHostIntegrationsCreateSources.from_json(multi_host_integrations_create_sources)
        MultiHostIntegrationApi(api_client).create_sources_within_multi_host(multihost_id=multihost_id, multi_host_integrations_create_sources=new_multi_host_integrations_create_sources)
        # Below is a request that includes all optional parameters
@@ -182,7 +182,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## delete-multi-host
-Delete Multi-Host Integration
+Delete multi-host integration
 Delete an existing Multi-Host Integration by ID.  

 A token with Org Admin or Multi Host Admin authority is required to access this endpoint.
@@ -226,7 +226,7 @@ with ApiClient(configuration) as api_client:
    multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of Multi-Host Integration to delete. # str | ID of Multi-Host Integration to delete.

    try:
-        # Delete Multi-Host Integration
+        # Delete multi-host integration
        
        MultiHostIntegrationApi(api_client).delete_multi_host(multihost_id=multihost_id)
        # Below is a request that includes all optional parameters
@@ -240,7 +240,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## get-acct-aggregation-groups
-Get Account Aggregation Groups Within Multi-Host Integration ID
+Get account aggregation groups within multi-host integration id
 This API will return array of account aggregation groups within provided Multi-Host Integration ID.

 A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -285,7 +285,7 @@ with ApiClient(configuration) as api_client:
    multihost_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update

    try:
-        # Get Account Aggregation Groups Within Multi-Host Integration ID
+        # Get account aggregation groups within multi-host integration id
        
        results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id=multihost_id)
        # Below is a request that includes all optional parameters
@@ -301,7 +301,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## get-entitlement-aggregation-groups
-Get Entitlement Aggregation Groups Within Multi-Host Integration ID
+Get entitlement aggregation groups within multi-host integration id
 This API will return array of aggregation groups within provided Multi-Host Integration ID.  

 A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -346,7 +346,7 @@ with ApiClient(configuration) as api_client:
    multi_host_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update

    try:
-        # Get Entitlement Aggregation Groups Within Multi-Host Integration ID
+        # Get entitlement aggregation groups within multi-host integration id
        
        results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id=multi_host_id)
        # Below is a request that includes all optional parameters
@@ -362,7 +362,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## get-multi-host-integrations
-Get Multi-Host Integration By ID
+Get multi-host integration by id
 Get an existing Multi-Host Integration. 

 A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint.
@@ -407,7 +407,7 @@ with ApiClient(configuration) as api_client:
    multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration. # str | ID of the Multi-Host Integration.

    try:
-        # Get Multi-Host Integration By ID
+        # Get multi-host integration by id
        
        results = MultiHostIntegrationApi(api_client).get_multi_host_integrations(multihost_id=multihost_id)
        # Below is a request that includes all optional parameters
@@ -423,7 +423,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## get-multi-host-integrations-list
-List All Existing Multi-Host Integrations
+List all existing multi-host integrations
 Get a list of Multi-Host Integrations.  

 A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -478,7 +478,7 @@ with ApiClient(configuration) as api_client:
    for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity.  The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID.  A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity.  The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID.  A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional)

    try:
-        # List All Existing Multi-Host Integrations
+        # List all existing multi-host integrations
        
        results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list()
        # Below is a request that includes all optional parameters
@@ -495,7 +495,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## get-multi-host-source-creation-errors
-List Multi-Host Source Creation Errors
+List multi-host source creation errors
 Get a list of sources creation errors within Multi-Host Integration ID.  

 A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -540,7 +540,7 @@ with ApiClient(configuration) as api_client:
    multi_host_id = '004091cb79b04636b88662afa50a4440' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration

    try:
-        # List Multi-Host Source Creation Errors
+        # List multi-host source creation errors
        
        results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id=multi_host_id)
        # Below is a request that includes all optional parameters
@@ -557,7 +557,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## get-multihost-integration-types
-List Multi-Host Integration Types
+List multi-host integration types
 This API endpoint returns the current list of supported Multi-Host Integration types.  

 A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -598,7 +598,7 @@ configuration = Configuration()
 with ApiClient(configuration) as api_client:

    try:
-        # List Multi-Host Integration Types
+        # List multi-host integration types
        
        results = MultiHostIntegrationApi(api_client).get_multihost_integration_types()
        # Below is a request that includes all optional parameters
@@ -615,7 +615,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## get-sources-within-multi-host
-List Sources Within Multi-Host Integration
+List sources within multi-host integration
 Get a list of sources within Multi-Host Integration ID.  

 A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -670,7 +670,7 @@ with ApiClient(configuration) as api_client:
    count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)

    try:
-        # List Sources Within Multi-Host Integration
+        # List sources within multi-host integration
        
        results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id=multihost_id)
        # Below is a request that includes all optional parameters
@@ -687,7 +687,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## test-connection-multi-host-sources
-Test Configuration For Multi-Host Integration
+Test configuration for multi-host integration
 This endpoint performs a more detailed validation of the Multi-Host Integration's configuration.

 A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -731,7 +731,7 @@ with ApiClient(configuration) as api_client:
    multihost_id = '2c91808568c529c60168cca6f90c1324' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration

    try:
-        # Test Configuration For Multi-Host Integration
+        # Test configuration for multi-host integration
        
        MultiHostIntegrationApi(api_client).test_connection_multi_host_sources(multihost_id=multihost_id)
        # Below is a request that includes all optional parameters
@@ -745,7 +745,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## test-source-connection-multihost
-Test Configuration For Multi-Host Integration's Single Source
+Test configuration for multi-host integration's single source
 This endpoint performs a more detailed validation of the source's configuration.  

 A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -792,7 +792,7 @@ with ApiClient(configuration) as api_client:
    source_id = '2c91808568c529f60168cca6f90c1324' # str | ID of the source within the Multi-Host Integration # str | ID of the source within the Multi-Host Integration

    try:
-        # Test Configuration For Multi-Host Integration's Single Source
+        # Test configuration for multi-host integration's single source
        
        results = MultiHostIntegrationApi(api_client).test_source_connection_multihost(multihost_id=multihost_id, source_id=source_id)
        # Below is a request that includes all optional parameters
@@ -808,7 +808,7 @@ with ApiClient(configuration) as api_client:
 [[Back to top]](#) 

 ## update-multi-host-sources
-Update Multi-Host Integration
+Update multi-host integration
 Update existing sources within Multi-Host Integration.

 A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.
@@ -855,7 +855,7 @@ with ApiClient(configuration) as api_client:
    update_multi_host_sources_request_inner = '''[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]''' # List[UpdateMultiHostSourcesRequestInner] | This endpoint allows you to update a Multi-Host Integration. 

    try:
-        # Update Multi-Host Integration
+        # Update multi-host integration
        new_update_multi_host_sources_request_inner = UpdateMultiHostSourcesRequestInner.from_json(update_multi_host_sources_request_inner)
        MultiHostIntegrationApi(api_client).update_multi_host_sources(multihost_id=multihost_id, update_multi_host_sources_request_inner=new_update_multi_host_sources_request_inner)
        # Below is a request that includes all optional parameters