mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 04:19:37 +00:00
Update to python SDK docs: 14132739659
This commit is contained in:
@@ -0,0 +1,389 @@
|
||||
---
|
||||
id: v2024-connector-customizers
|
||||
title: Connector_Customizers
|
||||
pagination_label: Connector_Customizers
|
||||
sidebar_label: Connector_Customizers
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'Connector_Customizers', 'V2024Connector_Customizers']
|
||||
slug: /tools/sdk/python/v2024/methods/connector-customizers
|
||||
tags: ['SDK', 'Software Development Kit', 'Connector_Customizers', 'V2024Connector_Customizers']
|
||||
---
|
||||
|
||||
# sailpoint.v2024.ConnectorCustomizersApi
|
||||
Saas Connectivity Customizers are cloud-based connector customizers. The customizers allow you to customize the out of the box connectors in a similar way to how you can use rules to customize VA (virtual appliance) based connectors.
|
||||
|
||||
Use these APIs to implement connector customizers functionality.
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create-connector-customizer**](#create-connector-customizer) | **POST** `/connector-customizers` | Create Connector Customizer
|
||||
[**create-connector-customizer-version**](#create-connector-customizer-version) | **POST** `/connector-customizers/{id}/versions` | Creates a connector customizer version
|
||||
[**delete-connector-customizer**](#delete-connector-customizer) | **DELETE** `/connector-customizers/{id}` | Delete Connector Customizer
|
||||
[**get-connector-customizer**](#get-connector-customizer) | **GET** `/connector-customizers/{id}` | Get connector customizer
|
||||
[**list-connector-customizers**](#list-connector-customizers) | **GET** `/connector-customizers` | List All Connector Customizers
|
||||
[**put-connector-customizer**](#put-connector-customizer) | **PUT** `/connector-customizers/{id}` | Update Connector Customizer
|
||||
|
||||
|
||||
## create-connector-customizer
|
||||
Create Connector Customizer
|
||||
Create a connector customizer.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-connector-customizer)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Body | connector_customizer_create_request | [**ConnectorCustomizerCreateRequest**](../models/connector-customizer-create-request) | True | Connector customizer to create.
|
||||
|
||||
### Return type
|
||||
[**ConnectorCustomizerCreateResponse**](../models/connector-customizer-create-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
201 | Created connector customizer. | ConnectorCustomizerCreateResponse | - |
|
||||
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. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | 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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.connector_customizers_api import ConnectorCustomizersApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.connector_customizer_create_request import ConnectorCustomizerCreateRequest
|
||||
from sailpoint.v2024.models.connector_customizer_create_response import ConnectorCustomizerCreateResponse
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
connector_customizer_create_request = '''{
|
||||
"name" : "My Custom Connector"
|
||||
}''' # ConnectorCustomizerCreateRequest | Connector customizer to create.
|
||||
|
||||
try:
|
||||
# Create Connector Customizer
|
||||
new_connector_customizer_create_request = ConnectorCustomizerCreateRequest.from_json(connector_customizer_create_request)
|
||||
results = ConnectorCustomizersApi(api_client).create_connector_customizer(connector_customizer_create_request=new_connector_customizer_create_request)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = ConnectorCustomizersApi(api_client).create_connector_customizer(new_connector_customizer_create_request)
|
||||
print("The response of ConnectorCustomizersApi->create_connector_customizer:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling ConnectorCustomizersApi->create_connector_customizer: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## create-connector-customizer-version
|
||||
Creates a connector customizer version
|
||||
Creates a new version for the customizer.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-connector-customizer-version)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | The id of the connector customizer.
|
||||
|
||||
### Return type
|
||||
[**ConnectorCustomizerVersionCreateResponse**](../models/connector-customizer-version-create-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | The created connector customizer version object. | ConnectorCustomizerVersionCreateResponse | - |
|
||||
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. | ListAccessProfiles401Response | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.connector_customizers_api import ConnectorCustomizersApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.connector_customizer_version_create_response import ConnectorCustomizerVersionCreateResponse
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'b07dc46a-1498-4de8-bfbb-259a68e70c8a' # str | The id of the connector customizer. # str | The id of the connector customizer.
|
||||
|
||||
try:
|
||||
# Creates a connector customizer version
|
||||
|
||||
results = ConnectorCustomizersApi(api_client).create_connector_customizer_version(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = ConnectorCustomizersApi(api_client).create_connector_customizer_version(id)
|
||||
print("The response of ConnectorCustomizersApi->create_connector_customizer_version:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling ConnectorCustomizersApi->create_connector_customizer_version: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-connector-customizer
|
||||
Delete Connector Customizer
|
||||
Delete the connector customizer for the given ID.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-connector-customizer)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | ID of the connector customizer to delete.
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - |
|
||||
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. | ListAccessProfiles401Response | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.connector_customizers_api import ConnectorCustomizersApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'b07dc46a-1498-4de8-bfbb-259a68e70c8a' # str | ID of the connector customizer to delete. # str | ID of the connector customizer to delete.
|
||||
|
||||
try:
|
||||
# Delete Connector Customizer
|
||||
|
||||
ConnectorCustomizersApi(api_client).delete_connector_customizer(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# ConnectorCustomizersApi(api_client).delete_connector_customizer(id)
|
||||
except Exception as e:
|
||||
print("Exception when calling ConnectorCustomizersApi->delete_connector_customizer: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-connector-customizer
|
||||
Get connector customizer
|
||||
Gets connector customizer by ID.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-customizer)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | ID of the connector customizer to get.
|
||||
|
||||
### Return type
|
||||
[**ConnectorCustomizersResponse**](../models/connector-customizers-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Connector customizer with the given ID. | ConnectorCustomizersResponse | - |
|
||||
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. | ListAccessProfiles401Response | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.connector_customizers_api import ConnectorCustomizersApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.connector_customizers_response import ConnectorCustomizersResponse
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'b07dc46a-1498-4de8-bfbb-259a68e70c8a' # str | ID of the connector customizer to get. # str | ID of the connector customizer to get.
|
||||
|
||||
try:
|
||||
# Get connector customizer
|
||||
|
||||
results = ConnectorCustomizersApi(api_client).get_connector_customizer(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = ConnectorCustomizersApi(api_client).get_connector_customizer(id)
|
||||
print("The response of ConnectorCustomizersApi->get_connector_customizer:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling ConnectorCustomizersApi->get_connector_customizer: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-connector-customizers
|
||||
List All Connector Customizers
|
||||
List all connector customizers.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-connector-customizers)
|
||||
|
||||
### 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
|
||||
### Return type
|
||||
[**List[ConnectorCustomizersResponse]**](../models/connector-customizers-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | List all connector customizers. | List[ConnectorCustomizersResponse] | - |
|
||||
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. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | 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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.connector_customizers_api import ConnectorCustomizersApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.connector_customizers_response import ConnectorCustomizersResponse
|
||||
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)
|
||||
|
||||
try:
|
||||
# List All Connector Customizers
|
||||
|
||||
results = ConnectorCustomizersApi(api_client).list_connector_customizers()
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = ConnectorCustomizersApi(api_client).list_connector_customizers(offset, limit)
|
||||
print("The response of ConnectorCustomizersApi->list_connector_customizers:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling ConnectorCustomizersApi->list_connector_customizers: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## put-connector-customizer
|
||||
Update Connector Customizer
|
||||
Update an existing connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-customizer)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | ID of the connector customizer to update.
|
||||
Body | connector_customizer_update_request | [**ConnectorCustomizerUpdateRequest**](../models/connector-customizer-update-request) | (optional) | Connector rule with updated data.
|
||||
|
||||
### Return type
|
||||
[**ConnectorCustomizerUpdateResponse**](../models/connector-customizer-update-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Updated connector customizer. | ConnectorCustomizerUpdateResponse | - |
|
||||
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. | ListAccessProfiles401Response | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.connector_customizers_api import ConnectorCustomizersApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.connector_customizer_update_request import ConnectorCustomizerUpdateRequest
|
||||
from sailpoint.v2024.models.connector_customizer_update_response import ConnectorCustomizerUpdateResponse
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'b07dc46a-1498-4de8-bfbb-259a68e70c8a' # str | ID of the connector customizer to update. # str | ID of the connector customizer to update.
|
||||
connector_customizer_update_request = '''{
|
||||
"name" : "My Custom Connector"
|
||||
}''' # ConnectorCustomizerUpdateRequest | Connector rule with updated data. (optional)
|
||||
|
||||
try:
|
||||
# Update Connector Customizer
|
||||
|
||||
results = ConnectorCustomizersApi(api_client).put_connector_customizer(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = ConnectorCustomizersApi(api_client).put_connector_customizer(id, new_connector_customizer_update_request)
|
||||
print("The response of ConnectorCustomizersApi->put_connector_customizer:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling ConnectorCustomizersApi->put_connector_customizer: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
@@ -31,17 +31,6 @@ Method | HTTP request | Description
|
||||
|
||||
|
||||
## create-connector-rule
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Create Connector Rule
|
||||
Create a connector rule from the available types.
|
||||
|
||||
@@ -51,7 +40,6 @@ Create a connector rule from the available types.
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | connector_rule_create_request | [**ConnectorRuleCreateRequest**](../models/connector-rule-create-request) | True | Connector rule to create.
|
||||
|
||||
### Return type
|
||||
@@ -81,10 +69,8 @@ from sailpoint.v2024.models.connector_rule_response import ConnectorRuleResponse
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = true
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
connector_rule_create_request = '''{
|
||||
"sourceCode" : {
|
||||
"version" : "1.0",
|
||||
@@ -115,9 +101,9 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Create Connector Rule
|
||||
new_connector_rule_create_request = ConnectorRuleCreateRequest.from_json(connector_rule_create_request)
|
||||
results = ConnectorRuleManagementApi(api_client).create_connector_rule(x_sail_point_experimental=x_sail_point_experimental, connector_rule_create_request=new_connector_rule_create_request)
|
||||
results = ConnectorRuleManagementApi(api_client).create_connector_rule(connector_rule_create_request=new_connector_rule_create_request)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = ConnectorRuleManagementApi(api_client).create_connector_rule(x_sail_point_experimental, new_connector_rule_create_request)
|
||||
# results = ConnectorRuleManagementApi(api_client).create_connector_rule(new_connector_rule_create_request)
|
||||
print("The response of ConnectorRuleManagementApi->create_connector_rule:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
@@ -129,17 +115,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-connector-rule
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Delete Connector Rule
|
||||
Delete the connector rule for the given ID.
|
||||
|
||||
@@ -150,7 +125,6 @@ Delete the connector rule for the given ID.
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | ID of the connector rule to delete.
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
@@ -178,18 +152,16 @@ from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = true
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to delete. # str | ID of the connector rule to delete.
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
|
||||
try:
|
||||
# Delete Connector Rule
|
||||
|
||||
ConnectorRuleManagementApi(api_client).delete_connector_rule(id=id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
ConnectorRuleManagementApi(api_client).delete_connector_rule(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# ConnectorRuleManagementApi(api_client).delete_connector_rule(id, x_sail_point_experimental)
|
||||
# ConnectorRuleManagementApi(api_client).delete_connector_rule(id)
|
||||
except Exception as e:
|
||||
print("Exception when calling ConnectorRuleManagementApi->delete_connector_rule: %s\n" % e)
|
||||
```
|
||||
@@ -199,17 +171,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-connector-rule
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Get Connector Rule
|
||||
Get a connector rule by ID.
|
||||
|
||||
@@ -220,7 +181,6 @@ Get a connector rule by ID.
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | ID of the connector rule to get.
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**ConnectorRuleResponse**](../models/connector-rule-response)
|
||||
@@ -249,18 +209,16 @@ from sailpoint.v2024.models.connector_rule_response import ConnectorRuleResponse
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = true
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to get. # str | ID of the connector rule to get.
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
|
||||
try:
|
||||
# Get Connector Rule
|
||||
|
||||
results = ConnectorRuleManagementApi(api_client).get_connector_rule(id=id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
results = ConnectorRuleManagementApi(api_client).get_connector_rule(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = ConnectorRuleManagementApi(api_client).get_connector_rule(id, x_sail_point_experimental)
|
||||
# results = ConnectorRuleManagementApi(api_client).get_connector_rule(id)
|
||||
print("The response of ConnectorRuleManagementApi->get_connector_rule:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
@@ -272,17 +230,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-connector-rule-list
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
List Connector Rules
|
||||
List existing connector rules.
|
||||
|
||||
@@ -292,7 +239,6 @@ List existing connector rules.
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Query | limit | **int** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
@@ -323,10 +269,8 @@ from sailpoint.v2024.models.connector_rule_response import ConnectorRuleResponse
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = true
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50)
|
||||
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)
|
||||
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)
|
||||
@@ -334,9 +278,9 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# List Connector Rules
|
||||
|
||||
results = ConnectorRuleManagementApi(api_client).get_connector_rule_list(x_sail_point_experimental=x_sail_point_experimental)
|
||||
results = ConnectorRuleManagementApi(api_client).get_connector_rule_list()
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = ConnectorRuleManagementApi(api_client).get_connector_rule_list(x_sail_point_experimental, limit, offset, count)
|
||||
# results = ConnectorRuleManagementApi(api_client).get_connector_rule_list(limit, offset, count)
|
||||
print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
@@ -348,17 +292,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## put-connector-rule
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Update Connector Rule
|
||||
Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type`
|
||||
|
||||
@@ -369,7 +302,6 @@ Update an existing connector rule with the one provided in the request body. The
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | ID of the connector rule to update.
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | connector_rule_update_request | [**ConnectorRuleUpdateRequest**](../models/connector-rule-update-request) | (optional) | Connector rule with updated data.
|
||||
|
||||
### Return type
|
||||
@@ -400,11 +332,9 @@ from sailpoint.v2024.models.connector_rule_update_request import ConnectorRuleUp
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = true
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to update. # str | ID of the connector rule to update.
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
connector_rule_update_request = '''{
|
||||
"sourceCode" : {
|
||||
"version" : "1.0",
|
||||
@@ -436,9 +366,9 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Update Connector Rule
|
||||
|
||||
results = ConnectorRuleManagementApi(api_client).put_connector_rule(id=id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
results = ConnectorRuleManagementApi(api_client).put_connector_rule(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = ConnectorRuleManagementApi(api_client).put_connector_rule(id, x_sail_point_experimental, new_connector_rule_update_request)
|
||||
# results = ConnectorRuleManagementApi(api_client).put_connector_rule(id, new_connector_rule_update_request)
|
||||
print("The response of ConnectorRuleManagementApi->put_connector_rule:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
@@ -450,17 +380,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## test-connector-rule
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Validate Connector Rule
|
||||
Detect issues within the connector rule's code to fix and list them.
|
||||
|
||||
@@ -470,7 +389,6 @@ Detect issues within the connector rule's code to fix and list them.
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | source_code | [**SourceCode**](../models/source-code) | True | Code to validate.
|
||||
|
||||
### Return type
|
||||
@@ -500,10 +418,8 @@ from sailpoint.v2024.models.source_code import SourceCode
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = true
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
source_code = '''{
|
||||
"version" : "1.0",
|
||||
"script" : "return \"Mr. \" + firstName;"
|
||||
@@ -512,9 +428,9 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Validate Connector Rule
|
||||
new_source_code = SourceCode.from_json(source_code)
|
||||
results = ConnectorRuleManagementApi(api_client).test_connector_rule(x_sail_point_experimental=x_sail_point_experimental, source_code=new_source_code)
|
||||
results = ConnectorRuleManagementApi(api_client).test_connector_rule(source_code=new_source_code)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = ConnectorRuleManagementApi(api_client).test_connector_rule(x_sail_point_experimental, new_source_code)
|
||||
# results = ConnectorRuleManagementApi(api_client).test_connector_rule(new_source_code)
|
||||
print("The response of ConnectorRuleManagementApi->test_connector_rule:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
|
||||
@@ -0,0 +1,352 @@
|
||||
---
|
||||
id: v2024-managed-cluster-types
|
||||
title: Managed_Cluster_Types
|
||||
pagination_label: Managed_Cluster_Types
|
||||
sidebar_label: Managed_Cluster_Types
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'Managed_Cluster_Types', 'V2024Managed_Cluster_Types']
|
||||
slug: /tools/sdk/python/v2024/methods/managed-cluster-types
|
||||
tags: ['SDK', 'Software Development Kit', 'Managed_Cluster_Types', 'V2024Managed_Cluster_Types']
|
||||
---
|
||||
|
||||
# sailpoint.v2024.ManagedClusterTypesApi
|
||||
Use this API to implement managed cluster types functionality.
|
||||
With this functionality in place, administrators can modify and delete existing managed cluster types and create new ones.
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create-managed-cluster-type**](#create-managed-cluster-type) | **POST** `/managed-cluster-types` | Create new Managed Cluster Type
|
||||
[**delete-managed-cluster-type**](#delete-managed-cluster-type) | **DELETE** `/managed-cluster-types/{id}` | Delete a Managed Cluster Type
|
||||
[**get-managed-cluster-type**](#get-managed-cluster-type) | **GET** `/managed-cluster-types/{id}` | Get a Managed Cluster Type
|
||||
[**get-managed-cluster-types**](#get-managed-cluster-types) | **GET** `/managed-cluster-types` | Get Managed Cluster Types
|
||||
[**update-managed-cluster-type**](#update-managed-cluster-type) | **PATCH** `/managed-cluster-types/{id}` | Update a Managed Cluster Type
|
||||
|
||||
|
||||
## create-managed-cluster-type
|
||||
Create new Managed Cluster Type
|
||||
Create a new Managed Cluster Type.
|
||||
AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint.
|
||||
The API returns a result that includes the Managed Cluster Type ID
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-managed-cluster-type)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Body | managed_cluster_type | [**ManagedClusterType**](../models/managed-cluster-type) | True |
|
||||
|
||||
### Return type
|
||||
[**ManagedClusterType**](../models/managed-cluster-type)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | The created ManagedClusterType | ManagedClusterType | - |
|
||||
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. | ListAccessProfiles401Response | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
managed_cluster_type = '''{
|
||||
"managedProcessIds" : [ "someId", "someId2" ],
|
||||
"pod" : "megapod-useast1",
|
||||
"org" : "denali-cjh",
|
||||
"id" : "aClusterTypeId",
|
||||
"type" : "idn"
|
||||
}''' # ManagedClusterType |
|
||||
|
||||
try:
|
||||
# Create new Managed Cluster Type
|
||||
new_managed_cluster_type = ManagedClusterType.from_json(managed_cluster_type)
|
||||
results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(managed_cluster_type=new_managed_cluster_type)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = ManagedClusterTypesApi(api_client).create_managed_cluster_type(new_managed_cluster_type)
|
||||
print("The response of ManagedClusterTypesApi->create_managed_cluster_type:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling ManagedClusterTypesApi->create_managed_cluster_type: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-managed-cluster-type
|
||||
Delete a Managed Cluster Type
|
||||
Delete an existing Managed Cluster Type.
|
||||
AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-managed-cluster-type)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | The Managed Cluster Type ID
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - |
|
||||
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. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | 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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID
|
||||
|
||||
try:
|
||||
# Delete a Managed Cluster Type
|
||||
|
||||
ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# ManagedClusterTypesApi(api_client).delete_managed_cluster_type(id)
|
||||
except Exception as e:
|
||||
print("Exception when calling ManagedClusterTypesApi->delete_managed_cluster_type: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-managed-cluster-type
|
||||
Get a Managed Cluster Type
|
||||
Get a Managed Cluster Type.
|
||||
AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-cluster-type)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | The Managed Cluster Type ID
|
||||
|
||||
### Return type
|
||||
[**ManagedClusterType**](../models/managed-cluster-type)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Responds with a ManagedClusterType | ManagedClusterType | - |
|
||||
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. | ListAccessProfiles401Response | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID
|
||||
|
||||
try:
|
||||
# Get a Managed Cluster Type
|
||||
|
||||
results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = ManagedClusterTypesApi(api_client).get_managed_cluster_type(id)
|
||||
print("The response of ManagedClusterTypesApi->get_managed_cluster_type:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_type: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-managed-cluster-types
|
||||
Get Managed Cluster Types
|
||||
Get a list of Managed Cluster Types.
|
||||
AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-cluster-types)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Query | type | **str** | (optional) | Type descriptor
|
||||
Query | pod | **str** | (optional) | Pinned pod (or default)
|
||||
Query | org | **str** | (optional) | Pinned org (or default)
|
||||
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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
|
||||
### Return type
|
||||
[**List[ManagedClusterType]**](../models/managed-cluster-type)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Responds with a list of ManagedClusterType based on the query params provided | List[ManagedClusterType] | - |
|
||||
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. | ListAccessProfiles401Response | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
type = 'IDN' # str | Type descriptor (optional) # str | Type descriptor (optional)
|
||||
pod = 'megapod-useast1' # str | Pinned pod (or default) (optional) # str | Pinned pod (or default) (optional)
|
||||
org = 'denali-xyz' # str | Pinned org (or default) (optional) # str | Pinned org (or default) (optional)
|
||||
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)
|
||||
|
||||
try:
|
||||
# Get Managed Cluster Types
|
||||
|
||||
results = ManagedClusterTypesApi(api_client).get_managed_cluster_types()
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit)
|
||||
print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## update-managed-cluster-type
|
||||
Update a Managed Cluster Type
|
||||
Update an existing Managed Cluster Type.
|
||||
AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-managed-cluster-type)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | The Managed Cluster Type ID
|
||||
Body | json_patch | [**JsonPatch**](../models/json-patch) | True | The JSONPatch payload used to update the schema.
|
||||
|
||||
### Return type
|
||||
[**ManagedClusterType**](../models/managed-cluster-type)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | The updated ManagedClusterType | ManagedClusterType | - |
|
||||
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. | ListAccessProfiles401Response | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
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
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.managed_cluster_types_api import ManagedClusterTypesApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.json_patch import JsonPatch
|
||||
from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'aClusterTypeId' # str | The Managed Cluster Type ID # str | The Managed Cluster Type ID
|
||||
json_patch = '''{
|
||||
"operations" : [ {
|
||||
"op" : "replace",
|
||||
"path" : "/description",
|
||||
"value" : "New description"
|
||||
}, {
|
||||
"op" : "replace",
|
||||
"path" : "/description",
|
||||
"value" : "New description"
|
||||
} ]
|
||||
}''' # JsonPatch | The JSONPatch payload used to update the schema.
|
||||
|
||||
try:
|
||||
# Update a Managed Cluster Type
|
||||
new_json_patch = JsonPatch.from_json(json_patch)
|
||||
results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id=id, json_patch=new_json_patch)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = ManagedClusterTypesApi(api_client).update_managed_cluster_type(id, new_json_patch)
|
||||
print("The response of ManagedClusterTypesApi->update_managed_cluster_type:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling ManagedClusterTypesApi->update_managed_cluster_type: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,875 @@
|
||||
---
|
||||
id: v2024-multi-host-integration
|
||||
title: Multi_Host_Integration
|
||||
pagination_label: Multi_Host_Integration
|
||||
sidebar_label: Multi_Host_Integration
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'Multi_Host_Integration', 'V2024Multi_Host_Integration']
|
||||
slug: /tools/sdk/python/v2024/methods/multi-host-integration
|
||||
tags: ['SDK', 'Software Development Kit', 'Multi_Host_Integration', 'V2024Multi_Host_Integration']
|
||||
---
|
||||
|
||||
# sailpoint.v2024.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/v2024*
|
||||
|
||||
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` | List Account-Aggregation-Groups by Multi-Host ID
|
||||
[**get-entitlement-aggregation-groups**](#get-entitlement-aggregation-groups) | **GET** `/multihosts/{multiHostId}/entitlementAggregationGroups` | List Entitlement-Aggregation-Groups by 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'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
|
||||
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](https://developer.sailpoint.com/docs/api/v2024/create-multi-host-integration)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Body | multi_host_integrations_create | [**MultiHostIntegrationsCreate**](../models/multi-host-integrations-create) | True | The specifics of the Multi-Host Integration to create
|
||||
|
||||
### Return type
|
||||
[**MultiHostIntegrations**](../models/multi-host-integrations)
|
||||
|
||||
### 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. | ListAccessProfiles401Response | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.multi_host_integrations import MultiHostIntegrations
|
||||
from sailpoint.v2024.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](https://developer.sailpoint.com/docs/api/v2024/create-sources-within-multi-host)
|
||||
|
||||
### 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**](../models/multi-host-integrations-create-sources) | 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. | ListAccessProfiles401Response | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.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.v2024.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](https://developer.sailpoint.com/docs/api/v2024/delete-multi-host)
|
||||
|
||||
### 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. | ListAccessProfiles401Response | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
|
||||
from sailpoint.v2024.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
|
||||
List Account-Aggregation-Groups by Multi-Host 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](https://developer.sailpoint.com/docs/api/v2024/get-acct-aggregation-groups)
|
||||
|
||||
### 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
|
||||
### Return type
|
||||
[**List[MultiHostIntegrationsAggScheduleUpdate]**](../models/multi-host-integrations-agg-schedule-update)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | OK. Returned if the request was successfully accepted into the system. | List[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. | ListAccessProfiles401Response | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.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
|
||||
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)
|
||||
|
||||
try:
|
||||
# List Account-Aggregation-Groups by Multi-Host 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, offset, limit)
|
||||
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
|
||||
List Entitlement-Aggregation-Groups by 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](https://developer.sailpoint.com/docs/api/v2024/get-entitlement-aggregation-groups)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | multi_host_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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
|
||||
### Return type
|
||||
[**List[MultiHostIntegrationsAggScheduleUpdate]**](../models/multi-host-integrations-agg-schedule-update)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | OK. Returned if the request was successfully accepted into the system. | List[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. | ListAccessProfiles401Response | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.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
|
||||
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)
|
||||
|
||||
try:
|
||||
# List Entitlement-Aggregation-Groups by 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, offset, limit)
|
||||
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](https://developer.sailpoint.com/docs/api/v2024/get-multi-host-integrations)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | multihost_id | **str** | True | ID of the Multi-Host Integration.
|
||||
|
||||
### Return type
|
||||
[**MultiHostIntegrations**](../models/multi-host-integrations)
|
||||
|
||||
### 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. | ListAccessProfiles401Response | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.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](https://developer.sailpoint.com/docs/api/v2024/get-multi-host-integrations-list)
|
||||
|
||||
### 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
Query | sorters | **str** | (optional) | 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**
|
||||
Query | filters | **str** | (optional) | 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*
|
||||
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](https://developer.sailpoint.com/idn/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]**](../models/multi-host-integrations)
|
||||
|
||||
### 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. | ListAccessProfiles401Response | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.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")
|
||||
print(results.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](https://developer.sailpoint.com/docs/api/v2024/get-multi-host-source-creation-errors)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | multi_host_id | **str** | True | ID of the Multi-Host Integration
|
||||
|
||||
### Return type
|
||||
[**List[SourceCreationErrors]**](../models/source-creation-errors)
|
||||
|
||||
### 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. | ListAccessProfiles401Response | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.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")
|
||||
print(results.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](https://developer.sailpoint.com/docs/api/v2024/get-multihost-integration-types)
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
[**List[MultiHostIntegrationTemplateType]**](../models/multi-host-integration-template-type)
|
||||
|
||||
### 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. | ListAccessProfiles401Response | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.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")
|
||||
print(results.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](https://developer.sailpoint.com/docs/api/v2024/get-sources-within-multi-host)
|
||||
|
||||
### 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
Query | sorters | **str** | (optional) | 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**
|
||||
Query | filters | **str** | (optional) | 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*
|
||||
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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
|
||||
### Return type
|
||||
[**List[MultiHostSources]**](../models/multi-host-sources)
|
||||
|
||||
### 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. | ListAccessProfiles401Response | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.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")
|
||||
print(results.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](https://developer.sailpoint.com/docs/api/v2024/test-connection-multi-host-sources)
|
||||
|
||||
### 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. | ListAccessProfiles401Response | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
|
||||
from sailpoint.v2024.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](https://developer.sailpoint.com/docs/api/v2024/test-source-connection-multihost)
|
||||
|
||||
### 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**](../models/test-source-connection-multihost200-response)
|
||||
|
||||
### 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. | ListAccessProfiles401Response | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.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](https://developer.sailpoint.com/docs/api/v2024/update-multi-host-sources)
|
||||
|
||||
### 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**](../models/update-multi-host-sources-request-inner) | 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. | ListAccessProfiles401Response | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
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
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.multi_host_integration_api import MultiHostIntegrationApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.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]](#)
|
||||
|
||||
|
||||
|
||||
@@ -89,7 +89,7 @@ Method | HTTP request | Description
|
||||
[**get-provisioning-policy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType
|
||||
[**get-source**](#get-source) | **GET** `/sources/{id}` | Get Source by ID
|
||||
[**get-source-attr-sync-config**](#get-source-attr-sync-config) | **GET** `/sources/{id}/attribute-sync-config` | Attribute Sync Config
|
||||
[**get-source-config**](#get-source-config) | **GET** `/sources/{id}/connectors/source-config` | Gets source config with language translations
|
||||
[**get-source-config**](#get-source-config) | **GET** `/sources/{id}/connectors/source-config` | Gets source config with language-translations
|
||||
[**get-source-connections**](#get-source-connections) | **GET** `/sources/{sourceId}/connections` | Get Source Connections by ID
|
||||
[**get-source-entitlement-request-config**](#get-source-entitlement-request-config) | **GET** `/sources/{id}/entitlement-request-config` | Get Source Entitlement Request Configuration
|
||||
[**get-source-health**](#get-source-health) | **GET** `/sources/{sourceId}/source-health` | Fetches source health by id
|
||||
@@ -104,7 +104,6 @@ Method | HTTP request | Description
|
||||
[**import-uncorrelated-accounts**](#import-uncorrelated-accounts) | **POST** `/sources/{id}/load-uncorrelated-accounts` | Process Uncorrelated Accounts
|
||||
[**list-provisioning-policies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies
|
||||
[**list-sources**](#list-sources) | **GET** `/sources` | Lists all sources in IdentityNow.
|
||||
[**peek-resource-objects**](#peek-resource-objects) | **POST** `/sources/{sourceId}/connector/peek-resource-objects` | Peek source connector's resource objects
|
||||
[**ping-cluster**](#ping-cluster) | **POST** `/sources/{sourceId}/connector/ping-cluster` | Ping cluster for source connector
|
||||
[**put-correlation-config**](#put-correlation-config) | **PUT** `/sources/{id}/correlation-config` | Update Source Correlation Configuration
|
||||
[**put-native-change-detection-config**](#put-native-change-detection-config) | **PUT** `/sources/{sourceId}/native-change-detection-config` | Update Native Change Detection Configuration
|
||||
@@ -112,6 +111,7 @@ Method | HTTP request | Description
|
||||
[**put-source**](#put-source) | **PUT** `/sources/{id}` | Update Source (Full)
|
||||
[**put-source-attr-sync-config**](#put-source-attr-sync-config) | **PUT** `/sources/{id}/attribute-sync-config` | Update Attribute Sync Config
|
||||
[**put-source-schema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full)
|
||||
[**search-resource-objects**](#search-resource-objects) | **POST** `/sources/{sourceId}/connector/peek-resource-objects` | Peek source connector's resource objects
|
||||
[**sync-attributes-for-source**](#sync-attributes-for-source) | **POST** `/sources/{id}/synchronize-attributes` | Synchronize single source attributes.
|
||||
[**test-source-configuration**](#test-source-configuration) | **POST** `/sources/{sourceId}/connector/test-configuration` | Test configuration for source connector
|
||||
[**test-source-connection**](#test-source-connection) | **POST** `/sources/{sourceId}/connector/check-connection` | Check connection for source connector.
|
||||
@@ -1317,18 +1317,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-source-config
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Gets source config with language translations
|
||||
Gets source config with language-translations
|
||||
Looks up and returns the source config for the requested source id after populating the source config values and applying language translations.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-config)
|
||||
@@ -1338,7 +1327,6 @@ Looks up and returns the source config for the requested source id after populat
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | The Source id
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Query | locale | **str** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to \"en\"
|
||||
|
||||
### Return type
|
||||
@@ -1348,6 +1336,7 @@ Path | id | **str** | True | The Source id
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | A Connector Detail object | ConnectorDetail | - |
|
||||
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. | ListAccessProfiles401Response | - |
|
||||
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 | - |
|
||||
@@ -1367,19 +1356,17 @@ from sailpoint.v2024.models.connector_detail import ConnectorDetail
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = true
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'id_example' # str | The Source id # str | The Source id
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
locale = 'locale_example' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional)
|
||||
id = 'cef3ee201db947c5912551015ba0c679' # str | The Source id # str | The Source id
|
||||
locale = 'en' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional)
|
||||
|
||||
try:
|
||||
# Gets source config with language translations
|
||||
# Gets source config with language-translations
|
||||
|
||||
results = SourcesApi(api_client).get_source_config(id=id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
results = SourcesApi(api_client).get_source_config(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SourcesApi(api_client).get_source_config(id, x_sail_point_experimental, locale)
|
||||
# results = SourcesApi(api_client).get_source_config(id, locale)
|
||||
print("The response of SourcesApi->get_source_config:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
@@ -2310,99 +2297,9 @@ with ApiClient(configuration) as api_client:
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## peek-resource-objects
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Peek source connector's resource objects
|
||||
Retrieves a sample of data returned from account and group aggregation requests.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/peek-resource-objects)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | source_id | **str** | True | The ID of the Source
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | resource_objects_request | [**ResourceObjectsRequest**](../models/resource-objects-request) | True |
|
||||
|
||||
### Return type
|
||||
[**ResourceObjectsResponse**](../models/resource-objects-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | List of resource objects that was fetched from the source connector. | ResourceObjectsResponse | - |
|
||||
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. | ListAccessProfiles401Response | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.sources_api import SourcesApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.resource_objects_request import ResourceObjectsRequest
|
||||
from sailpoint.v2024.models.resource_objects_response import ResourceObjectsResponse
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = true
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
resource_objects_request = '''{
|
||||
"maxCount" : 100,
|
||||
"objectType" : "group"
|
||||
}''' # ResourceObjectsRequest |
|
||||
|
||||
try:
|
||||
# Peek source connector's resource objects
|
||||
new_resource_objects_request = ResourceObjectsRequest.from_json(resource_objects_request)
|
||||
results = SourcesApi(api_client).peek_resource_objects(source_id=source_id, x_sail_point_experimental=x_sail_point_experimental, resource_objects_request=new_resource_objects_request)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SourcesApi(api_client).peek_resource_objects(source_id, x_sail_point_experimental, new_resource_objects_request)
|
||||
print("The response of SourcesApi->peek_resource_objects:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling SourcesApi->peek_resource_objects: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## ping-cluster
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Ping cluster for source connector
|
||||
This endpoint validates that the cluster being used by the source is reachable from IdentityNow.
|
||||
|
||||
@@ -2413,7 +2310,6 @@ This endpoint validates that the cluster being used by the source is reachable f
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | source_id | **str** | True | The ID of the Source
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**StatusResponse**](../models/status-response)
|
||||
@@ -2442,18 +2338,16 @@ from sailpoint.v2024.models.status_response import StatusResponse
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = true
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
|
||||
try:
|
||||
# Ping cluster for source connector
|
||||
|
||||
results = SourcesApi(api_client).ping_cluster(source_id=source_id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
results = SourcesApi(api_client).ping_cluster(source_id=source_id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SourcesApi(api_client).ping_cluster(source_id, x_sail_point_experimental)
|
||||
# results = SourcesApi(api_client).ping_cluster(source_id)
|
||||
print("The response of SourcesApi->ping_cluster:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
@@ -3051,6 +2945,71 @@ with ApiClient(configuration) as api_client:
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## search-resource-objects
|
||||
Peek source connector's resource objects
|
||||
Retrieves a sample of data returned from account and group aggregation requests.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-resource-objects)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | source_id | **str** | True | The ID of the Source
|
||||
Body | resource_objects_request | [**ResourceObjectsRequest**](../models/resource-objects-request) | True |
|
||||
|
||||
### Return type
|
||||
[**ResourceObjectsResponse**](../models/resource-objects-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | List of resource objects that was fetched from the source connector. | ResourceObjectsResponse | - |
|
||||
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. | ListAccessProfiles401Response | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.api.sources_api import SourcesApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.resource_objects_request import ResourceObjectsRequest
|
||||
from sailpoint.v2024.models.resource_objects_response import ResourceObjectsResponse
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source
|
||||
resource_objects_request = '''{
|
||||
"maxCount" : 100,
|
||||
"objectType" : "group"
|
||||
}''' # ResourceObjectsRequest |
|
||||
|
||||
try:
|
||||
# Peek source connector's resource objects
|
||||
new_resource_objects_request = ResourceObjectsRequest.from_json(resource_objects_request)
|
||||
results = SourcesApi(api_client).search_resource_objects(source_id=source_id, resource_objects_request=new_resource_objects_request)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SourcesApi(api_client).search_resource_objects(source_id, new_resource_objects_request)
|
||||
print("The response of SourcesApi->search_resource_objects:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling SourcesApi->search_resource_objects: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## sync-attributes-for-source
|
||||
@@ -3127,17 +3086,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## test-source-configuration
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Test configuration for source connector
|
||||
This endpoint performs a more detailed validation of the source''s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API.
|
||||
|
||||
@@ -3148,7 +3096,6 @@ This endpoint performs a more detailed validation of the source''s configuration
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | source_id | **str** | True | The ID of the Source
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**StatusResponse**](../models/status-response)
|
||||
@@ -3177,18 +3124,16 @@ from sailpoint.v2024.models.status_response import StatusResponse
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = true
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
|
||||
try:
|
||||
# Test configuration for source connector
|
||||
|
||||
results = SourcesApi(api_client).test_source_configuration(source_id=source_id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
results = SourcesApi(api_client).test_source_configuration(source_id=source_id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SourcesApi(api_client).test_source_configuration(source_id, x_sail_point_experimental)
|
||||
# results = SourcesApi(api_client).test_source_configuration(source_id)
|
||||
print("The response of SourcesApi->test_source_configuration:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
@@ -3200,17 +3145,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## test-source-connection
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Check connection for source connector.
|
||||
This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter.
|
||||
|
||||
@@ -3221,7 +3155,6 @@ This endpoint validates that the configured credentials are valid and will prope
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | source_id | **str** | True | The ID of the Source.
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**StatusResponse**](../models/status-response)
|
||||
@@ -3250,18 +3183,16 @@ from sailpoint.v2024.models.status_response import StatusResponse
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = true
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source. # str | The ID of the Source.
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
|
||||
try:
|
||||
# Check connection for source connector.
|
||||
|
||||
results = SourcesApi(api_client).test_source_connection(source_id=source_id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
results = SourcesApi(api_client).test_source_connection(source_id=source_id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SourcesApi(api_client).test_source_connection(source_id, x_sail_point_experimental)
|
||||
# results = SourcesApi(api_client).test_source_connection(source_id)
|
||||
print("The response of SourcesApi->test_source_connection:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
id: v2024-connector-customizer-create-request
|
||||
title: ConnectorCustomizerCreateRequest
|
||||
pagination_label: ConnectorCustomizerCreateRequest
|
||||
sidebar_label: ConnectorCustomizerCreateRequest
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ConnectorCustomizerCreateRequest', 'V2024ConnectorCustomizerCreateRequest']
|
||||
slug: /tools/sdk/python/v2024/models/connector-customizer-create-request
|
||||
tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerCreateRequest', 'V2024ConnectorCustomizerCreateRequest']
|
||||
---
|
||||
|
||||
# ConnectorCustomizerCreateRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | Connector customizer name. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.connector_customizer_create_request import ConnectorCustomizerCreateRequest
|
||||
|
||||
connector_customizer_create_request = ConnectorCustomizerCreateRequest(
|
||||
name='My Custom Connector'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
id: v2024-connector-customizer-create-response
|
||||
title: ConnectorCustomizerCreateResponse
|
||||
pagination_label: ConnectorCustomizerCreateResponse
|
||||
sidebar_label: ConnectorCustomizerCreateResponse
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ConnectorCustomizerCreateResponse', 'V2024ConnectorCustomizerCreateResponse']
|
||||
slug: /tools/sdk/python/v2024/models/connector-customizer-create-response
|
||||
tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerCreateResponse', 'V2024ConnectorCustomizerCreateResponse']
|
||||
---
|
||||
|
||||
# ConnectorCustomizerCreateResponse
|
||||
|
||||
ConnectorCustomizerResponse
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | the ID of connector customizer. | [optional]
|
||||
**name** | **str** | name of the connector customizer. | [optional]
|
||||
**tenant_id** | **str** | Connector customizer tenant id. | [optional]
|
||||
**created** | **datetime** | Date-time when the connector customizer was created. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.connector_customizer_create_response import ConnectorCustomizerCreateResponse
|
||||
|
||||
connector_customizer_create_response = ConnectorCustomizerCreateResponse(
|
||||
id='b07dc46a-1498-4de8-bfbb-259a68e70c8a',
|
||||
name='connector-customizer-name',
|
||||
tenant_id='2c91808568c529c60168cca6f90c1324',
|
||||
created=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f')
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
id: v2024-connector-customizer-update-request
|
||||
title: ConnectorCustomizerUpdateRequest
|
||||
pagination_label: ConnectorCustomizerUpdateRequest
|
||||
sidebar_label: ConnectorCustomizerUpdateRequest
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ConnectorCustomizerUpdateRequest', 'V2024ConnectorCustomizerUpdateRequest']
|
||||
slug: /tools/sdk/python/v2024/models/connector-customizer-update-request
|
||||
tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerUpdateRequest', 'V2024ConnectorCustomizerUpdateRequest']
|
||||
---
|
||||
|
||||
# ConnectorCustomizerUpdateRequest
|
||||
|
||||
ConnectorCustomizerUpdateRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | Connector customizer name. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.connector_customizer_update_request import ConnectorCustomizerUpdateRequest
|
||||
|
||||
connector_customizer_update_request = ConnectorCustomizerUpdateRequest(
|
||||
name='My Custom Connector'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
id: v2024-connector-customizer-update-response
|
||||
title: ConnectorCustomizerUpdateResponse
|
||||
pagination_label: ConnectorCustomizerUpdateResponse
|
||||
sidebar_label: ConnectorCustomizerUpdateResponse
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ConnectorCustomizerUpdateResponse', 'V2024ConnectorCustomizerUpdateResponse']
|
||||
slug: /tools/sdk/python/v2024/models/connector-customizer-update-response
|
||||
tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerUpdateResponse', 'V2024ConnectorCustomizerUpdateResponse']
|
||||
---
|
||||
|
||||
# ConnectorCustomizerUpdateResponse
|
||||
|
||||
ConnectorCustomizerUpdateResponse
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | the ID of connector customizer. | [optional]
|
||||
**name** | **str** | name of the connector customizer. | [optional]
|
||||
**tenant_id** | **str** | Connector customizer tenant id. | [optional]
|
||||
**created** | **datetime** | Date-time when the connector customizer was created. | [optional]
|
||||
**image_version** | **int** | Connector customizer image version. | [optional]
|
||||
**image_id** | **str** | Connector customizer image id. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.connector_customizer_update_response import ConnectorCustomizerUpdateResponse
|
||||
|
||||
connector_customizer_update_response = ConnectorCustomizerUpdateResponse(
|
||||
id='b07dc46a-1498-4de8-bfbb-259a68e70c8a',
|
||||
name='connector-customizer-name',
|
||||
tenant_id='2c91808568c529c60168cca6f90c1324',
|
||||
created=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'),
|
||||
image_version=1,
|
||||
image_id='2c91808568c529c60168cca6f90c1324'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
id: v2024-connector-customizer-version-create-response
|
||||
title: ConnectorCustomizerVersionCreateResponse
|
||||
pagination_label: ConnectorCustomizerVersionCreateResponse
|
||||
sidebar_label: ConnectorCustomizerVersionCreateResponse
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ConnectorCustomizerVersionCreateResponse', 'V2024ConnectorCustomizerVersionCreateResponse']
|
||||
slug: /tools/sdk/python/v2024/models/connector-customizer-version-create-response
|
||||
tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerVersionCreateResponse', 'V2024ConnectorCustomizerVersionCreateResponse']
|
||||
---
|
||||
|
||||
# ConnectorCustomizerVersionCreateResponse
|
||||
|
||||
ConnectorCustomizerVersionCreateResponse
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**customizer_id** | **str** | ID of connector customizer. | [optional]
|
||||
**image_id** | **str** | ImageID of the connector customizer. | [optional]
|
||||
**version** | **int** | Image version of the connector customizer. | [optional]
|
||||
**created** | **datetime** | Date-time when the connector customizer version was created. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.connector_customizer_version_create_response import ConnectorCustomizerVersionCreateResponse
|
||||
|
||||
connector_customizer_version_create_response = ConnectorCustomizerVersionCreateResponse(
|
||||
customizer_id='b07dc46a-1498-4de8-bfbb-259a68e70c8a',
|
||||
image_id='2c91808568c529c60168cca6f90c1324',
|
||||
version=1,
|
||||
created='2022-02-08T14:50:03.827Z'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
id: v2024-connector-customizers-response
|
||||
title: ConnectorCustomizersResponse
|
||||
pagination_label: ConnectorCustomizersResponse
|
||||
sidebar_label: ConnectorCustomizersResponse
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ConnectorCustomizersResponse', 'V2024ConnectorCustomizersResponse']
|
||||
slug: /tools/sdk/python/v2024/models/connector-customizers-response
|
||||
tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizersResponse', 'V2024ConnectorCustomizersResponse']
|
||||
---
|
||||
|
||||
# ConnectorCustomizersResponse
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | Connector customizer ID. | [optional] [readonly]
|
||||
**name** | **str** | Connector customizer name. | [optional]
|
||||
**image_version** | **int** | Connector customizer image version. | [optional]
|
||||
**image_id** | **str** | Connector customizer image id. | [optional]
|
||||
**tenant_id** | **str** | Connector customizer tenant id. | [optional]
|
||||
**created** | **datetime** | Date-time when the connector customizer was created | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.connector_customizers_response import ConnectorCustomizersResponse
|
||||
|
||||
connector_customizers_response = ConnectorCustomizersResponse(
|
||||
id='b07dc46a-1498-4de8-bfbb-259a68e70c8a',
|
||||
name='connector-customizer-name',
|
||||
image_version=1,
|
||||
image_id='2c91808568c529c60168cca6f90c1324',
|
||||
tenant_id='2c91808568c529c60168cca6f90c1324',
|
||||
created=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f')
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -19,7 +19,7 @@ Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**op** | **Enum** [ 'add', 'remove', 'replace', 'move', 'copy', 'test' ] | The operation to be performed | [required]
|
||||
**path** | **str** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required]
|
||||
**value** | [**JsonPatchOperationValue**](json-patch-operation-value) | | [optional]
|
||||
**value** | [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
@@ -1,32 +0,0 @@
|
||||
---
|
||||
id: v2024-json-patch-operation-value
|
||||
title: JsonPatchOperationValue
|
||||
pagination_label: JsonPatchOperationValue
|
||||
sidebar_label: JsonPatchOperationValue
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'JsonPatchOperationValue', 'V2024JsonPatchOperationValue']
|
||||
slug: /tools/sdk/python/v2024/models/json-patch-operation-value
|
||||
tags: ['SDK', 'Software Development Kit', 'JsonPatchOperationValue', 'V2024JsonPatchOperationValue']
|
||||
---
|
||||
|
||||
# JsonPatchOperationValue
|
||||
|
||||
The value to be used for the operation, required for \"add\" and \"replace\" operations
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.json_patch_operation_value import JsonPatchOperationValue
|
||||
|
||||
json_patch_operation_value = JsonPatchOperationValue(
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
id: v2024-managed-cluster-type
|
||||
title: ManagedClusterType
|
||||
pagination_label: ManagedClusterType
|
||||
sidebar_label: ManagedClusterType
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ManagedClusterType', 'V2024ManagedClusterType']
|
||||
slug: /tools/sdk/python/v2024/models/managed-cluster-type
|
||||
tags: ['SDK', 'Software Development Kit', 'ManagedClusterType', 'V2024ManagedClusterType']
|
||||
---
|
||||
|
||||
# ManagedClusterType
|
||||
|
||||
Managed Cluster Type for Cluster upgrade configuration information
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | ManagedClusterType ID | [optional] [readonly]
|
||||
**type** | **str** | ManagedClusterType type name | [required]
|
||||
**pod** | **str** | ManagedClusterType pod | [required]
|
||||
**org** | **str** | ManagedClusterType org | [required]
|
||||
**managed_process_ids** | **[]str** | List of processes for the cluster type | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.managed_cluster_type import ManagedClusterType
|
||||
|
||||
managed_cluster_type = ManagedClusterType(
|
||||
id='aClusterTypeId',
|
||||
type='idn',
|
||||
pod='megapod-useast1',
|
||||
org='denali-cjh',
|
||||
managed_process_ids=[someId, someId2]
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
id: v2024-multi-host-integration-template-type
|
||||
title: MultiHostIntegrationTemplateType
|
||||
pagination_label: MultiHostIntegrationTemplateType
|
||||
sidebar_label: MultiHostIntegrationTemplateType
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationTemplateType', 'V2024MultiHostIntegrationTemplateType']
|
||||
slug: /tools/sdk/python/v2024/models/multi-host-integration-template-type
|
||||
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationTemplateType', 'V2024MultiHostIntegrationTemplateType']
|
||||
---
|
||||
|
||||
# MultiHostIntegrationTemplateType
|
||||
|
||||
This represents a Multi-Host Integration template type.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | This is the name of the type. | [optional]
|
||||
**type** | **str** | This is the type value for the type. | [required]
|
||||
**script_name** | **str** | This is the scriptName attribute value for the type. | [required]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.multi_host_integration_template_type import MultiHostIntegrationTemplateType
|
||||
|
||||
multi_host_integration_template_type = MultiHostIntegrationTemplateType(
|
||||
name='aName',
|
||||
type='aType',
|
||||
script_name='aScriptName'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,121 @@
|
||||
---
|
||||
id: v2024-multi-host-integrations
|
||||
title: MultiHostIntegrations
|
||||
pagination_label: MultiHostIntegrations
|
||||
sidebar_label: MultiHostIntegrations
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrations', 'V2024MultiHostIntegrations']
|
||||
slug: /tools/sdk/python/v2024/models/multi-host-integrations
|
||||
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrations', 'V2024MultiHostIntegrations']
|
||||
---
|
||||
|
||||
# MultiHostIntegrations
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | Multi-Host Integration ID. | [required][readonly]
|
||||
**name** | **str** | Multi-Host Integration's human-readable name. | [required]
|
||||
**description** | **str** | Multi-Host Integration's human-readable description. | [required]
|
||||
**owner** | [**SourceOwner**](source-owner) | | [required]
|
||||
**cluster** | [**SourceCluster**](source-cluster) | | [optional]
|
||||
**account_correlation_config** | [**SourceAccountCorrelationConfig**](source-account-correlation-config) | | [optional]
|
||||
**account_correlation_rule** | [**SourceAccountCorrelationRule**](source-account-correlation-rule) | | [optional]
|
||||
**manager_correlation_mapping** | [**SourceManagerCorrelationMapping**](source-manager-correlation-mapping) | | [optional]
|
||||
**manager_correlation_rule** | [**SourceManagerCorrelationRule**](source-manager-correlation-rule) | | [optional]
|
||||
**before_provisioning_rule** | [**MultiHostIntegrationsBeforeProvisioningRule**](multi-host-integrations-before-provisioning-rule) | | [optional]
|
||||
**schemas** | [**[]SourceSchemasInner**](source-schemas-inner) | List of references to schema objects. | [optional]
|
||||
**password_policies** | [**[]SourcePasswordPoliciesInner**](source-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional]
|
||||
**features** | **[]str** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional]
|
||||
**type** | **str** | Specifies the type of system being managed e.g. Workday, Multi-Host - Microsoft SQL Server, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional]
|
||||
**connector** | **str** | Connector script name. | [required]
|
||||
**connector_class** | **str** | Fully qualified name of the Java class that implements the connector interface. | [optional]
|
||||
**connector_attributes** | [**MultiHostIntegrationsConnectorAttributes**](multi-host-integrations-connector-attributes) | | [optional]
|
||||
**delete_threshold** | **int** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional]
|
||||
**authoritative** | **bool** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to False]
|
||||
**management_workgroup** | [**SourceManagementWorkgroup**](source-management-workgroup) | | [optional]
|
||||
**healthy** | **bool** | When this is true, it indicates that the source is healthy. | [optional] [default to False]
|
||||
**status** | **Enum** [ 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', 'SOURCE_STATE_ERROR_CLUSTER', 'SOURCE_STATE_ERROR_SOURCE', 'SOURCE_STATE_ERROR_VA', 'SOURCE_STATE_FAILURE_CLUSTER', 'SOURCE_STATE_FAILURE_SOURCE', 'SOURCE_STATE_HEALTHY', 'SOURCE_STATE_UNCHECKED_CLUSTER', 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', 'SOURCE_STATE_UNCHECKED_SOURCE', 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' ] | Status identifier that gives specific information about why a source is or isn't healthy. | [optional]
|
||||
**since** | **datetime** | Timestamp that shows when a source health check was last performed. | [optional]
|
||||
**connector_id** | **str** | Connector ID | [optional]
|
||||
**connector_name** | **str** | Name of the connector that was chosen during source creation. | [optional]
|
||||
**connection_type** | **Enum** [ 'direct', 'file' ] | Type of connection (direct or file). | [optional]
|
||||
**connector_implementation_id** | **str** | Connector implementation ID. | [optional]
|
||||
**created** | **datetime** | Date-time when the source was created | [optional]
|
||||
**modified** | **datetime** | Date-time when the source was last modified. | [optional]
|
||||
**credential_provider_enabled** | **bool** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to False]
|
||||
**category** | **str** | Source category (e.g. null, CredentialProvider). | [optional]
|
||||
**accounts_file** | [**MultiHostIntegrationsAccountsFile**](multi-host-integrations-accounts-file) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.multi_host_integrations import MultiHostIntegrations
|
||||
|
||||
multi_host_integrations = MultiHostIntegrations(
|
||||
id='2c91808568c529c60168cca6f90c1324',
|
||||
name='My Multi-Host Integration',
|
||||
description='This is a Multi-Host Integration.',
|
||||
owner=sailpoint.v2024.models.source_owner.Source_owner(
|
||||
type = 'IDENTITY',
|
||||
id = '2c91808568c529c60168cca6f90c1313',
|
||||
name = 'MyName', ),
|
||||
cluster=sailpoint.v2024.models.source_cluster.Source_cluster(
|
||||
type = 'CLUSTER',
|
||||
id = '2c9180866166b5b0016167c32ef31a66',
|
||||
name = 'Corporate Cluster', ),
|
||||
account_correlation_config=sailpoint.v2024.models.source_account_correlation_config.Source_accountCorrelationConfig(
|
||||
type = 'ACCOUNT_CORRELATION_CONFIG',
|
||||
id = '2c9180855d191c59015d28583727245a',
|
||||
name = 'Directory [source-62867] Account Correlation', ),
|
||||
account_correlation_rule=sailpoint.v2024.models.source_account_correlation_rule.Source_accountCorrelationRule(
|
||||
type = 'RULE',
|
||||
id = '2c918085708c274401708c2a8a760001',
|
||||
name = 'Example Rule', ),
|
||||
manager_correlation_mapping=,
|
||||
manager_correlation_rule=sailpoint.v2024.models.source_manager_correlation_rule.Source_managerCorrelationRule(
|
||||
type = 'RULE',
|
||||
id = '2c918085708c274401708c2a8a760001',
|
||||
name = 'Example Rule', ),
|
||||
before_provisioning_rule=sailpoint.v2024.models.multi_host_integrations_before_provisioning_rule.MultiHostIntegrations_beforeProvisioningRule(
|
||||
type = 'RULE',
|
||||
id = '2c918085708c274401708c2a8a760001',
|
||||
name = 'Example Rule', ),
|
||||
schemas=[{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}],
|
||||
password_policies=[{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}],
|
||||
features=[PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS],
|
||||
type='Multi-Host - Microsoft SQL Server',
|
||||
connector='multihost-microsoft-sql-server',
|
||||
connector_class='sailpoint.connector.OpenConnectorAdapter',
|
||||
connector_attributes={multiHostAttributes={password=Password, user=Username, connector_files=mssql-jdbc-8.4.1.jre8.jar, authType=SQLAuthentication}, connectorFileUploadHistory={connectorFileNameUploadedDate=2024-08-29T10:20:38.896479Z}, maxAllowedSources=30, lastSourceUploadCount=50, showEntitlementSchema=true, showAccountSchema=true, multihost_status=ready},
|
||||
delete_threshold=10,
|
||||
authoritative=False,
|
||||
management_workgroup=sailpoint.v2024.models.source_management_workgroup.Source_managementWorkgroup(
|
||||
type = 'GOVERNANCE_GROUP',
|
||||
id = '2c91808568c529c60168cca6f90c2222',
|
||||
name = 'My Management Workgroup', ),
|
||||
healthy=True,
|
||||
status='SOURCE_STATE_HEALTHY',
|
||||
since=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'),
|
||||
connector_id='multihost-microsoft-sql-server',
|
||||
connector_name='Multi-Host Microsoft SQL Server',
|
||||
connection_type='direct',
|
||||
connector_implementation_id='multihost-microsoft-sql-server',
|
||||
created='2022-02-08T14:50:03.827Z',
|
||||
modified='2024-01-23T18:08:50.897Z',
|
||||
credential_provider_enabled=False,
|
||||
category='CredentialProvider',
|
||||
accounts_file=sailpoint.v2024.models.multi_host_integrations_accounts_file.MultiHostIntegrations_accountsFile(
|
||||
name = 'My Accounts File',
|
||||
key = '2c91808568c529c60168cca6f90c2222',
|
||||
upload_time = '2022-02-08T14:50:03.827Z',
|
||||
expiry = '2022-02-08T14:50:03.827Z',
|
||||
expired = False, )
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
id: v2024-multi-host-integrations-accounts-file
|
||||
title: MultiHostIntegrationsAccountsFile
|
||||
pagination_label: MultiHostIntegrationsAccountsFile
|
||||
sidebar_label: MultiHostIntegrationsAccountsFile
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsAccountsFile', 'V2024MultiHostIntegrationsAccountsFile']
|
||||
slug: /tools/sdk/python/v2024/models/multi-host-integrations-accounts-file
|
||||
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsAccountsFile', 'V2024MultiHostIntegrationsAccountsFile']
|
||||
---
|
||||
|
||||
# MultiHostIntegrationsAccountsFile
|
||||
|
||||
Reference to accounts file for the source.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | Name of the accounts file. | [optional]
|
||||
**key** | **str** | The accounts file key. | [optional]
|
||||
**upload_time** | **datetime** | Date-time when the file was uploaded | [optional]
|
||||
**expiry** | **datetime** | Date-time when the accounts file expired. | [optional]
|
||||
**expired** | **bool** | If this is true, it indicates that the accounts file has expired. | [optional] [default to False]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.multi_host_integrations_accounts_file import MultiHostIntegrationsAccountsFile
|
||||
|
||||
multi_host_integrations_accounts_file = MultiHostIntegrationsAccountsFile(
|
||||
name='My Accounts File',
|
||||
key='2c91808568c529c60168cca6f90c2222',
|
||||
upload_time='2022-02-08T14:50:03.827Z',
|
||||
expiry='2022-02-08T14:50:03.827Z',
|
||||
expired=False
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
id: v2024-multi-host-integrations-agg-schedule-update
|
||||
title: MultiHostIntegrationsAggScheduleUpdate
|
||||
pagination_label: MultiHostIntegrationsAggScheduleUpdate
|
||||
sidebar_label: MultiHostIntegrationsAggScheduleUpdate
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsAggScheduleUpdate', 'V2024MultiHostIntegrationsAggScheduleUpdate']
|
||||
slug: /tools/sdk/python/v2024/models/multi-host-integrations-agg-schedule-update
|
||||
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsAggScheduleUpdate', 'V2024MultiHostIntegrationsAggScheduleUpdate']
|
||||
---
|
||||
|
||||
# MultiHostIntegrationsAggScheduleUpdate
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**multihost_id** | **str** | Multi-Host Integration ID. The ID must be unique | [required]
|
||||
**aggregation_grp_id** | **str** | Multi-Host Integration aggregation group ID | [required]
|
||||
**aggregation_grp_name** | **str** | Multi-Host Integration name | [required]
|
||||
**aggregation_cron_schedule** | **str** | Cron expression to schedule aggregation | [required]
|
||||
**enable_schedule** | **bool** | Boolean value for Multi-Host Integration aggregation schedule. This specifies if scheduled aggregation is enabled or disabled. | [required][default to False]
|
||||
**source_id_list** | **[]str** | Source IDs of the Multi-Host Integration | [required]
|
||||
**created** | **datetime** | Created date of Multi-Host Integration aggregation schedule | [optional]
|
||||
**modified** | **datetime** | Modified date of Multi-Host Integration aggregation schedule | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.multi_host_integrations_agg_schedule_update import MultiHostIntegrationsAggScheduleUpdate
|
||||
|
||||
multi_host_integrations_agg_schedule_update = MultiHostIntegrationsAggScheduleUpdate(
|
||||
multihost_id='004091cb79b04636b88662afa50a4456',
|
||||
aggregation_grp_id='004091cb79b04636b88662afa50a4448',
|
||||
aggregation_grp_name='Multi-Host Integration aggregation group name',
|
||||
aggregation_cron_schedule='0 0 0 * * ?',
|
||||
enable_schedule=False,
|
||||
source_id_list=[004091cb79b04636b88662afa50a4440, 00af6d0d562a49b591c47be908740542],
|
||||
created='2024-01-23T18:08:50.897Z',
|
||||
modified='2024-01-23T18:08:50.897Z'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
id: v2024-multi-host-integrations-before-provisioning-rule
|
||||
title: MultiHostIntegrationsBeforeProvisioningRule
|
||||
pagination_label: MultiHostIntegrationsBeforeProvisioningRule
|
||||
sidebar_label: MultiHostIntegrationsBeforeProvisioningRule
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsBeforeProvisioningRule', 'V2024MultiHostIntegrationsBeforeProvisioningRule']
|
||||
slug: /tools/sdk/python/v2024/models/multi-host-integrations-before-provisioning-rule
|
||||
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsBeforeProvisioningRule', 'V2024MultiHostIntegrationsBeforeProvisioningRule']
|
||||
---
|
||||
|
||||
# MultiHostIntegrationsBeforeProvisioningRule
|
||||
|
||||
Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **Enum** [ 'RULE' ] | Type of object being referenced. | [optional]
|
||||
**id** | **str** | Rule ID. | [optional]
|
||||
**name** | **str** | Rule's human-readable display name. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.multi_host_integrations_before_provisioning_rule import MultiHostIntegrationsBeforeProvisioningRule
|
||||
|
||||
multi_host_integrations_before_provisioning_rule = MultiHostIntegrationsBeforeProvisioningRule(
|
||||
type='RULE',
|
||||
id='2c918085708c274401708c2a8a760001',
|
||||
name='Example Rule'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,51 @@
|
||||
---
|
||||
id: v2024-multi-host-integrations-connector-attributes
|
||||
title: MultiHostIntegrationsConnectorAttributes
|
||||
pagination_label: MultiHostIntegrationsConnectorAttributes
|
||||
sidebar_label: MultiHostIntegrationsConnectorAttributes
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsConnectorAttributes', 'V2024MultiHostIntegrationsConnectorAttributes']
|
||||
slug: /tools/sdk/python/v2024/models/multi-host-integrations-connector-attributes
|
||||
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributes', 'V2024MultiHostIntegrationsConnectorAttributes']
|
||||
---
|
||||
|
||||
# MultiHostIntegrationsConnectorAttributes
|
||||
|
||||
Connector specific configuration. This configuration will differ for Multi-Host Integration type.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**max_allowed_sources** | **int** | Maximum sources allowed count of a Multi-Host Integration | [optional]
|
||||
**last_source_upload_count** | **int** | Last upload sources count of a Multi-Host Integration | [optional]
|
||||
**connector_file_upload_history** | [**MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory**](multi-host-integrations-connector-attributes-connector-file-upload-history) | | [optional]
|
||||
**multihost_status** | **Enum** [ 'ready', 'processing', 'fileUploadInProgress', 'sourceCreationInProgress', 'aggregationGroupingInProgress', 'aggregationScheduleInProgress', 'deleteInProgress', 'deleteFailed' ] | Multi-Host integration status. | [optional]
|
||||
**show_account_schema** | **bool** | Show account schema | [optional] [default to True]
|
||||
**show_entitlement_schema** | **bool** | Show entitlement schema | [optional] [default to True]
|
||||
**multi_host_attributes** | [**MultiHostIntegrationsConnectorAttributesMultiHostAttributes**](multi-host-integrations-connector-attributes-multi-host-attributes) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.multi_host_integrations_connector_attributes import MultiHostIntegrationsConnectorAttributes
|
||||
|
||||
multi_host_integrations_connector_attributes = MultiHostIntegrationsConnectorAttributes(
|
||||
max_allowed_sources=250,
|
||||
last_source_upload_count=40,
|
||||
connector_file_upload_history=sailpoint.v2024.models.multi_host_integrations_connector_attributes_connector_file_upload_history.MultiHostIntegrations_connectorAttributes_connectorFileUploadHistory(
|
||||
connector_file_name_uploaded_date = '2024-08-29T10:20:38.896479Z', ),
|
||||
multihost_status='ready',
|
||||
show_account_schema=True,
|
||||
show_entitlement_schema=True,
|
||||
multi_host_attributes=sailpoint.v2024.models.multi_host_integrations_connector_attributes_multi_host_attributes.MultiHostIntegrations_connectorAttributes_multiHostAttributes(
|
||||
password = 'Password',
|
||||
connector_files = 'mssql-jdbc-8.4.1.jre8.jar',
|
||||
auth_type = 'SQLAuthentication',
|
||||
user = 'My Username', )
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
id: v2024-multi-host-integrations-connector-attributes-connector-file-upload-history
|
||||
title: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory
|
||||
pagination_label: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory
|
||||
sidebar_label: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory', 'V2024MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory']
|
||||
slug: /tools/sdk/python/v2024/models/multi-host-integrations-connector-attributes-connector-file-upload-history
|
||||
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory', 'V2024MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory']
|
||||
---
|
||||
|
||||
# MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**connector_file_name_uploaded_date** | **str** | File name of the connector JAR | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.multi_host_integrations_connector_attributes_connector_file_upload_history import MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory
|
||||
|
||||
multi_host_integrations_connector_attributes_connector_file_upload_history = MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory(
|
||||
connector_file_name_uploaded_date='2024-08-29T10:20:38.896479Z'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
id: v2024-multi-host-integrations-connector-attributes-multi-host-attributes
|
||||
title: MultiHostIntegrationsConnectorAttributesMultiHostAttributes
|
||||
pagination_label: MultiHostIntegrationsConnectorAttributesMultiHostAttributes
|
||||
sidebar_label: MultiHostIntegrationsConnectorAttributesMultiHostAttributes
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsConnectorAttributesMultiHostAttributes', 'V2024MultiHostIntegrationsConnectorAttributesMultiHostAttributes']
|
||||
slug: /tools/sdk/python/v2024/models/multi-host-integrations-connector-attributes-multi-host-attributes
|
||||
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributesMultiHostAttributes', 'V2024MultiHostIntegrationsConnectorAttributesMultiHostAttributes']
|
||||
---
|
||||
|
||||
# MultiHostIntegrationsConnectorAttributesMultiHostAttributes
|
||||
|
||||
Attributes of Multi-Host Integration
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**password** | **str** | Password. | [optional]
|
||||
**connector_files** | **str** | Connector file. | [optional]
|
||||
**auth_type** | **str** | Authentication type. | [optional]
|
||||
**user** | **str** | Username. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.multi_host_integrations_connector_attributes_multi_host_attributes import MultiHostIntegrationsConnectorAttributesMultiHostAttributes
|
||||
|
||||
multi_host_integrations_connector_attributes_multi_host_attributes = MultiHostIntegrationsConnectorAttributesMultiHostAttributes(
|
||||
password='Password',
|
||||
connector_files='mssql-jdbc-8.4.1.jre8.jar',
|
||||
auth_type='SQLAuthentication',
|
||||
user='My Username'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
id: v2024-multi-host-integrations-create
|
||||
title: MultiHostIntegrationsCreate
|
||||
pagination_label: MultiHostIntegrationsCreate
|
||||
sidebar_label: MultiHostIntegrationsCreate
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsCreate', 'V2024MultiHostIntegrationsCreate']
|
||||
slug: /tools/sdk/python/v2024/models/multi-host-integrations-create
|
||||
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsCreate', 'V2024MultiHostIntegrationsCreate']
|
||||
---
|
||||
|
||||
# MultiHostIntegrationsCreate
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | Multi-Host Integration's human-readable name. | [required]
|
||||
**description** | **str** | Multi-Host Integration's human-readable description. | [required]
|
||||
**owner** | [**SourceOwner**](source-owner) | | [required]
|
||||
**cluster** | [**SourceCluster**](source-cluster) | | [optional]
|
||||
**connector** | **str** | Connector script name. | [required]
|
||||
**connector_attributes** | **map[string]object** | Multi-Host Integration specific configuration. User can add any number of additional attributes. e.g. maxSourcesPerAggGroup, maxAllowedSources etc. | [optional]
|
||||
**management_workgroup** | [**SourceManagementWorkgroup**](source-management-workgroup) | | [optional]
|
||||
**created** | **datetime** | Date-time when the source was created | [optional]
|
||||
**modified** | **datetime** | Date-time when the source was last modified. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.multi_host_integrations_create import MultiHostIntegrationsCreate
|
||||
|
||||
multi_host_integrations_create = MultiHostIntegrationsCreate(
|
||||
name='My Multi-Host Integration',
|
||||
description='This is the Multi-Host Integration.',
|
||||
owner=sailpoint.v2024.models.source_owner.Source_owner(
|
||||
type = 'IDENTITY',
|
||||
id = '2c91808568c529c60168cca6f90c1313',
|
||||
name = 'MyName', ),
|
||||
cluster=sailpoint.v2024.models.source_cluster.Source_cluster(
|
||||
type = 'CLUSTER',
|
||||
id = '2c9180866166b5b0016167c32ef31a66',
|
||||
name = 'Corporate Cluster', ),
|
||||
connector='multihost-microsoft-sql-server',
|
||||
connector_attributes={maxSourcesPerAggGroup=10, maxAllowedSources=300},
|
||||
management_workgroup=sailpoint.v2024.models.source_management_workgroup.Source_managementWorkgroup(
|
||||
type = 'GOVERNANCE_GROUP',
|
||||
id = '2c91808568c529c60168cca6f90c2222',
|
||||
name = 'My Management Workgroup', ),
|
||||
created='2022-02-08T14:50:03.827Z',
|
||||
modified='2024-01-23T18:08:50.897Z'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
id: v2024-multi-host-integrations-create-sources
|
||||
title: MultiHostIntegrationsCreateSources
|
||||
pagination_label: MultiHostIntegrationsCreateSources
|
||||
sidebar_label: MultiHostIntegrationsCreateSources
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'MultiHostIntegrationsCreateSources', 'V2024MultiHostIntegrationsCreateSources']
|
||||
slug: /tools/sdk/python/v2024/models/multi-host-integrations-create-sources
|
||||
tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsCreateSources', 'V2024MultiHostIntegrationsCreateSources']
|
||||
---
|
||||
|
||||
# MultiHostIntegrationsCreateSources
|
||||
|
||||
This represents sources to be created of same type.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | Source's human-readable name. | [required]
|
||||
**description** | **str** | Source's human-readable description. | [optional]
|
||||
**connector_attributes** | **map[string]object** | Connector specific configuration. This configuration will differ from type to type. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.multi_host_integrations_create_sources import MultiHostIntegrationsCreateSources
|
||||
|
||||
multi_host_integrations_create_sources = MultiHostIntegrationsCreateSources(
|
||||
name='My Source',
|
||||
description='This is the corporate directory.',
|
||||
connector_attributes={authType=SQLAuthentication, url=jdbc:sqlserver://178.18.41.118:1433, user=username, driverClass=com.microsoft.sqlserver.jdbc.SQLServerDriver, maxSourcesPerAggGroup=10, maxAllowedSources=300}
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
116
docs/tools/sdk/python/Reference/V2024/Models/MultiHostSources.md
Normal file
116
docs/tools/sdk/python/Reference/V2024/Models/MultiHostSources.md
Normal file
@@ -0,0 +1,116 @@
|
||||
---
|
||||
id: v2024-multi-host-sources
|
||||
title: MultiHostSources
|
||||
pagination_label: MultiHostSources
|
||||
sidebar_label: MultiHostSources
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'MultiHostSources', 'V2024MultiHostSources']
|
||||
slug: /tools/sdk/python/v2024/models/multi-host-sources
|
||||
tags: ['SDK', 'Software Development Kit', 'MultiHostSources', 'V2024MultiHostSources']
|
||||
---
|
||||
|
||||
# MultiHostSources
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | Source ID. | [required][readonly]
|
||||
**name** | **str** | Source's human-readable name. | [required]
|
||||
**description** | **str** | Source's human-readable description. | [optional]
|
||||
**owner** | [**SourceOwner**](source-owner) | | [required]
|
||||
**cluster** | [**SourceCluster**](source-cluster) | | [optional]
|
||||
**account_correlation_config** | [**SourceAccountCorrelationConfig**](source-account-correlation-config) | | [optional]
|
||||
**account_correlation_rule** | [**SourceAccountCorrelationRule**](source-account-correlation-rule) | | [optional]
|
||||
**manager_correlation_mapping** | [**ManagerCorrelationMapping**](manager-correlation-mapping) | | [optional]
|
||||
**manager_correlation_rule** | [**SourceManagerCorrelationRule**](source-manager-correlation-rule) | | [optional]
|
||||
**before_provisioning_rule** | [**SourceBeforeProvisioningRule**](source-before-provisioning-rule) | | [optional]
|
||||
**schemas** | [**[]SourceSchemasInner**](source-schemas-inner) | List of references to schema objects. | [optional]
|
||||
**password_policies** | [**[]SourcePasswordPoliciesInner**](source-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional]
|
||||
**features** | **[]str** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional]
|
||||
**type** | **str** | Specifies the type of system being managed e.g. Multi-Host - Microsoft SQL Server, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional]
|
||||
**connector** | **str** | Connector script name. | [required]
|
||||
**connector_class** | **str** | Fully qualified name of the Java class that implements the connector interface. | [optional]
|
||||
**connector_attributes** | **map[string]object** | Connector specific configuration. This configuration will differ from type to type. | [optional]
|
||||
**delete_threshold** | **int** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional]
|
||||
**authoritative** | **bool** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to False]
|
||||
**management_workgroup** | [**SourceManagementWorkgroup**](source-management-workgroup) | | [optional]
|
||||
**healthy** | **bool** | When this is true, it indicates that the source is healthy. | [optional] [default to False]
|
||||
**status** | **Enum** [ 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', 'SOURCE_STATE_ERROR_CLUSTER', 'SOURCE_STATE_ERROR_SOURCE', 'SOURCE_STATE_ERROR_VA', 'SOURCE_STATE_FAILURE_CLUSTER', 'SOURCE_STATE_FAILURE_SOURCE', 'SOURCE_STATE_HEALTHY', 'SOURCE_STATE_UNCHECKED_CLUSTER', 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', 'SOURCE_STATE_UNCHECKED_SOURCE', 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' ] | Status identifier that gives specific information about why a source is or isn't healthy. | [optional]
|
||||
**since** | **datetime** | Timestamp that shows when a source health check was last performed. | [optional]
|
||||
**connector_id** | **str** | Connector ID | [optional]
|
||||
**connector_name** | **str** | Name of the connector that was chosen during source creation. | [required]
|
||||
**connection_type** | **str** | Type of connection (direct or file). | [optional]
|
||||
**connector_implementation_id** | **str** | Connector implementation ID. | [optional]
|
||||
**created** | **datetime** | Date-time when the source was created | [optional]
|
||||
**modified** | **datetime** | Date-time when the source was last modified. | [optional]
|
||||
**credential_provider_enabled** | **bool** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to False]
|
||||
**category** | **str** | Source category (e.g. null, CredentialProvider). | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.multi_host_sources import MultiHostSources
|
||||
|
||||
multi_host_sources = MultiHostSources(
|
||||
id='2c91808568c529c60168cca6f90c1324',
|
||||
name='My Source',
|
||||
description='This is the Source.',
|
||||
owner=sailpoint.v2024.models.source_owner.Source_owner(
|
||||
type = 'IDENTITY',
|
||||
id = '2c91808568c529c60168cca6f90c1313',
|
||||
name = 'MyName', ),
|
||||
cluster=sailpoint.v2024.models.source_cluster.Source_cluster(
|
||||
type = 'CLUSTER',
|
||||
id = '2c9180866166b5b0016167c32ef31a66',
|
||||
name = 'Corporate Cluster', ),
|
||||
account_correlation_config=sailpoint.v2024.models.source_account_correlation_config.Source_accountCorrelationConfig(
|
||||
type = 'ACCOUNT_CORRELATION_CONFIG',
|
||||
id = '2c9180855d191c59015d28583727245a',
|
||||
name = 'Directory [source-62867] Account Correlation', ),
|
||||
account_correlation_rule=sailpoint.v2024.models.source_account_correlation_rule.Source_accountCorrelationRule(
|
||||
type = 'RULE',
|
||||
id = '2c918085708c274401708c2a8a760001',
|
||||
name = 'Example Rule', ),
|
||||
manager_correlation_mapping=sailpoint.v2024.models.manager_correlation_mapping.ManagerCorrelationMapping(
|
||||
account_attribute_name = 'manager',
|
||||
identity_attribute_name = 'manager', ),
|
||||
manager_correlation_rule=sailpoint.v2024.models.source_manager_correlation_rule.Source_managerCorrelationRule(
|
||||
type = 'RULE',
|
||||
id = '2c918085708c274401708c2a8a760001',
|
||||
name = 'Example Rule', ),
|
||||
before_provisioning_rule=sailpoint.v2024.models.source_before_provisioning_rule.Source_beforeProvisioningRule(
|
||||
type = 'RULE',
|
||||
id = '2c918085708c274401708c2a8a760001',
|
||||
name = 'Example Rule', ),
|
||||
schemas=[{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}],
|
||||
password_policies=[{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}],
|
||||
features=[PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS],
|
||||
type='Multi-Host - Microsoft SQL Server',
|
||||
connector='multihost-microsoft-sql-server',
|
||||
connector_class='sailpoint.connector.OpenConnectorAdapter',
|
||||
connector_attributes={healthCheckTimeout=30, authSearchAttributes=[cn, uid, mail]},
|
||||
delete_threshold=10,
|
||||
authoritative=False,
|
||||
management_workgroup=sailpoint.v2024.models.source_management_workgroup.Source_managementWorkgroup(
|
||||
type = 'GOVERNANCE_GROUP',
|
||||
id = '2c91808568c529c60168cca6f90c2222',
|
||||
name = 'My Management Workgroup', ),
|
||||
healthy=True,
|
||||
status='SOURCE_STATE_HEALTHY',
|
||||
since=datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'),
|
||||
connector_id='multihost-microsoft-sql-server',
|
||||
connector_name='Multi-Host Microsoft SQL Server',
|
||||
connection_type='file',
|
||||
connector_implementation_id='multihost-microsoft-sql-server',
|
||||
created='2022-02-08T14:50:03.827Z',
|
||||
modified='2024-01-23T18:08:50.897Z',
|
||||
credential_provider_enabled=False,
|
||||
category='CredentialProvider'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**op** | **Enum** [ 'remove', 'replace' ] | The operation to be performed | [optional]
|
||||
**path** | **str** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required]
|
||||
**value** | [**JsonPatchOperationValue**](json-patch-operation-value) | | [optional]
|
||||
**value** | [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
id: v2024-source-creation-errors
|
||||
title: SourceCreationErrors
|
||||
pagination_label: SourceCreationErrors
|
||||
sidebar_label: SourceCreationErrors
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'SourceCreationErrors', 'V2024SourceCreationErrors']
|
||||
slug: /tools/sdk/python/v2024/models/source-creation-errors
|
||||
tags: ['SDK', 'Software Development Kit', 'SourceCreationErrors', 'V2024SourceCreationErrors']
|
||||
---
|
||||
|
||||
# SourceCreationErrors
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**multihost_id** | **str** | Multi-Host Integration ID. | [optional] [readonly]
|
||||
**source_name** | **str** | Source's human-readable name. | [optional]
|
||||
**source_error** | **str** | Source's human-readable description. | [optional]
|
||||
**created** | **datetime** | Date-time when the source was created | [optional]
|
||||
**modified** | **datetime** | Date-time when the source was last modified. | [optional]
|
||||
**operation** | **str** | operation category (e.g. DELETE). | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.source_creation_errors import SourceCreationErrors
|
||||
|
||||
source_creation_errors = SourceCreationErrors(
|
||||
multihost_id='2c91808568c529c60168cca6f90c1324',
|
||||
source_name='My Source',
|
||||
source_error='Source with internal name "My Source [source]" already exists.',
|
||||
created='2022-02-08T14:50:03.827Z',
|
||||
modified='2024-01-23T18:08:50.897Z',
|
||||
operation='DELETE'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
id: v2024-test-source-connection-multihost200-response
|
||||
title: TestSourceConnectionMultihost200Response
|
||||
pagination_label: TestSourceConnectionMultihost200Response
|
||||
sidebar_label: TestSourceConnectionMultihost200Response
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'TestSourceConnectionMultihost200Response', 'V2024TestSourceConnectionMultihost200Response']
|
||||
slug: /tools/sdk/python/v2024/models/test-source-connection-multihost200-response
|
||||
tags: ['SDK', 'Software Development Kit', 'TestSourceConnectionMultihost200Response', 'V2024TestSourceConnectionMultihost200Response']
|
||||
---
|
||||
|
||||
# TestSourceConnectionMultihost200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**success** | **bool** | Source's test connection status. | [optional]
|
||||
**message** | **str** | Source's test connection message. | [optional]
|
||||
**timing** | **int** | Source's test connection timing. | [optional]
|
||||
**result_type** | **Enum** [ 'SOURCE_STATE_ERROR_CLUSTER', 'SOURCE_STATE_ERROR_SOURCE', 'SOURCE_STATE_ERROR_VA', 'SOURCE_STATE_FAILURE_CLUSTER', 'SOURCE_STATE_FAILURE_SOURCE', 'SOURCE_STATE_HEALTHY', 'SOURCE_STATE_UNCHECKED_CLUSTER', 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', 'SOURCE_STATE_UNCHECKED_SOURCE', 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS', 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT' ] | Source's human-readable result type. | [optional]
|
||||
**test_connection_details** | **str** | Source's human-readable test connection details. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.test_source_connection_multihost200_response import TestSourceConnectionMultihost200Response
|
||||
|
||||
test_source_connection_multihost200_response = TestSourceConnectionMultihost200Response(
|
||||
success=True,
|
||||
message='Tes.',
|
||||
timing=56,
|
||||
result_type=SOURCE_STATE_HEALTHY,
|
||||
test_connection_details=''
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
id: v2024-update-multi-host-sources-request-inner
|
||||
title: UpdateMultiHostSourcesRequestInner
|
||||
pagination_label: UpdateMultiHostSourcesRequestInner
|
||||
sidebar_label: UpdateMultiHostSourcesRequestInner
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'UpdateMultiHostSourcesRequestInner', 'V2024UpdateMultiHostSourcesRequestInner']
|
||||
slug: /tools/sdk/python/v2024/models/update-multi-host-sources-request-inner
|
||||
tags: ['SDK', 'Software Development Kit', 'UpdateMultiHostSourcesRequestInner', 'V2024UpdateMultiHostSourcesRequestInner']
|
||||
---
|
||||
|
||||
# UpdateMultiHostSourcesRequestInner
|
||||
|
||||
A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**op** | **Enum** [ 'add', 'replace' ] | The operation to be performed | [required]
|
||||
**path** | **str** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required]
|
||||
**value** | [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.update_multi_host_sources_request_inner import UpdateMultiHostSourcesRequestInner
|
||||
|
||||
update_multi_host_sources_request_inner = UpdateMultiHostSourcesRequestInner(
|
||||
op='replace',
|
||||
path='/description',
|
||||
value=New description
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
id: v2024-update-multi-host-sources-request-inner-value
|
||||
title: UpdateMultiHostSourcesRequestInnerValue
|
||||
pagination_label: UpdateMultiHostSourcesRequestInnerValue
|
||||
sidebar_label: UpdateMultiHostSourcesRequestInnerValue
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'UpdateMultiHostSourcesRequestInnerValue', 'V2024UpdateMultiHostSourcesRequestInnerValue']
|
||||
slug: /tools/sdk/python/v2024/models/update-multi-host-sources-request-inner-value
|
||||
tags: ['SDK', 'Software Development Kit', 'UpdateMultiHostSourcesRequestInnerValue', 'V2024UpdateMultiHostSourcesRequestInnerValue']
|
||||
---
|
||||
|
||||
# UpdateMultiHostSourcesRequestInnerValue
|
||||
|
||||
The value to be used for the operation, required for \"add\" and \"replace\" operations
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.update_multi_host_sources_request_inner_value import UpdateMultiHostSourcesRequestInnerValue
|
||||
|
||||
update_multi_host_sources_request_inner_value = UpdateMultiHostSourcesRequestInnerValue(
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
Reference in New Issue
Block a user