mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 12:27:47 +00:00
starting point for adding python sdk docs
This commit is contained in:
darrell-thobe-sp
830
docs/tools/sdk/python/Reference/V2024/Methods/ConnectorsApi.md
Normal file
830
docs/tools/sdk/python/Reference/V2024/Methods/ConnectorsApi.md
Normal file
@@ -0,0 +1,830 @@
|
||||
---
|
||||
id: v2024-connectors
|
||||
title: Connectors
|
||||
pagination_label: Connectors
|
||||
sidebar_label: Connectors
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'Connectors', 'V2024Connectors']
|
||||
slug: /tools/sdk/python/v2024/methods/connectors
|
||||
tags: ['SDK', 'Software Development Kit', 'Connectors', 'V2024Connectors']
|
||||
---
|
||||
|
||||
# sailpoint.v2024.ConnectorsApi
|
||||
Use this API to implement connector functionality.
|
||||
With this functionality in place, administrators can view available connectors.
|
||||
|
||||
Connectors are the bridges Identity Security Cloud uses to communicate with and aggregate data from sources.
|
||||
For example, if it is necessary to set up a connection between Identity Security Cloud and the Active Directory source, a connector can bridge the two and enable Identity Security Cloud to synchronize data between the systems.
|
||||
This ensures account entitlements and states are correct throughout the organization.
|
||||
|
||||
In Identity Security Cloud, administrators can use the Connections drop-down menu and select Sources to view the available source connectors.
|
||||
|
||||
Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about the connectors available in Identity Security Cloud.
|
||||
|
||||
Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about the SaaS custom connectors that do not need VAs (virtual appliances) to communicate with their sources.
|
||||
|
||||
Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about using connectors in Identity Security Cloud.
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_custom_connector**](ConnectorsApi#create-custom-connector) | **POST** `/connectors` | Create Custom Connector
|
||||
[**delete_custom_connector**](ConnectorsApi#delete-custom-connector) | **DELETE** `/connectors/{scriptName}` | Delete Connector by Script Name
|
||||
[**get_connector**](ConnectorsApi#get-connector) | **GET** `/connectors/{scriptName}` | Get Connector by Script Name
|
||||
[**get_connector_correlation_config**](ConnectorsApi#get-connector-correlation-config) | **GET** `/connectors/{scriptName}/correlation-config` | Get Connector Correlation Configuration
|
||||
[**get_connector_list**](ConnectorsApi#get-connector-list) | **GET** `/connectors` | Get Connector List
|
||||
[**get_connector_source_config**](ConnectorsApi#get-connector-source-config) | **GET** `/connectors/{scriptName}/source-config` | Get Connector Source Configuration
|
||||
[**get_connector_source_template**](ConnectorsApi#get-connector-source-template) | **GET** `/connectors/{scriptName}/source-template` | Get Connector Source Template
|
||||
[**get_connector_translations**](ConnectorsApi#get-connector-translations) | **GET** `/connectors/{scriptName}/translations/{locale}` | Get Connector Translations
|
||||
[**put_connector_correlation_config**](ConnectorsApi#put-connector-correlation-config) | **PUT** `/connectors/{scriptName}/correlation-config` | Update Connector Correlation Configuration
|
||||
[**put_connector_source_config**](ConnectorsApi#put-connector-source-config) | **PUT** `/connectors/{scriptName}/source-config` | Update Connector Source Configuration
|
||||
[**put_connector_source_template**](ConnectorsApi#put-connector-source-template) | **PUT** `/connectors/{scriptName}/source-template` | Update Connector Source Template
|
||||
[**put_connector_translations**](ConnectorsApi#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations
|
||||
[**update_connector**](ConnectorsApi#update-connector) | **PATCH** `/connectors/{scriptName}` | Update Connector by Script Name
|
||||
|
||||
|
||||
## create-custom-connector
|
||||
Create Custom Connector
|
||||
Create custom connector.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-custom-connector)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Body | v3_create_connector_dto | [**V3CreateConnectorDto**](../models/v3-create-connector-dto) | True |
|
||||
|
||||
### Return type
|
||||
[**V3ConnectorDto**](../models/v3-connector-dto)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | A Connector Dto object | V3ConnectorDto | - |
|
||||
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
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.models.v3_connector_dto import V3ConnectorDto
|
||||
from sailpoint.v2024.models.v3_create_connector_dto import V3CreateConnectorDto
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
v3_create_connector_dto = {
|
||||
"name" : "custom connector",
|
||||
"directConnect" : true,
|
||||
"className" : "sailpoint.connector.OpenConnectorAdapter",
|
||||
"type" : "custom connector type",
|
||||
"status" : "RELEASED"
|
||||
} # V3CreateConnectorDto |
|
||||
|
||||
try:
|
||||
# Create Custom Connector
|
||||
Result = v3_create_connector_dto.from_json(v3_create_connector_dto)
|
||||
api_response = api_instance.create_custom_connector(Result)
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.create_custom_connector(Result)
|
||||
print("The response of ConnectorsApi->create_custom_connector:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling ConnectorsApi->create_custom_connector: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-custom-connector
|
||||
Delete Connector by Script Name
|
||||
Delete a custom connector that using its script name.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-custom-connector)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | script_name | **str** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
||||
|
||||
### 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
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
||||
|
||||
try:
|
||||
# Delete Connector by Script Name
|
||||
|
||||
api_instance.delete_custom_connector(script_name)
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_instance.delete_custom_connector(script_name)
|
||||
except Exception as e:
|
||||
print("Exception when calling ConnectorsApi->delete_custom_connector: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-connector
|
||||
Get Connector by Script Name
|
||||
Fetches a connector that using its script name.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | script_name | **str** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
||||
Query | locale | **str** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to \"en\"
|
||||
|
||||
### Return type
|
||||
[**ConnectorDetail**](../models/connector-detail)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | A Connector Dto 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 | - |
|
||||
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
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.models.connector_detail import ConnectorDetail
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
||||
locale = 'de' # 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:
|
||||
# Get Connector by Script Name
|
||||
|
||||
api_response = api_instance.get_connector(script_name, )
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.get_connector(script_name, locale)
|
||||
print("The response of ConnectorsApi->get_connector:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling ConnectorsApi->get_connector: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-connector-correlation-config
|
||||
Get Connector Correlation Configuration
|
||||
Fetches a connector's correlation config using its script name.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-correlation-config)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | script_name | **str** | True | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
|
||||
|
||||
### Return type
|
||||
**str**
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | The connector's correlation config | str | - |
|
||||
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/xml, application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
script_name = 'aScriptName' # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
|
||||
|
||||
try:
|
||||
# Get Connector Correlation Configuration
|
||||
|
||||
api_response = api_instance.get_connector_correlation_config(script_name)
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.get_connector_correlation_config(script_name)
|
||||
print("The response of ConnectorsApi->get_connector_correlation_config:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling ConnectorsApi->get_connector_correlation_config: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-connector-list
|
||||
Get Connector List
|
||||
Fetches list of connectors that have 'RELEASED' status using filtering and pagination.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-list)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca*
|
||||
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 | 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.
|
||||
Query | locale | **str** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to \"en\"
|
||||
|
||||
### Return type
|
||||
[**List[V3ConnectorDto]**](../models/v3-connector-dto)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | A Connector Dto object | List[V3ConnectorDto] | - |
|
||||
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
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.models.v3_connector_dto import V3ConnectorDto
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
filters = 'directConnect eq \"true\"' # 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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional)
|
||||
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)
|
||||
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)
|
||||
locale = 'de' # 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:
|
||||
# Get Connector List
|
||||
|
||||
api_response = api_instance.get_connector_list()
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.get_connector_list(filters, limit, offset, count, locale)
|
||||
print("The response of ConnectorsApi->get_connector_list:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-connector-source-config
|
||||
Get Connector Source Configuration
|
||||
Fetches a connector's source config using its script name.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-source-config)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | script_name | **str** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
||||
|
||||
### Return type
|
||||
**str**
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | The connector's source template | str | - |
|
||||
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/xml, application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
||||
|
||||
try:
|
||||
# Get Connector Source Configuration
|
||||
|
||||
api_response = api_instance.get_connector_source_config(script_name)
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.get_connector_source_config(script_name)
|
||||
print("The response of ConnectorsApi->get_connector_source_config:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling ConnectorsApi->get_connector_source_config: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-connector-source-template
|
||||
Get Connector Source Template
|
||||
Fetches a connector's source template using its script name.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-source-template)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | script_name | **str** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
||||
|
||||
### Return type
|
||||
**str**
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | The connector's source template | str | - |
|
||||
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/xml, application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
||||
|
||||
try:
|
||||
# Get Connector Source Template
|
||||
|
||||
api_response = api_instance.get_connector_source_template(script_name)
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.get_connector_source_template(script_name)
|
||||
print("The response of ConnectorsApi->get_connector_source_template:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling ConnectorsApi->get_connector_source_template: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-connector-translations
|
||||
Get Connector Translations
|
||||
Fetches a connector's translations using its script name.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-translations)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | script_name | **str** | True | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
|
||||
Path | locale | **str** | True | The locale to apply to the config. If no viable locale is given, it will default to \"en\"
|
||||
|
||||
### Return type
|
||||
**str**
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | The connector's translations | str | - |
|
||||
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**: text/plain, application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
script_name = 'aScriptName' # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
|
||||
locale = 'de' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\"
|
||||
|
||||
try:
|
||||
# Get Connector Translations
|
||||
|
||||
api_response = api_instance.get_connector_translations(script_name, locale)
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.get_connector_translations(script_name, locale)
|
||||
print("The response of ConnectorsApi->get_connector_translations:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling ConnectorsApi->get_connector_translations: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## put-connector-correlation-config
|
||||
Update Connector Correlation Configuration
|
||||
Update a connector's correlation config using its script name.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-correlation-config)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | script_name | **str** | True | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
|
||||
| file | **bytearray** | True | connector correlation config xml file
|
||||
|
||||
### Return type
|
||||
[**UpdateDetail**](../models/update-detail)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | The connector's update detail | UpdateDetail | - |
|
||||
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**: multipart/form-data
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.models.update_detail import UpdateDetail
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
script_name = 'aScriptName' # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
|
||||
file = None # bytearray | connector correlation config xml file # bytearray | connector correlation config xml file
|
||||
|
||||
try:
|
||||
# Update Connector Correlation Configuration
|
||||
|
||||
api_response = api_instance.put_connector_correlation_config(script_name, file)
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.put_connector_correlation_config(script_name, file)
|
||||
print("The response of ConnectorsApi->put_connector_correlation_config:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling ConnectorsApi->put_connector_correlation_config: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## put-connector-source-config
|
||||
Update Connector Source Configuration
|
||||
Update a connector's source config using its script name.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-source-config)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | script_name | **str** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
||||
| file | **bytearray** | True | connector source config xml file
|
||||
|
||||
### Return type
|
||||
[**UpdateDetail**](../models/update-detail)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | The connector's update detail | UpdateDetail | - |
|
||||
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**: multipart/form-data
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.models.update_detail import UpdateDetail
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
||||
file = None # bytearray | connector source config xml file # bytearray | connector source config xml file
|
||||
|
||||
try:
|
||||
# Update Connector Source Configuration
|
||||
|
||||
api_response = api_instance.put_connector_source_config(script_name, file)
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.put_connector_source_config(script_name, file)
|
||||
print("The response of ConnectorsApi->put_connector_source_config:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling ConnectorsApi->put_connector_source_config: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## put-connector-source-template
|
||||
Update Connector Source Template
|
||||
Update a connector's source template using its script name.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-source-template)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | script_name | **str** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
||||
| file | **bytearray** | True | connector source template xml file
|
||||
|
||||
### Return type
|
||||
[**UpdateDetail**](../models/update-detail)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | The connector's update detail | UpdateDetail | - |
|
||||
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**: multipart/form-data
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.models.update_detail import UpdateDetail
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
||||
file = None # bytearray | connector source template xml file # bytearray | connector source template xml file
|
||||
|
||||
try:
|
||||
# Update Connector Source Template
|
||||
|
||||
api_response = api_instance.put_connector_source_template(script_name, file)
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.put_connector_source_template(script_name, file)
|
||||
print("The response of ConnectorsApi->put_connector_source_template:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling ConnectorsApi->put_connector_source_template: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## put-connector-translations
|
||||
Update Connector Translations
|
||||
Update a connector's translations using its script name.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-translations)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | script_name | **str** | True | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
|
||||
Path | locale | **str** | True | The locale to apply to the config. If no viable locale is given, it will default to \"en\"
|
||||
|
||||
### Return type
|
||||
[**UpdateDetail**](../models/update-detail)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | The connector's update detail | UpdateDetail | - |
|
||||
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**: multipart/form-data
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.models.update_detail import UpdateDetail
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
script_name = 'aScriptName' # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
|
||||
locale = 'de' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\"
|
||||
|
||||
try:
|
||||
# Update Connector Translations
|
||||
|
||||
api_response = api_instance.put_connector_translations(script_name, locale)
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.put_connector_translations(script_name, locale)
|
||||
print("The response of ConnectorsApi->put_connector_translations:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling ConnectorsApi->put_connector_translations: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## update-connector
|
||||
Update Connector by Script Name
|
||||
This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
|
||||
|
||||
The following fields are patchable:
|
||||
|
||||
|
||||
* connectorMetadata
|
||||
|
||||
* applicationXml
|
||||
|
||||
* correlationConfigXml
|
||||
|
||||
* sourceConfigXml
|
||||
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-connector)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | script_name | **str** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
||||
Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of connector detail update operations
|
||||
|
||||
### Return type
|
||||
[**ConnectorDetail**](../models/connector-detail)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | A updated Connector Dto 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 | - |
|
||||
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
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.models.connector_detail import ConnectorDetail
|
||||
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
||||
[sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | A list of connector detail update operations
|
||||
json_patch_operation = {
|
||||
"op" : "replace",
|
||||
"path" : "/description",
|
||||
"value" : "New description"
|
||||
} # List[JsonPatchOperation] | A list of connector detail update operations
|
||||
|
||||
|
||||
try:
|
||||
# Update Connector by Script Name
|
||||
Result = json_patch_operation.from_json(json_patch_operation)
|
||||
api_response = api_instance.update_connector(script_name, Result)
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.update_connector(script_name, Result)
|
||||
print("The response of ConnectorsApi->update_connector:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling ConnectorsApi->update_connector: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user