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 to python SDK docs: 13820107626

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-12 19:41:45 +00:00
parent 184517209d
commit 113200f5fe
221 changed files with 8723 additions and 7883 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -77,7 +77,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.v3_connector_dto import V3ConnectorDto
@@ -86,25 +85,25 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
v3_create_connector_dto = {
v3_create_connector_dto = '''{
"name" : "custom connector",
"directConnect" : true,
"className" : "sailpoint.connector.OpenConnectorAdapter",
"type" : "custom connector type",
"status" : "RELEASED"
} # V3CreateConnectorDto |
}''' # V3CreateConnectorDto |
try:
# Create Custom Connector
new_v3_create_connector_dto = V3CreateConnectorDto()
new_v3_create_connector_dto.from_json(v3_create_connector_dto)
results =ConnectorsApi(api_client).create_custom_connector(new_v3_create_connector_dto)
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
# results = ConnectorsApi(api_client).create_custom_connector(new_v3_create_connector_dto)
print("The response of ConnectorsApi->create_custom_connector:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConnectorsApi->create_custom_connector: %s\n" % e)
```
@@ -145,23 +144,23 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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
ConnectorsApi(api_client).delete_custom_connector(script_name)
ConnectorsApi(api_client).delete_custom_connector(script_name=script_name)
# Below is a request that includes all optional parameters
# ConnectorsApi(api_client).delete_custom_connector(script_name)
except Exception as e:
except Exception as e:
print("Exception when calling ConnectorsApi->delete_custom_connector: %s\n" % e)
```
@@ -203,7 +202,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.connector_detail import ConnectorDetail
@@ -211,6 +209,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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.
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)
@@ -218,12 +217,12 @@ with ApiClient(configuration) as api_client:
try:
# Get Connector by Script Name
results =ConnectorsApi(api_client).get_connector(script_name, )
results = ConnectorsApi(api_client).get_connector(script_name=script_name)
# Below is a request that includes all optional parameters
# results = ConnectorsApi(api_client).get_connector(script_name, locale)
print("The response of ConnectorsApi->get_connector:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConnectorsApi->get_connector: %s\n" % e)
```
@@ -264,25 +263,25 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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
results =ConnectorsApi(api_client).get_connector_correlation_config(script_name)
results = ConnectorsApi(api_client).get_connector_correlation_config(script_name=script_name)
# Below is a request that includes all optional parameters
# results = ConnectorsApi(api_client).get_connector_correlation_config(script_name)
print("The response of ConnectorsApi->get_connector_correlation_config:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConnectorsApi->get_connector_correlation_config: %s\n" % e)
```
@@ -327,7 +326,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.v3_connector_dto import V3ConnectorDto
@@ -335,6 +333,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
@@ -345,12 +344,12 @@ with ApiClient(configuration) as api_client:
try:
# Get Connector List
results =ConnectorsApi(api_client).get_connector_list()
results = ConnectorsApi(api_client).get_connector_list()
# Below is a request that includes all optional parameters
# results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale)
print("The response of ConnectorsApi->get_connector_list:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e)
```
@@ -391,25 +390,25 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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
results =ConnectorsApi(api_client).get_connector_source_config(script_name)
results = ConnectorsApi(api_client).get_connector_source_config(script_name=script_name)
# Below is a request that includes all optional parameters
# results = ConnectorsApi(api_client).get_connector_source_config(script_name)
print("The response of ConnectorsApi->get_connector_source_config:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConnectorsApi->get_connector_source_config: %s\n" % e)
```
@@ -450,25 +449,25 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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
results =ConnectorsApi(api_client).get_connector_source_template(script_name)
results = ConnectorsApi(api_client).get_connector_source_template(script_name=script_name)
# Below is a request that includes all optional parameters
# results = ConnectorsApi(api_client).get_connector_source_template(script_name)
print("The response of ConnectorsApi->get_connector_source_template:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConnectorsApi->get_connector_source_template: %s\n" % e)
```
@@ -510,13 +509,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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.
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\"
@@ -524,12 +523,12 @@ with ApiClient(configuration) as api_client:
try:
# Get Connector Translations
results =ConnectorsApi(api_client).get_connector_translations(script_name, locale)
results = ConnectorsApi(api_client).get_connector_translations(script_name=script_name, locale=locale)
# Below is a request that includes all optional parameters
# results = ConnectorsApi(api_client).get_connector_translations(script_name, locale)
print("The response of ConnectorsApi->get_connector_translations:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConnectorsApi->get_connector_translations: %s\n" % e)
```
@@ -571,7 +570,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.update_detail import UpdateDetail
@@ -579,6 +577,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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.
file = None # bytearray | connector correlation config xml file # bytearray | connector correlation config xml file
@@ -586,12 +585,12 @@ with ApiClient(configuration) as api_client:
try:
# Update Connector Correlation Configuration
results =ConnectorsApi(api_client).put_connector_correlation_config(script_name, file)
results = ConnectorsApi(api_client).put_connector_correlation_config(script_name=script_name, file=file)
# Below is a request that includes all optional parameters
# results = ConnectorsApi(api_client).put_connector_correlation_config(script_name, file)
print("The response of ConnectorsApi->put_connector_correlation_config:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConnectorsApi->put_connector_correlation_config: %s\n" % e)
```
@@ -633,7 +632,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.update_detail import UpdateDetail
@@ -641,6 +639,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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.
file = None # bytearray | connector source config xml file # bytearray | connector source config xml file
@@ -648,12 +647,12 @@ with ApiClient(configuration) as api_client:
try:
# Update Connector Source Configuration
results =ConnectorsApi(api_client).put_connector_source_config(script_name, file)
results = ConnectorsApi(api_client).put_connector_source_config(script_name=script_name, file=file)
# Below is a request that includes all optional parameters
# results = ConnectorsApi(api_client).put_connector_source_config(script_name, file)
print("The response of ConnectorsApi->put_connector_source_config:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConnectorsApi->put_connector_source_config: %s\n" % e)
```
@@ -695,7 +694,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.update_detail import UpdateDetail
@@ -703,6 +701,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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.
file = None # bytearray | connector source template xml file # bytearray | connector source template xml file
@@ -710,12 +709,12 @@ with ApiClient(configuration) as api_client:
try:
# Update Connector Source Template
results =ConnectorsApi(api_client).put_connector_source_template(script_name, file)
results = ConnectorsApi(api_client).put_connector_source_template(script_name=script_name, file=file)
# Below is a request that includes all optional parameters
# results = ConnectorsApi(api_client).put_connector_source_template(script_name, file)
print("The response of ConnectorsApi->put_connector_source_template:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConnectorsApi->put_connector_source_template: %s\n" % e)
```
@@ -757,7 +756,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.update_detail import UpdateDetail
@@ -765,6 +763,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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.
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\"
@@ -772,12 +771,12 @@ with ApiClient(configuration) as api_client:
try:
# Update Connector Translations
results =ConnectorsApi(api_client).put_connector_translations(script_name, locale)
results = ConnectorsApi(api_client).put_connector_translations(script_name=script_name, locale=locale)
# Below is a request that includes all optional parameters
# results = ConnectorsApi(api_client).put_connector_translations(script_name, locale)
print("The response of ConnectorsApi->put_connector_translations:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConnectorsApi->put_connector_translations: %s\n" % e)
```
@@ -831,7 +830,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.connector_detail import ConnectorDetail
@@ -840,26 +838,20 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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.
[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
json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of connector detail update operations
try:
# Update Connector by Script Name
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =ConnectorsApi(api_client).update_connector(script_name, new_json_patch_operation)
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
# results = ConnectorsApi(api_client).update_connector(script_name, new_json_patch_operation)
print("The response of ConnectorsApi->update_connector:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ConnectorsApi->update_connector: %s\n" % e)
```