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 for more information about the connectors available in Identity Security Cloud.

Refer to 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 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	POST `/connectors`	Create Custom Connector
delete-custom-connector	DELETE `/connectors/{scriptName}`	Delete Connector by Script Name
get-connector	GET `/connectors/{scriptName}`	Get Connector by Script Name
get-connector-correlation-config	GET `/connectors/{scriptName}/correlation-config`	Get Connector Correlation Configuration
get-connector-list	GET `/connectors`	Get Connector List
get-connector-source-config	GET `/connectors/{scriptName}/source-config`	Get Connector Source Configuration
get-connector-source-template	GET `/connectors/{scriptName}/source-template`	Get Connector Source Template
get-connector-translations	GET `/connectors/{scriptName}/translations/{locale}`	Get Connector Translations
put-connector-correlation-config	PUT `/connectors/{scriptName}/correlation-config`	Update Connector Correlation Configuration
put-connector-source-config	PUT `/connectors/{scriptName}/source-config`	Update Connector Source Configuration
put-connector-source-template	PUT `/connectors/{scriptName}/source-template`	Update Connector Source Template
put-connector-translations	PUT `/connectors/{scriptName}/translations/{locale}`	Update Connector Translations
update-connector	PATCH `/connectors/{scriptName}`	Update Connector by Script Name

create-custom-connector

Create Custom Connector Create custom connector.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	v3_create_connector_dto	V3CreateConnectorDto	True

Return type

V3ConnectorDto

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

from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.v3_connector_dto import V3ConnectorDto
from sailpoint.v2024.models.v3_create_connector_dto import V3CreateConnectorDto
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    v3_create_connector_dto = '''{
          "name" : "custom connector",
          "directConnect" : true,
          "className" : "sailpoint.connector.OpenConnectorAdapter",
          "type" : "custom connector type",
          "status" : "RELEASED"
        }''' # V3CreateConnectorDto | 

    try:
        # 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
        # results = ConnectorsApi(api_client).create_custom_connector(new_v3_create_connector_dto)
        print("The response of ConnectorsApi->create_custom_connector:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    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

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

from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
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=script_name)
        # Below is a request that includes all optional parameters
        # ConnectorsApi(api_client).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

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

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

from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.connector_detail import ConnectorDetail
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)

    try:
        # Get Connector by 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")
        print(results.model_dump_json(by_alias=True, indent=4))
    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

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

from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
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=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")
        print(results.model_dump_json(by_alias=True, indent=4))
    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

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 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 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 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 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]

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

from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.v3_connector_dto import V3ConnectorDto
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)
    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
        
        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")
        print(results.model_dump_json(by_alias=True, indent=4))
    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

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

from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
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=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")
        print(results.model_dump_json(by_alias=True, indent=4))
    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

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

from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
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=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")
        print(results.model_dump_json(by_alias=True, indent=4))
    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

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

from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
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\"

    try:
        # 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
        # results = ConnectorsApi(api_client).get_connector_translations(script_name, locale)
        print("The response of ConnectorsApi->get_connector_translations:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    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

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

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

from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.update_detail import UpdateDetail
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

    try:
        # 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
        # results = ConnectorsApi(api_client).put_connector_correlation_config(script_name, file)
        print("The response of ConnectorsApi->put_connector_correlation_config:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    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

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

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

from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.update_detail import UpdateDetail
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

    try:
        # 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
        # results = ConnectorsApi(api_client).put_connector_source_config(script_name, file)
        print("The response of ConnectorsApi->put_connector_source_config:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    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

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

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

from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.update_detail import UpdateDetail
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

    try:
        # 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
        # results = ConnectorsApi(api_client).put_connector_source_template(script_name, file)
        print("The response of ConnectorsApi->put_connector_source_template:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    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

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

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

from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.update_detail import UpdateDetail
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\"

    try:
        # 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
        # results = ConnectorsApi(api_client).put_connector_translations(script_name, locale)
        print("The response of ConnectorsApi->put_connector_translations:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    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 syntax.

The following fields are patchable:

connectorMetadata
applicationXml
correlationConfigXml
sourceConfigXml

API Spec

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	True	A list of connector detail update operations

Return type

ConnectorDetail

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

from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.connector_detail import ConnectorDetail
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
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.
    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.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")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling ConnectorsApi->update_connector: %s\n" % e)

[Back to top]

create-custom-connector​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

delete-custom-connector​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-connector​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-connector-correlation-config​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-connector-list​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-connector-source-config​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-connector-source-template​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-connector-translations​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

put-connector-correlation-config​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

put-connector-source-config​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

put-connector-source-template​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

put-connector-translations​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

update-connector​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

create-custom-connector

Parameters

Return type

Responses

HTTP request headers

Example

delete-custom-connector

Parameters

Return type

Responses

HTTP request headers

Example

get-connector

Parameters

Return type

Responses

HTTP request headers

Example

get-connector-correlation-config

Parameters

Return type

Responses

HTTP request headers

Example

get-connector-list

Parameters

Return type

Responses

HTTP request headers

Example

get-connector-source-config

Parameters

Return type

Responses

HTTP request headers

Example

get-connector-source-template

Parameters

Return type

Responses

HTTP request headers

Example

get-connector-translations

Parameters

Return type

Responses

HTTP request headers

Example

put-connector-correlation-config

Parameters

Return type

Responses

HTTP request headers

Example

put-connector-source-config

Parameters

Return type

Responses

HTTP request headers

Example

put-connector-source-template

Parameters

Return type

Responses

HTTP request headers

Example

put-connector-translations

Parameters

Return type

Responses

HTTP request headers

Example

update-connector

Parameters

Return type

Responses

HTTP request headers

Example