ConnectorCustomizers

Saas Connectivity Customizers are cloud-based connector customizers. The customizers allow you to customize the out of the box connectors in a similar way to how you can use rules to customize VA (virtual appliance) based connectors.

Use these APIs to implement connector customizers functionality.

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

Method	HTTP request	Description
New-V2024ConnectorCustomizer	POST /connector-customizers	Create Connector Customizer
New-V2024ConnectorCustomizerVersion	POST /connector-customizers/{id}/versions	Creates a connector customizer version
Remove-V2024ConnectorCustomizer	DELETE /connector-customizers/{id}	Delete Connector Customizer
Get-V2024ConnectorCustomizer	GET /connector-customizers/{id}	Get connector customizer
Get-V2024ConnectorCustomizers	GET /connector-customizers	List All Connector Customizers
Send-V2024ConnectorCustomizer	PUT /connector-customizers/{id}	Update Connector Customizer

create-connector-customizer

Create a connector customizer.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	ConnectorCustomizerCreateRequest	ConnectorCustomizerCreateRequest	True	Connector customizer to create.

Return type

ConnectorCustomizerCreateResponse

Responses

Code	Description	Data Type
201	Created connector customizer.	ConnectorCustomizerCreateResponse
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
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

$ConnectorCustomizerCreateRequest = @"{
  "name" : "My Custom Connector"
}"@

# Create Connector Customizer

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

[Back to top]

create-connector-customizer-version

Creates a new version for the customizer.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	The id of the connector customizer.

Return type

ConnectorCustomizerVersionCreateResponse

Responses

Code	Description	Data Type
200	The created connector customizer version object.	ConnectorCustomizerVersionCreateResponse
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

$Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | The id of the connector customizer.

# Creates a connector customizer version

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

[Back to top]

delete-connector-customizer

Delete the connector customizer for the given ID.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	ID of the connector customizer to delete.

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

$Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to delete.

# Delete Connector Customizer

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

[Back to top]

get-connector-customizer

Gets connector customizer by ID.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	ID of the connector customizer to get.

Return type

ConnectorCustomizersResponse

Responses

Code	Description	Data Type
200	Connector customizer with the given ID.	ConnectorCustomizersResponse
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

$Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to get.

# Get connector customizer

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

[Back to top]

list-connector-customizers

List all connector customizers.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
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	Limit	Int32	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.

Return type

ConnectorCustomizersResponse[]

Responses

Code	Description	Data Type
200	List all connector customizers.	ConnectorCustomizersResponse[]
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
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

$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)
$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)

# List All Connector Customizers

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

[Back to top]

put-connector-customizer

Update an existing connector customizer with the one provided in the request body. These fields are immutable: id, name, type.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	ID of the connector customizer to update.
Body	ConnectorCustomizerUpdateRequest	ConnectorCustomizerUpdateRequest	(optional)	Connector rule with updated data.

Return type

ConnectorCustomizerUpdateResponse

Responses

Code	Description	Data Type
200	Updated connector customizer.	ConnectorCustomizerUpdateResponse
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

$Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to update.
$ConnectorCustomizerUpdateRequest = @"{
  "name" : "My Custom Connector"
}"@

# Update Connector Customizer

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

[Back to top]