sailpoint.v3.VendorConnectorMappingsApi

All URIs are relative to https://sailpoint.api.identitynow.com/v3

Method	HTTP request	Description
create-vendor-connector-mapping	POST /vendor-connector-mappings	Create Vendor Connector Mapping
delete-vendor-connector-mapping	DELETE /vendor-connector-mappings	Delete Vendor Connector Mapping
get-vendor-connector-mappings	GET /vendor-connector-mappings	List Vendor Connector Mappings

create-vendor-connector-mapping

Create Vendor Connector Mapping Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	vendor_connector_mapping	VendorConnectorMapping	True

Return type

VendorConnectorMapping

Responses

Code	Description	Data Type	Response headers
200	Successfully created a new vendor connector mapping.	VendorConnectorMapping	-
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	-
405	Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method.	GetVendorConnectorMappings405Response	-
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.v3.api.vendor_connector_mappings_api import VendorConnectorMappingsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.vendor_connector_mapping import VendorConnectorMapping
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    vendor_connector_mapping = '''{
          "createdAt" : "2024-03-13T12:56:19.391294Z",
          "deletedAt" : {
            "Valid" : false,
            "Time" : "0001-01-01T00:00:00Z"
          },
          "updatedBy" : {
            "Valid" : true,
            "String" : "user-67891"
          },
          "connector" : "Example connector",
          "createdBy" : "admin",
          "vendor" : "Example vendor",
          "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4",
          "deletedBy" : {
            "Valid" : false,
            "String" : ""
          },
          "updatedAt" : {
            "Valid" : true,
            "Time" : "2024-03-14T12:56:19.391294Z"
          }
        }''' # VendorConnectorMapping | 

    try:
        # Create Vendor Connector Mapping
        new_vendor_connector_mapping = VendorConnectorMapping.from_json(vendor_connector_mapping)
        results = VendorConnectorMappingsApi(api_client).create_vendor_connector_mapping(vendor_connector_mapping=new_vendor_connector_mapping)
        # Below is a request that includes all optional parameters
        # results = VendorConnectorMappingsApi(api_client).create_vendor_connector_mapping(new_vendor_connector_mapping)
        print("The response of VendorConnectorMappingsApi->create_vendor_connector_mapping:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e)

[Back to top]

delete-vendor-connector-mapping

Delete Vendor Connector Mapping Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	vendor_connector_mapping	VendorConnectorMapping	True

Return type

DeleteVendorConnectorMapping200Response

Responses

Code	Description	Data Type	Response headers
200	Successfully deleted the specified vendor connector mapping.	DeleteVendorConnectorMapping200Response	-
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.v3.api.vendor_connector_mappings_api import VendorConnectorMappingsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.delete_vendor_connector_mapping200_response import DeleteVendorConnectorMapping200Response
from sailpoint.v3.models.vendor_connector_mapping import VendorConnectorMapping
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    vendor_connector_mapping = '''{
          "createdAt" : "2024-03-13T12:56:19.391294Z",
          "deletedAt" : {
            "Valid" : false,
            "Time" : "0001-01-01T00:00:00Z"
          },
          "updatedBy" : {
            "Valid" : true,
            "String" : "user-67891"
          },
          "connector" : "Example connector",
          "createdBy" : "admin",
          "vendor" : "Example vendor",
          "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4",
          "deletedBy" : {
            "Valid" : false,
            "String" : ""
          },
          "updatedAt" : {
            "Valid" : true,
            "Time" : "2024-03-14T12:56:19.391294Z"
          }
        }''' # VendorConnectorMapping | 

    try:
        # Delete Vendor Connector Mapping
        new_vendor_connector_mapping = VendorConnectorMapping.from_json(vendor_connector_mapping)
        results = VendorConnectorMappingsApi(api_client).delete_vendor_connector_mapping(vendor_connector_mapping=new_vendor_connector_mapping)
        # Below is a request that includes all optional parameters
        # results = VendorConnectorMappingsApi(api_client).delete_vendor_connector_mapping(new_vendor_connector_mapping)
        print("The response of VendorConnectorMappingsApi->delete_vendor_connector_mapping:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e)

[Back to top]

get-vendor-connector-mappings

List Vendor Connector Mappings Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation.

API Spec

Parameters

This endpoint does not need any parameter.

Return type

List[VendorConnectorMapping]

Responses

Code	Description	Data Type	Response headers
200	Successfully retrieved list.	List[VendorConnectorMapping]	-
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	-
405	Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method.	GetVendorConnectorMappings405Response	-
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.v3.api.vendor_connector_mappings_api import VendorConnectorMappingsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.vendor_connector_mapping import VendorConnectorMapping
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:

    try:
        # List Vendor Connector Mappings
        
        results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings()
        # Below is a request that includes all optional parameters
        # results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings()
        print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e)

[Back to top]