MultiHostIntegration

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

Method	HTTP request	Description
New-MultiHostIntegrationV1	POST `/multihosts/v1`	Create multi-host integration
New-SourcesWithinMultiHostV1	POST `/multihosts/v1/{multihostId}`	Create sources within multi-host integration
Remove-MultiHostSourcesV1	POST `/multihosts/v1/{multiHostId}/sources/bulk-delete`	Delete sources within multi-host integration
Remove-MultiHostV1	DELETE `/multihosts/v1/{multihostId}`	Delete multi-host integration
Get-AcctAggregationGroupsV1	GET `/multihosts/v1/{multihostId}/acctAggregationGroups`	List account-aggregation-groups by multi-host id
Get-EntitlementAggregationGroupsV1	GET `/multihosts/v1/{multiHostId}/entitlementAggregationGroups`	List entitlement-aggregation-groups by integration id
Get-MultiHostIntegrationsListV1	GET `/multihosts/v1`	List all existing multi-host integrations
Get-MultiHostIntegrationsV1	GET `/multihosts/v1/{multihostId}`	Get multi-host integration by id
Get-MultiHostSourceCreationErrorsV1	GET `/multihosts/v1/{multiHostId}/sources/errors`	List multi-host source creation errors
Get-MultihostIntegrationTypesV1	GET `/multihosts/v1/types`	List multi-host integration types
Get-SourcesWithinMultiHostV1	GET `/multihosts/v1/{multihostId}/sources`	List sources within multi-host integration
Test-ConnectionMultiHostSourcesV1	POST `/multihosts/v1/{multihostId}/sources/testConnection`	Test configuration for multi-host integration
Test-SourceConnectionMultihostV1	GET `/multihosts/v1/{multihostId}/sources/{sourceId}/testConnection`	Test configuration for multi-host integration's single source
Update-MultiHostSourcesV1	PATCH `/multihosts/v1/{multihostId}`	Update multi-host integration

create-multi-host-integration-v1

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	Multihostintegrationscreate	Multihostintegrationscreate	True	The specifics of the Multi-Host Integration to create

Return type

Multihostintegrations

Responses

Code	Description	Data Type
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.	GetMultiHostIntegrationsListV1401Response
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.	GetMultiHostIntegrationsListV1429Response
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto

HTTP request headers

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

Example

$Multihostintegrationscreate = @""@

# Create multi-host integration

try {
    $Result = ConvertFrom-JsonToMultihostintegrationscreate -Json $Multihostintegrationscreate
    New-MultiHostIntegrationV1 -Multihostintegrationscreate $Result 
    
    # Below is a request that includes all optional parameters
    # New-MultiHostIntegrationV1 -Multihostintegrationscreate $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-MultiHostIntegrationV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

create-sources-within-multi-host-v1

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	MultihostId	String	True	ID of the Multi-Host Integration.
Body	Multihostintegrationscreatesources	[]Multihostintegrationscreatesources	True	The specifics of the sources to create within Multi-Host Integration.

Return type

(empty response body)

Responses

Code	Description	Data Type
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.	GetMultiHostIntegrationsListV1401Response
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.	GetMultiHostIntegrationsListV1429Response
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto

HTTP request headers

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

Example

$MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration.
 $Multihostintegrationscreatesources = @""@ # Multihostintegrationscreatesources[] | The specifics of the sources to create within Multi-Host Integration.
 

# Create sources within multi-host integration

try {
    $Result = ConvertFrom-JsonToMultihostintegrationscreatesources -Json $Multihostintegrationscreatesources
    New-SourcesWithinMultiHostV1 -MultihostId $MultihostId -Multihostintegrationscreatesources $Result 
    
    # Below is a request that includes all optional parameters
    # New-SourcesWithinMultiHostV1 -MultihostId $MultihostId -Multihostintegrationscreatesources $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SourcesWithinMultiHostV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

delete-multi-host-sources-v1

This endpoint performs bulk sources delete within Multi-Host Integration via a list of supplied IDs.

The following rights are required to access this endpoint: idn:multihosts:delete, idn:sources:delete

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	MultiHostId	String	True	ID of the Multi-Host Integration
Body	RequestBody	[]String	True	The delete bulk sources within multi-host integration request body

Return type

(empty response body)

Responses

Code	Description	Data Type
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.	GetMultiHostIntegrationsListV1401Response
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.	GetMultiHostIntegrationsListV1429Response
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto

HTTP request headers

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

Example

$MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration
$RequestBody = "MyRequestBody" # String[] | The delete bulk sources within multi-host integration request body
 $RequestBody = @""@ # String[] | The delete bulk sources within multi-host integration request body
 

# Delete sources within multi-host integration

try {
    $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
    Remove-MultiHostSourcesV1 -MultiHostId $MultiHostId -RequestBody $Result 
    
    # Below is a request that includes all optional parameters
    # Remove-MultiHostSourcesV1 -MultiHostId $MultiHostId -RequestBody $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-MultiHostSourcesV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

delete-multi-host-v1

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	MultihostId	String	True	ID of Multi-Host Integration to delete.

Return type

(empty response body)

Responses

Code	Description	Data Type
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.	GetMultiHostIntegrationsListV1401Response
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.	GetMultiHostIntegrationsListV1429Response
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete.

# Delete multi-host integration

try {
    Remove-MultiHostV1 -MultihostId $MultihostId 
    
    # Below is a request that includes all optional parameters
    # Remove-MultiHostV1 -MultihostId $MultihostId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-MultiHostV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-acct-aggregation-groups-v1

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	MultihostId	String	True	ID of the Multi-Host Integration to update
Query	Offset	Int32	(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	Int32	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.

Return type

Multihostintegrationsaggscheduleupdate[]

Responses

Code	Description	Data Type
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.	GetMultiHostIntegrationsListV1401Response
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.	GetMultiHostIntegrationsListV1429Response
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update
$Offset = 0 # Int32 | 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 # Int32 | 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)

# List account-aggregation-groups by multi-host id

try {
    Get-AcctAggregationGroupsV1 -MultihostId $MultihostId 
    
    # Below is a request that includes all optional parameters
    # Get-AcctAggregationGroupsV1 -MultihostId $MultihostId -Offset $Offset -Limit $Limit  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AcctAggregationGroupsV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-entitlement-aggregation-groups-v1

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	MultiHostId	String	True	ID of the Multi-Host Integration to update
Query	Offset	Int32	(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	Int32	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.

Return type

Multihostintegrationsaggscheduleupdate[]

Responses

Code	Description	Data Type
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.	GetMultiHostIntegrationsListV1401Response
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.	GetMultiHostIntegrationsListV1429Response
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update
$Offset = 0 # Int32 | 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 # Int32 | 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)

# List entitlement-aggregation-groups by integration id

try {
    Get-EntitlementAggregationGroupsV1 -MultiHostId $MultiHostId 
    
    # Below is a request that includes all optional parameters
    # Get-EntitlementAggregationGroupsV1 -MultiHostId $MultiHostId -Offset $Offset -Limit $Limit  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-EntitlementAggregationGroupsV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-multi-host-integrations-list-v1

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	Int32	(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	Int32	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query	Sorters	String	(optional)	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: name
Query	Filters	String	(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	Boolean	(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	ForSubadmin	String	(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

Multihostintegrations[]

Responses

Code	Description	Data Type
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.	GetMultiHostIntegrationsListV1401Response
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.	GetMultiHostIntegrationsListV1429Response
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Offset = 0 # Int32 | 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 # Int32 | 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" # String | 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' # String | 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 = $true # Boolean | 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)
$ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | 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)

# List all existing multi-host integrations

try {
    Get-MultiHostIntegrationsListV1 
    
    # Below is a request that includes all optional parameters
    # Get-MultiHostIntegrationsListV1 -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count -ForSubadmin $ForSubadmin  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MultiHostIntegrationsListV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-multi-host-integrations-v1

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	MultihostId	String	True	ID of the Multi-Host Integration.

Return type

Multihostintegrations

Responses

Code	Description	Data Type
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.	GetMultiHostIntegrationsListV1401Response
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.	GetMultiHostIntegrationsListV1429Response
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration.

# Get multi-host integration by id

try {
    Get-MultiHostIntegrationsV1 -MultihostId $MultihostId 
    
    # Below is a request that includes all optional parameters
    # Get-MultiHostIntegrationsV1 -MultihostId $MultihostId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MultiHostIntegrationsV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-multi-host-source-creation-errors-v1

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	MultiHostId	String	True	ID of the Multi-Host Integration

Return type

Sourcecreationerrors[]

Responses

Code	Description	Data Type
200	OK. Returned if the request was successfully accepted into the system.	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.	GetMultiHostIntegrationsListV1401Response
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.	GetMultiHostIntegrationsListV1429Response
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration

# List multi-host source creation errors

try {
    Get-MultiHostSourceCreationErrorsV1 -MultiHostId $MultiHostId 
    
    # Below is a request that includes all optional parameters
    # Get-MultiHostSourceCreationErrorsV1 -MultiHostId $MultiHostId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MultiHostSourceCreationErrorsV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-multihost-integration-types-v1

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

Param Type	Name	Data Type	Required	Description

Return type

Multihostintegrationtemplatetype[]

Responses

Code	Description	Data Type
200	OK. Returned if the request was successfully accepted into the system.	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.	GetMultiHostIntegrationsListV1401Response
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.	GetMultiHostIntegrationsListV1429Response
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

# List multi-host integration types

try {
    Get-MultihostIntegrationTypesV1 
    
    # Below is a request that includes all optional parameters
    # Get-MultihostIntegrationTypesV1  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MultihostIntegrationTypesV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-sources-within-multi-host-v1

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	MultihostId	String	True	ID of the Multi-Host Integration to update
Query	Offset	Int32	(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	Int32	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query	Sorters	String	(optional)	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: name
Query	Filters	String	(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	Boolean	(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

Multihostsources[]

Responses

Code	Description	Data Type
200	OK. Returned if the request was successfully accepted into the system.	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.	GetMultiHostIntegrationsListV1401Response
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.	GetMultiHostIntegrationsListV1429Response
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update
$Offset = 0 # Int32 | 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 # Int32 | 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" # String | 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' # String | 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 = $true # Boolean | 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)

# List sources within multi-host integration

try {
    Get-SourcesWithinMultiHostV1 -MultihostId $MultihostId 
    
    # Below is a request that includes all optional parameters
    # Get-SourcesWithinMultiHostV1 -MultihostId $MultihostId -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourcesWithinMultiHostV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

test-connection-multi-host-sources-v1

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	MultihostId	String	True	ID of the Multi-Host Integration

Return type

(empty response body)

Responses

Code	Description	Data Type
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.	GetMultiHostIntegrationsListV1401Response
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.	GetMultiHostIntegrationsListV1429Response
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration

# Test configuration for multi-host integration

try {
    Test-ConnectionMultiHostSourcesV1 -MultihostId $MultihostId 
    
    # Below is a request that includes all optional parameters
    # Test-ConnectionMultiHostSourcesV1 -MultihostId $MultihostId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-ConnectionMultiHostSourcesV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

test-source-connection-multihost-v1

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	MultihostId	String	True	ID of the Multi-Host Integration
Path	SourceId	String	True	ID of the source within the Multi-Host Integration

Return type

TestSourceConnectionMultihostV1200Response

Responses

Code	Description	Data Type
200	OK. Returned if the request was successfully accepted into the system.	TestSourceConnectionMultihostV1200Response
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.	GetMultiHostIntegrationsListV1401Response
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.	GetMultiHostIntegrationsListV1429Response
500	Internal Server Error - Returned if there is an unexpected error.	Errorresponsedto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration
$SourceId = "2c91808568c529f60168cca6f90c1324" # String | ID of the source within the Multi-Host Integration

# Test configuration for multi-host integration's single source

try {
    Test-SourceConnectionMultihostV1 -MultihostId $MultihostId -SourceId $SourceId 
    
    # Below is a request that includes all optional parameters
    # Test-SourceConnectionMultihostV1 -MultihostId $MultihostId -SourceId $SourceId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-SourceConnectionMultihostV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

update-multi-host-sources-v1

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	MultihostId	String	True	ID of the Multi-Host Integration to update.
Body	UpdateMultiHostSourcesV1RequestInner	[]UpdateMultiHostSourcesV1RequestInner	True	This endpoint allows you to update a Multi-Host Integration.

Return type

(empty response body)

Responses

Code	Description	Data Type
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.	GetMultiHostIntegrationsListV1401Response
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.	GetMultiHostIntegrationsListV1429Response
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

$MultihostId = "anId" # String | ID of the Multi-Host Integration to update.
 $UpdateMultiHostSourcesV1RequestInner = @"[{"op":"add","path":"/description","value":"MDK Multi-Host Integration 222 description"}]"@ # UpdateMultiHostSourcesV1RequestInner[] | This endpoint allows you to update a Multi-Host Integration. 
 

# Update multi-host integration

try {
    $Result = ConvertFrom-JsonToUpdateMultiHostSourcesV1RequestInner -Json $UpdateMultiHostSourcesV1RequestInner
    Update-MultiHostSourcesV1 -MultihostId $MultihostId -UpdateMultiHostSourcesV1RequestInner $Result 
    
    # Below is a request that includes all optional parameters
    # Update-MultiHostSourcesV1 -MultihostId $MultihostId -UpdateMultiHostSourcesV1RequestInner $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-MultiHostSourcesV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

create-multi-host-integration-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

create-sources-within-multi-host-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

delete-multi-host-sources-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

delete-multi-host-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-acct-aggregation-groups-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-entitlement-aggregation-groups-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-multi-host-integrations-list-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-multi-host-integrations-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-multi-host-source-creation-errors-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-multihost-integration-types-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-sources-within-multi-host-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

test-connection-multi-host-sources-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

test-source-connection-multihost-v1​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

update-multi-host-sources-v1​

Parameters​

create-multi-host-integration-v1

Parameters

Return type

Responses

HTTP request headers

Example

create-sources-within-multi-host-v1

Parameters

Return type

Responses

HTTP request headers

Example

delete-multi-host-sources-v1

Parameters

Return type

Responses

HTTP request headers

Example

delete-multi-host-v1

Parameters

Return type

Responses

HTTP request headers

Example

get-acct-aggregation-groups-v1

Parameters

Return type

Responses

HTTP request headers

Example

get-entitlement-aggregation-groups-v1

Parameters

Return type

Responses

HTTP request headers

Example

get-multi-host-integrations-list-v1

Parameters

Return type

Responses

HTTP request headers

Example

get-multi-host-integrations-v1

Parameters

Return type

Responses

HTTP request headers

Example

get-multi-host-source-creation-errors-v1

Parameters

Return type

Responses

HTTP request headers

Example

get-multihost-integration-types-v1

Parameters

Return type

Responses

HTTP request headers

Example

get-sources-within-multi-host-v1

Parameters

Return type

Responses

HTTP request headers

Example

test-connection-multi-host-sources-v1

Parameters

Return type

Responses

HTTP request headers

Example

test-source-connection-multihost-v1

Parameters

Return type

Responses

HTTP request headers

Example

update-multi-host-sources-v1

Parameters