LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 20:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to powershell SDK docs: 13207859154

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-07 20:53:08 +00:00
parent fea17715f4
commit 09ed592191
244 changed files with 12907 additions and 6931 deletions
Download Patch File Download Diff File Expand all files Collapse all files

91
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorsApi.md
View File

@@ -45,9 +45,12 @@ Method | HTTP request | Description
[**Send-V2024ConnectorTranslations**](#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations
[**Update-V2024Connector**](#update-connector) | **PATCH** `/connectors/{scriptName}` | Update Connector by Script Name
## create-custom-connector
Create custom connector.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-custom-connector)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -85,19 +88,22 @@ $V3CreateConnectorDto = @"{
try {
$Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto
New-V2024CustomConnector -V2024V3CreateConnectorDto $Result
New-V2024CustomConnector -V2024V3CreateConnectorDto $Result
# Below is a request that includes all optional parameters
# New-V2024CustomConnector -V2024V3CreateConnectorDto $V3CreateConnectorDto
# New-V2024CustomConnector -V2024V3CreateConnectorDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CustomConnector"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-custom-connector
Delete a custom connector that using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-custom-connector)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -128,19 +134,22 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc
# Delete Connector by Script Name
try {
Remove-V2024CustomConnector -V2024ScriptName $ScriptName
Remove-V2024CustomConnector -ScriptName $ScriptName
# Below is a request that includes all optional parameters
# Remove-V2024CustomConnector -V2024ScriptName $ScriptName
# Remove-V2024CustomConnector -ScriptName $ScriptName
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CustomConnector"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector
Fetches a connector that using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -173,19 +182,22 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale
# Get Connector by Script Name
try {
Get-V2024Connector -V2024ScriptName $ScriptName
Get-V2024Connector -ScriptName $ScriptName
# Below is a request that includes all optional parameters
# Get-V2024Connector -V2024ScriptName $ScriptName -V2024Locale $Locale
# Get-V2024Connector -ScriptName $ScriptName -Locale $Locale
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Connector"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector-correlation-config
Fetches a connector's correlation config using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-correlation-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -216,19 +228,22 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc
# Get Connector Correlation Configuration
try {
Get-V2024ConnectorCorrelationConfig -V2024ScriptName $ScriptName
Get-V2024ConnectorCorrelationConfig -ScriptName $ScriptName
# Below is a request that includes all optional parameters
# Get-V2024ConnectorCorrelationConfig -V2024ScriptName $ScriptName
# Get-V2024ConnectorCorrelationConfig -ScriptName $ScriptName
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorCorrelationConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector-list
Fetches list of connectors that have 'RELEASED' status using filtering and pagination.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-list)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -267,19 +282,22 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale
# Get Connector List
try {
Get-V2024ConnectorList
Get-V2024ConnectorList
# Below is a request that includes all optional parameters
# Get-V2024ConnectorList -V2024Filters $Filters -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Locale $Locale
# Get-V2024ConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorList"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector-source-config
Fetches a connector's source config using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-source-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -310,19 +328,22 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc
# Get Connector Source Configuration
try {
Get-V2024ConnectorSourceConfig -V2024ScriptName $ScriptName
Get-V2024ConnectorSourceConfig -ScriptName $ScriptName
# Below is a request that includes all optional parameters
# Get-V2024ConnectorSourceConfig -V2024ScriptName $ScriptName
# Get-V2024ConnectorSourceConfig -ScriptName $ScriptName
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorSourceConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector-source-template
Fetches a connector's source template using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-source-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -353,19 +374,22 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc
# Get Connector Source Template
try {
Get-V2024ConnectorSourceTemplate -V2024ScriptName $ScriptName
Get-V2024ConnectorSourceTemplate -ScriptName $ScriptName
# Below is a request that includes all optional parameters
# Get-V2024ConnectorSourceTemplate -V2024ScriptName $ScriptName
# Get-V2024ConnectorSourceTemplate -ScriptName $ScriptName
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorSourceTemplate"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector-translations
Fetches a connector's translations using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-translations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -398,19 +422,22 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale
# Get Connector Translations
try {
Get-V2024ConnectorTranslations -V2024ScriptName $ScriptName -V2024Locale $Locale
Get-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale
# Below is a request that includes all optional parameters
# Get-V2024ConnectorTranslations -V2024ScriptName $ScriptName -V2024Locale $Locale
# Get-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorTranslations"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-connector-correlation-config
Update a connector's correlation config using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-correlation-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -443,19 +470,22 @@ $File = # System.IO.FileInfo | connector correlation config xml file
# Update Connector Correlation Configuration
try {
Send-V2024ConnectorCorrelationConfig -V2024ScriptName $ScriptName -V2024File $File
Send-V2024ConnectorCorrelationConfig -ScriptName $ScriptName -File $File
# Below is a request that includes all optional parameters
# Send-V2024ConnectorCorrelationConfig -V2024ScriptName $ScriptName -V2024File $File
# Send-V2024ConnectorCorrelationConfig -ScriptName $ScriptName -File $File
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorCorrelationConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-connector-source-config
Update a connector's source config using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-source-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -488,19 +518,22 @@ $File = # System.IO.FileInfo | connector source config xml file
# Update Connector Source Configuration
try {
Send-V2024ConnectorSourceConfig -V2024ScriptName $ScriptName -V2024File $File
Send-V2024ConnectorSourceConfig -ScriptName $ScriptName -File $File
# Below is a request that includes all optional parameters
# Send-V2024ConnectorSourceConfig -V2024ScriptName $ScriptName -V2024File $File
# Send-V2024ConnectorSourceConfig -ScriptName $ScriptName -File $File
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorSourceConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-connector-source-template
Update a connector's source template using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-source-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -533,19 +566,22 @@ $File = # System.IO.FileInfo | connector source template xml file
# Update Connector Source Template
try {
Send-V2024ConnectorSourceTemplate -V2024ScriptName $ScriptName -V2024File $File
Send-V2024ConnectorSourceTemplate -ScriptName $ScriptName -File $File
# Below is a request that includes all optional parameters
# Send-V2024ConnectorSourceTemplate -V2024ScriptName $ScriptName -V2024File $File
# Send-V2024ConnectorSourceTemplate -ScriptName $ScriptName -File $File
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorSourceTemplate"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-connector-translations
Update a connector's translations using its script name.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-translations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -578,16 +614,17 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale
# Update Connector Translations
try {
Send-V2024ConnectorTranslations -V2024ScriptName $ScriptName -V2024Locale $Locale
Send-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale
# Below is a request that includes all optional parameters
# Send-V2024ConnectorTranslations -V2024ScriptName $ScriptName -V2024Locale $Locale
# Send-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorTranslations"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-connector
This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
@@ -603,6 +640,8 @@ The following fields are patchable:
* sourceConfigXml
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-connector)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -641,10 +680,10 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024Connector -V2024ScriptName $ScriptName -V2024JsonPatchOperation $Result
Update-V2024Connector -ScriptName $ScriptName -V2024JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024Connector -V2024ScriptName $ScriptName -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024Connector -ScriptName $ScriptName -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Connector"
Write-Host $_.ErrorDetails