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
Files
acdedd559cba5f1915b747bd1558131610aee01c
developer.sailpoint.com/docs/tools/sdk/python/Reference/Beta/Methods/MultiHostIntegrationApi.md
developer-relations-sp acdedd559c Update to python SDK docs: 14248105327
2025-04-03 16:31:58 +00:00

54 KiB
Raw Blame History

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags
id title pagination_label sidebar_label sidebar_class_name keywords slug tags
beta-multi-host-integration Multi_Host_Integration Multi_Host_Integration Multi_Host_Integration pythonsdk
python
Python
sdk
Multi_Host_Integration
BetaMulti_Host_Integration
/tools/sdk/python/beta/methods/multi-host-integration
SDK
Software Development Kit
Multi_Host_Integration
BetaMulti_Host_Integration

sailpoint.beta.MultiHostIntegrationApi

Use this API to build a Multi-Host Integration. Multi-Host Integration will help customers to configure and manage similar type of target system in Identity Security Cloud. In Identity Security Cloud, administrators can create a Multi-Host Integration by going to Admin > Connections > Multi-Host Sources and selecting 'Create.'

All URIs are relative to https://sailpoint.api.identitynow.com/beta

Method HTTP request Description
create-multi-host-integration POST /multihosts Create Multi-Host Integration
create-sources-within-multi-host POST /multihosts/{multihostId} Create Sources Within Multi-Host Integration
delete-multi-host DELETE /multihosts/{multihostId} Delete Multi-Host Integration
get-acct-aggregation-groups GET /multihosts/{multihostId}/acctAggregationGroups Get Account Aggregation Groups Within Multi-Host Integration ID
get-entitlement-aggregation-groups GET /multihosts/{multiHostId}/entitlementAggregationGroups Get Entitlement Aggregation Groups Within Multi-Host Integration ID
get-multi-host-integrations GET /multihosts/{multihostId} Get Multi-Host Integration By ID
get-multi-host-integrations-list GET /multihosts List All Existing Multi-Host Integrations
get-multi-host-source-creation-errors GET /multihosts/{multiHostId}/sources/errors List Multi-Host Source Creation Errors
get-multihost-integration-types GET /multihosts/types List Multi-Host Integration Types
get-sources-within-multi-host GET /multihosts/{multihostId}/sources List Sources Within Multi-Host Integration
test-connection-multi-host-sources POST /multihosts/{multihostId}/sources/testConnection Test Configuration For Multi-Host Integration
test-source-connection-multihost GET /multihosts/{multihostId}/sources/{sourceId}/testConnection Test Configuration For Multi-Host Integration's Single Source
update-multi-host-sources PATCH /multihosts/{multihostId} Update 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.

API Spec

Parameters

Param Type Name Data Type Required Description
Body multi_host_integrations_create MultiHostIntegrationsCreate True The specifics of the Multi-Host Integration to create

Return type

MultiHostIntegrations

Responses

Code Description Data Type Response headers
201 OK. Returned if the request was successfully accepted into the system. MultiHostIntegrations -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto -
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessModelMetadataAttribute429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.multi_host_integrations import MultiHostIntegrations
from sailpoint.beta.models.multi_host_integrations_create import MultiHostIntegrationsCreate
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    multi_host_integrations_create = '''{
          "owner" : {
            "name" : "MyName",
            "id" : "2c91808568c529c60168cca6f90c1313",
            "type" : "IDENTITY"
          },
          "managementWorkgroup" : {
            "name" : "My Management Workgroup",
            "id" : "2c91808568c529c60168cca6f90c2222",
            "type" : "GOVERNANCE_GROUP"
          },
          "cluster" : {
            "name" : "Corporate Cluster",
            "id" : "2c9180866166b5b0016167c32ef31a66",
            "type" : "CLUSTER"
          },
          "connector" : "multihost-microsoft-sql-server",
          "connectorAttributes" : {
            "maxSourcesPerAggGroup" : 10,
            "maxAllowedSources" : 300
          },
          "created" : "2022-02-08T14:50:03.827Z",
          "name" : "My Multi-Host Integration",
          "description" : "This is the Multi-Host Integration.",
          "modified" : "2024-01-23T18:08:50.897Z"
        }''' # MultiHostIntegrationsCreate | The specifics of the Multi-Host Integration to create

    try:
        # 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
        # results = MultiHostIntegrationApi(api_client).create_multi_host_integration(new_multi_host_integrations_create)
        print("The response of MultiHostIntegrationApi->create_multi_host_integration:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling MultiHostIntegrationApi->create_multi_host_integration: %s\n" % e)

[Back to top]

create-sources-within-multi-host

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.

API Spec

Parameters

Param Type Name Data Type Required Description
Path multihost_id str True ID of the Multi-Host Integration.
Body multi_host_integrations_create_sources []MultiHostIntegrationsCreateSources True The specifics of the sources to create within Multi-Host Integration.

Return type

(empty response body)

Responses

Code Description Data Type Response headers
200 OK. Returned if the request was successfully accepted into the system. -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto -
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessModelMetadataAttribute429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.multi_host_integrations_create_sources import MultiHostIntegrationsCreateSources
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration. # str | ID of the Multi-Host Integration.
    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
        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
        # MultiHostIntegrationApi(api_client).create_sources_within_multi_host(multihost_id, new_multi_host_integrations_create_sources)
    except Exception as e:
        print("Exception when calling MultiHostIntegrationApi->create_sources_within_multi_host: %s\n" % e)

[Back to top]

delete-multi-host

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.

API Spec

Parameters

Param Type Name Data Type Required Description
Path multihost_id str True ID of Multi-Host Integration to delete.

Return type

(empty response body)

Responses

Code Description Data Type Response headers
200 OK. Returned if the request was successfully accepted into the system. -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto -
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessModelMetadataAttribute429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()


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
        
        MultiHostIntegrationApi(api_client).delete_multi_host(multihost_id=multihost_id)
        # Below is a request that includes all optional parameters
        # MultiHostIntegrationApi(api_client).delete_multi_host(multihost_id)
    except Exception as e:
        print("Exception when calling MultiHostIntegrationApi->delete_multi_host: %s\n" % e)

[Back to top]

get-acct-aggregation-groups

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.

API Spec

Parameters

Param Type Name Data Type Required Description
Path multihost_id str True ID of the Multi-Host Integration to update

Return type

MultiHostIntegrationsAggScheduleUpdate

Responses

Code Description Data Type Response headers
200 OK. Returned if the request was successfully accepted into the system. MultiHostIntegrationsAggScheduleUpdate -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto -
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessModelMetadataAttribute429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.multi_host_integrations_agg_schedule_update import MultiHostIntegrationsAggScheduleUpdate
from sailpoint.configuration import Configuration
configuration = Configuration()


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
        
        results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id=multihost_id)
        # Below is a request that includes all optional parameters
        # results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id)
        print("The response of MultiHostIntegrationApi->get_acct_aggregation_groups:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling MultiHostIntegrationApi->get_acct_aggregation_groups: %s\n" % e)

[Back to top]

get-entitlement-aggregation-groups

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.

API Spec

Parameters

Param Type Name Data Type Required Description
Path multi_host_id str True ID of the Multi-Host Integration to update

Return type

MultiHostIntegrationsAggScheduleUpdate

Responses

Code Description Data Type Response headers
200 OK. Returned if the request was successfully accepted into the system. MultiHostIntegrationsAggScheduleUpdate -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto -
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessModelMetadataAttribute429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.multi_host_integrations_agg_schedule_update import MultiHostIntegrationsAggScheduleUpdate
from sailpoint.configuration import Configuration
configuration = Configuration()


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
        
        results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id=multi_host_id)
        # Below is a request that includes all optional parameters
        # results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id)
        print("The response of MultiHostIntegrationApi->get_entitlement_aggregation_groups:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling MultiHostIntegrationApi->get_entitlement_aggregation_groups: %s\n" % e)

[Back to top]

get-multi-host-integrations

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.

API Spec

Parameters

Param Type Name Data Type Required Description
Path multihost_id str True ID of the Multi-Host Integration.

Return type

MultiHostIntegrations

Responses

Code Description Data Type Response headers
200 OK. Returned if the request was successfully accepted into the system. MultiHostIntegrations -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto -
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessModelMetadataAttribute429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.multi_host_integrations import MultiHostIntegrations
from sailpoint.configuration import Configuration
configuration = Configuration()


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
        
        results = MultiHostIntegrationApi(api_client).get_multi_host_integrations(multihost_id=multihost_id)
        # Below is a request that includes all optional parameters
        # results = MultiHostIntegrationApi(api_client).get_multi_host_integrations(multihost_id)
        print("The response of MultiHostIntegrationApi->get_multi_host_integrations:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations: %s\n" % e)

[Back to top]

get-multi-host-integrations-list

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.

API Spec

Parameters

Param Type Name Data Type Required Description
Query offset int (optional) (default to 0) Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
Query limit int (optional) (default to 250) Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query sorters str (optional) Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: name
Query filters str (optional) Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: type: in forSubAdminId: in
Query count bool (optional) (default to False) 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 for more information.
Query for_subadmin str (optional) 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.

Return type

List[MultiHostIntegrations]

Responses

Code Description Data Type Response headers
200 OK. Returned if the request was successfully accepted into the system. List[MultiHostIntegrations] -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto -
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessModelMetadataAttribute429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.multi_host_integrations import MultiHostIntegrations
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
    limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
    sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **name** (optional)
    filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # 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:  **type**: *in*  **forSubAdminId**: *in* (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:  **type**: *in*  **forSubAdminId**: *in* (optional)
    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)
    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
        
        results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list()
        # Below is a request that includes all optional parameters
        # results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin)
        print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n")
        for item in results:
            print(item.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e)

[Back to top]

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

API Spec

Parameters

Param Type Name Data Type Required Description
Path multi_host_id str True ID of the Multi-Host Integration

Return type

List[SourceCreationErrors]

Responses

Code Description Data Type Response headers
200 OK. Returned if the request was successfully accepted into the system. List[SourceCreationErrors] -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto -
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessModelMetadataAttribute429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.source_creation_errors import SourceCreationErrors
from sailpoint.configuration import Configuration
configuration = Configuration()


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
        
        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
        # results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id)
        print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n")
        for item in results:
            print(item.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e)

[Back to top]

get-multihost-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.

API Spec

Parameters

This endpoint does not need any parameter.

Return type

List[MultiHostIntegrationTemplateType]

Responses

Code Description Data Type Response headers
200 OK. Returned if the request was successfully accepted into the system. List[MultiHostIntegrationTemplateType] -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto -
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessModelMetadataAttribute429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.multi_host_integration_template_type import MultiHostIntegrationTemplateType
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:

    try:
        # List Multi-Host Integration Types
        
        results = MultiHostIntegrationApi(api_client).get_multihost_integration_types()
        # Below is a request that includes all optional parameters
        # results = MultiHostIntegrationApi(api_client).get_multihost_integration_types()
        print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n")
        for item in results:
            print(item.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e)

[Back to top]

get-sources-within-multi-host

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.

API Spec

Parameters

Param Type Name Data Type Required Description
Path multihost_id str True ID of the Multi-Host Integration to update
Query offset int (optional) (default to 0) Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
Query limit int (optional) (default to 250) Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query sorters str (optional) Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: name
Query filters str (optional) Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: id: in
Query count bool (optional) (default to False) 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 for more information.

Return type

List[MultiHostSources]

Responses

Code Description Data Type Response headers
200 OK. Returned if the request was successfully accepted into the system. List[MultiHostSources] -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto -
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessModelMetadataAttribute429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.multi_host_sources import MultiHostSources
from sailpoint.configuration import Configuration
configuration = Configuration()


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
    offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
    limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
    sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **name** (optional)
    filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # 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:  **id**: *in* (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:  **id**: *in* (optional)
    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
        
        results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id=multihost_id)
        # Below is a request that includes all optional parameters
        # results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count)
        print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n")
        for item in results:
            print(item.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e)

[Back to top]

test-connection-multi-host-sources

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.

API Spec

Parameters

Param Type Name Data Type Required Description
Path multihost_id str True ID of the Multi-Host Integration

Return type

(empty response body)

Responses

Code Description Data Type Response headers
200 OK. Returned if the request was successfully accepted into the system. -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto -
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessModelMetadataAttribute429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()


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
        
        MultiHostIntegrationApi(api_client).test_connection_multi_host_sources(multihost_id=multihost_id)
        # Below is a request that includes all optional parameters
        # MultiHostIntegrationApi(api_client).test_connection_multi_host_sources(multihost_id)
    except Exception as e:
        print("Exception when calling MultiHostIntegrationApi->test_connection_multi_host_sources: %s\n" % e)

[Back to top]

test-source-connection-multihost

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.

API Spec

Parameters

Param Type Name Data Type Required Description
Path multihost_id str True ID of the Multi-Host Integration
Path source_id str True ID of the source within the Multi-Host Integration

Return type

TestSourceConnectionMultihost200Response

Responses

Code Description Data Type Response headers
200 OK. Returned if the request was successfully accepted into the system. TestSourceConnectionMultihost200Response -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto -
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessModelMetadataAttribute429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.test_source_connection_multihost200_response import TestSourceConnectionMultihost200Response
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration
    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
        
        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
        # results = MultiHostIntegrationApi(api_client).test_source_connection_multihost(multihost_id, source_id)
        print("The response of MultiHostIntegrationApi->test_source_connection_multihost:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling MultiHostIntegrationApi->test_source_connection_multihost: %s\n" % e)

[Back to top]

update-multi-host-sources

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.

API Spec

Parameters

Param Type Name Data Type Required Description
Path multihost_id str True ID of the Multi-Host Integration to update.
Body update_multi_host_sources_request_inner []UpdateMultiHostSourcesRequestInner True This endpoint allows you to update a Multi-Host Integration.

Return type

(empty response body)

Responses

Code Description Data Type Response headers
200 OK. Returned if the request was successfully accepted into the system. -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto -
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessModelMetadataAttribute429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: application/json-patch+json
  • Accept: application/json

Example

from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.update_multi_host_sources_request_inner import UpdateMultiHostSourcesRequestInner
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    multihost_id = 'anId' # str | ID of the Multi-Host Integration to update. # str | ID of the Multi-Host Integration to update.
    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
        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
        # MultiHostIntegrationApi(api_client).update_multi_host_sources(multihost_id, new_update_multi_host_sources_request_inner)
    except Exception as e:
        print("Exception when calling MultiHostIntegrationApi->update_multi_host_sources: %s\n" % e)

[Back to top]