Connectors

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/v3

Method	HTTP request	Description
New-CustomConnector	POST `/connectors`	Create Custom Connector
Remove-CustomConnector	DELETE `/connectors/{scriptName}`	Delete Connector by Script Name
Get-Connector	GET `/connectors/{scriptName}`	Get Connector by Script Name
Get-ConnectorList	GET `/connectors`	Get Connector List
Get-ConnectorSourceConfig	GET `/connectors/{scriptName}/source-config`	Get Connector Source Configuration
Get-ConnectorSourceTemplate	GET `/connectors/{scriptName}/source-template`	Get Connector Source Template
Get-ConnectorTranslations	GET `/connectors/{scriptName}/translations/{locale}`	Get Connector Translations
Send-ConnectorSourceConfig	PUT `/connectors/{scriptName}/source-config`	Update Connector Source Configuration
Send-ConnectorSourceTemplate	PUT `/connectors/{scriptName}/source-template`	Update Connector Source Template
Send-ConnectorTranslations	PUT `/connectors/{scriptName}/translations/{locale}`	Update Connector Translations
Update-Connector	PATCH `/connectors/{scriptName}`	Update Connector by Script Name

create-custom-connector

Create custom connector.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	V3CreateConnectorDto	V3CreateConnectorDto	True

Return type

V3ConnectorDto

Responses

Code	Description	Data Type
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

$V3CreateConnectorDto = @"{
  "name" : "custom connector",
  "directConnect" : true,
  "className" : "sailpoint.connector.OpenConnectorAdapter",
  "type" : "custom connector type",
  "status" : "RELEASED"
}"@

# Create Custom Connector

try {
    $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto
    New-CustomConnector -V3CreateConnectorDto $Result 
    
    # Below is a request that includes all optional parameters
    # New-CustomConnector -V3CreateConnectorDto $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CustomConnector"
    Write-Host $_.ErrorDetails
}

[Back to top]

delete-custom-connector

Delete a custom connector that using its script name.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	ScriptName	String	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
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

$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.

# Delete Connector by Script Name

try {
    Remove-CustomConnector -ScriptName $ScriptName 
    
    # Below is a request that includes all optional parameters
    # Remove-CustomConnector -ScriptName $ScriptName  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CustomConnector"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-connector

Fetches a connector that using its script name.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	ScriptName	String	True	The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
Query	Locale	String	(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
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

$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional)

# Get Connector by Script Name

try {
    Get-Connector -ScriptName $ScriptName 
    
    # Below is a request that includes all optional parameters
    # Get-Connector -ScriptName $ScriptName -Locale $Locale  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Connector"
    Write-Host $_.ErrorDetails
}

[Back to top]

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	String	(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	Int32	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query	Offset	Int32	(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	Boolean	(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	String	(optional)	The locale to apply to the config. If no viable locale is given, it will default to ""en""

Return type

V3ConnectorDto[]

Responses

Code	Description	Data Type
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: Not defined
Accept: application/json

Example

$Filters = 'directConnect eq "true"' # String | 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 # Int32 | 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 # Int32 | 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 = $true # Boolean | 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" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional)

# Get Connector List

try {
    Get-ConnectorList 
    
    # Below is a request that includes all optional parameters
    # Get-ConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorList"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-connector-source-config

Fetches a connector's source config using its script name.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	ScriptName	String	True	The scriptName value of the connector. ScriptName is the unique id generated at connector creation.

Return type

String

Responses

Code	Description	Data Type
200	The connector's source template	String
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

$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.

# Get Connector Source Configuration

try {
    Get-ConnectorSourceConfig -ScriptName $ScriptName 
    
    # Below is a request that includes all optional parameters
    # Get-ConnectorSourceConfig -ScriptName $ScriptName  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorSourceConfig"
    Write-Host $_.ErrorDetails
}

[Back to top]

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	ScriptName	String	True	The scriptName value of the connector. ScriptName is the unique id generated at connector creation.

Return type

String

Responses

Code	Description	Data Type
200	The connector's source template	String
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

$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.

# Get Connector Source Template

try {
    Get-ConnectorSourceTemplate -ScriptName $ScriptName 
    
    # Below is a request that includes all optional parameters
    # Get-ConnectorSourceTemplate -ScriptName $ScriptName  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorSourceTemplate"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-connector-translations

Fetches a connector's translations using its script name.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	ScriptName	String	True	The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
Path	Locale	String	True	The locale to apply to the config. If no viable locale is given, it will default to ""en""

Return type

String

Responses

Code	Description	Data Type
200	The connector's translations	String
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

$ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en""

# Get Connector Translations

try {
    Get-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale 
    
    # Below is a request that includes all optional parameters
    # Get-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorTranslations"
    Write-Host $_.ErrorDetails
}

[Back to top]

put-connector-source-config

Update a connector's source config using its script name.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	ScriptName	String	True	The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
File	System.IO.FileInfo	True	connector source config xml file

Return type

UpdateDetail

Responses

Code	Description	Data Type
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

$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
$File =  # System.IO.FileInfo | connector source config xml file

# Update Connector Source Configuration

try {
    Send-ConnectorSourceConfig -ScriptName $ScriptName -File $File 
    
    # Below is a request that includes all optional parameters
    # Send-ConnectorSourceConfig -ScriptName $ScriptName -File $File  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorSourceConfig"
    Write-Host $_.ErrorDetails
}

[Back to top]

put-connector-source-template

Update a connector's source template using its script name.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	ScriptName	String	True	The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
File	System.IO.FileInfo	True	connector source template xml file

Return type

UpdateDetail

Responses

Code	Description	Data Type
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

$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
$File =  # System.IO.FileInfo | connector source template xml file

# Update Connector Source Template

try {
    Send-ConnectorSourceTemplate -ScriptName $ScriptName -File $File 
    
    # Below is a request that includes all optional parameters
    # Send-ConnectorSourceTemplate -ScriptName $ScriptName -File $File  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorSourceTemplate"
    Write-Host $_.ErrorDetails
}

[Back to top]

put-connector-translations

Update a connector's translations using its script name.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	ScriptName	String	True	The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
Path	Locale	String	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
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

$ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en""

# Update Connector Translations

try {
    Send-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale 
    
    # Below is a request that includes all optional parameters
    # Send-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorTranslations"
    Write-Host $_.ErrorDetails
}

[Back to top]

update-connector

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	ScriptName	String	True	The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
Body	JsonPatchOperation	[]JsonPatchOperation	True	A list of connector detail update operations

Return type

ConnectorDetail

Responses

Code	Description	Data Type
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

$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
 $JsonPatchOperation = @"{
  "op" : "replace",
  "path" : "/description",
  "value" : "New description"
}"@ # JsonPatchOperation[] | A list of connector detail update operations 
 

# Update Connector by Script Name

try {
    $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
    Update-Connector -ScriptName $ScriptName -JsonPatchOperation $Result 
    
    # Below is a request that includes all optional parameters
    # Update-Connector -ScriptName $ScriptName -JsonPatchOperation $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Connector"
    Write-Host $_.ErrorDetails
}

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