LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 20:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update python SDK docs: 15116515953

Browse Source
This commit is contained in:
developer-relations-sp
2025-05-19 15:05:01 +00:00
parent d73e77c393
commit c8938e0862
279 changed files with 7276 additions and 7276 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
docs/tools/sdk/python/Reference/V2024/Methods/ConnectorsApi.md
View File

@@ -29,23 +29,23 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-custom-connector**](#create-custom-connector) | **POST** `/connectors` | Create Custom Connector
[**delete-custom-connector**](#delete-custom-connector) | **DELETE** `/connectors/{scriptName}` | Delete Connector by Script Name
[**get-connector**](#get-connector) | **GET** `/connectors/{scriptName}` | Get Connector by Script Name
[**get-connector-correlation-config**](#get-connector-correlation-config) | **GET** `/connectors/{scriptName}/correlation-config` | Get Connector Correlation Configuration
[**get-connector-list**](#get-connector-list) | **GET** `/connectors` | Get Connector List
[**get-connector-source-config**](#get-connector-source-config) | **GET** `/connectors/{scriptName}/source-config` | Get Connector Source Configuration
[**get-connector-source-template**](#get-connector-source-template) | **GET** `/connectors/{scriptName}/source-template` | Get Connector Source Template
[**get-connector-translations**](#get-connector-translations) | **GET** `/connectors/{scriptName}/translations/{locale}` | Get Connector Translations
[**put-connector-correlation-config**](#put-connector-correlation-config) | **PUT** `/connectors/{scriptName}/correlation-config` | Update Connector Correlation Configuration
[**put-connector-source-config**](#put-connector-source-config) | **PUT** `/connectors/{scriptName}/source-config` | Update Connector Source Configuration
[**put-connector-source-template**](#put-connector-source-template) | **PUT** `/connectors/{scriptName}/source-template` | Update Connector Source Template
[**put-connector-translations**](#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations
[**update-connector**](#update-connector) | **PATCH** `/connectors/{scriptName}` | Update Connector by Script Name
[**create-custom-connector**](#create-custom-connector) | **POST** `/connectors` | Create custom connector
[**delete-custom-connector**](#delete-custom-connector) | **DELETE** `/connectors/{scriptName}` | Delete connector by script name
[**get-connector**](#get-connector) | **GET** `/connectors/{scriptName}` | Get connector by script name
[**get-connector-correlation-config**](#get-connector-correlation-config) | **GET** `/connectors/{scriptName}/correlation-config` | Get connector correlation configuration
[**get-connector-list**](#get-connector-list) | **GET** `/connectors` | Get connector list
[**get-connector-source-config**](#get-connector-source-config) | **GET** `/connectors/{scriptName}/source-config` | Get connector source configuration
[**get-connector-source-template**](#get-connector-source-template) | **GET** `/connectors/{scriptName}/source-template` | Get connector source template
[**get-connector-translations**](#get-connector-translations) | **GET** `/connectors/{scriptName}/translations/{locale}` | Get connector translations
[**put-connector-correlation-config**](#put-connector-correlation-config) | **PUT** `/connectors/{scriptName}/correlation-config` | Update connector correlation configuration
[**put-connector-source-config**](#put-connector-source-config) | **PUT** `/connectors/{scriptName}/source-config` | Update connector source configuration
[**put-connector-source-template**](#put-connector-source-template) | **PUT** `/connectors/{scriptName}/source-template` | Update connector source template
[**put-connector-translations**](#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update connector translations
[**update-connector**](#update-connector) | **PATCH** `/connectors/{scriptName}` | Update connector by script name
## create-custom-connector
Create Custom Connector
Create custom connector
Create custom connector.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-custom-connector)
@@ -95,7 +95,7 @@ with ApiClient(configuration) as api_client:
}''' # V3CreateConnectorDto |
try:
# Create Custom Connector
# Create custom connector
new_v3_create_connector_dto = V3CreateConnectorDto.from_json(v3_create_connector_dto)
results = ConnectorsApi(api_client).create_custom_connector(v3_create_connector_dto=new_v3_create_connector_dto)
# Below is a request that includes all optional parameters
@@ -111,7 +111,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-custom-connector
Delete Connector by Script Name
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)
@@ -153,7 +153,7 @@ with ApiClient(configuration) as api_client:
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
# Delete connector by script name
ConnectorsApi(api_client).delete_custom_connector(script_name=script_name)
# Below is a request that includes all optional parameters
@@ -167,7 +167,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-connector
Get Connector by Script Name
Get connector by script name
Fetches a connector that using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector)
@@ -212,7 +212,7 @@ with ApiClient(configuration) as api_client:
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
# Get connector by script name
results = ConnectorsApi(api_client).get_connector(script_name=script_name)
# Below is a request that includes all optional parameters
@@ -228,7 +228,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-connector-correlation-config
Get Connector Correlation Configuration
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)
@@ -270,7 +270,7 @@ with ApiClient(configuration) as api_client:
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
# Get connector correlation configuration
results = ConnectorsApi(api_client).get_connector_correlation_config(script_name=script_name)
# Below is a request that includes all optional parameters
@@ -286,7 +286,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-connector-list
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)
@@ -337,7 +337,7 @@ with ApiClient(configuration) as api_client:
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
# Get connector list
results = ConnectorsApi(api_client).get_connector_list()
# Below is a request that includes all optional parameters
@@ -354,7 +354,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-connector-source-config
Get Connector Source Configuration
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)
@@ -396,7 +396,7 @@ with ApiClient(configuration) as api_client:
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
# Get connector source configuration
results = ConnectorsApi(api_client).get_connector_source_config(script_name=script_name)
# Below is a request that includes all optional parameters
@@ -412,7 +412,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-connector-source-template
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)
@@ -454,7 +454,7 @@ with ApiClient(configuration) as api_client:
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
# Get connector source template
results = ConnectorsApi(api_client).get_connector_source_template(script_name=script_name)
# Below is a request that includes all optional parameters
@@ -470,7 +470,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-connector-translations
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)
@@ -514,7 +514,7 @@ with ApiClient(configuration) as api_client:
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
# Get connector translations
results = ConnectorsApi(api_client).get_connector_translations(script_name=script_name, locale=locale)
# Below is a request that includes all optional parameters
@@ -530,7 +530,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-connector-correlation-config
Update Connector Correlation Configuration
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)
@@ -575,7 +575,7 @@ with ApiClient(configuration) as api_client:
file = None # bytearray | connector correlation config xml file # bytearray | connector correlation config xml file
try:
# Update Connector Correlation Configuration
# Update connector correlation configuration
results = ConnectorsApi(api_client).put_connector_correlation_config(script_name=script_name, file=file)
# Below is a request that includes all optional parameters
@@ -591,7 +591,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-connector-source-config
Update Connector Source Configuration
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)
@@ -636,7 +636,7 @@ with ApiClient(configuration) as api_client:
file = None # bytearray | connector source config xml file # bytearray | connector source config xml file
try:
# Update Connector Source Configuration
# Update connector source configuration
results = ConnectorsApi(api_client).put_connector_source_config(script_name=script_name, file=file)
# Below is a request that includes all optional parameters
@@ -652,7 +652,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-connector-source-template
Update 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)
@@ -697,7 +697,7 @@ with ApiClient(configuration) as api_client:
file = None # bytearray | connector source template xml file # bytearray | connector source template xml file
try:
# Update Connector Source Template
# Update connector source template
results = ConnectorsApi(api_client).put_connector_source_template(script_name=script_name, file=file)
# Below is a request that includes all optional parameters
@@ -713,7 +713,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-connector-translations
Update 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)
@@ -758,7 +758,7 @@ with ApiClient(configuration) as api_client:
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
# Update connector translations
results = ConnectorsApi(api_client).put_connector_translations(script_name=script_name, locale=locale)
# Below is a request that includes all optional parameters
@@ -774,7 +774,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-connector
Update Connector by Script Name
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:
@@ -832,7 +832,7 @@ with ApiClient(configuration) as api_client:
json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of connector detail update operations
try:
# Update Connector by Script Name
# Update connector by script name
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = ConnectorsApi(api_client).update_connector(script_name=script_name, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters