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

Update to powershell SDK docs: 13122455471

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-03 20:42:04 +00:00
parent aeda961e54
commit bdb088c15d
207 changed files with 3520 additions and 8694 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
docs/tools/sdk/powershell/Reference/V3/Methods/ConnectorsApi.md
View File

@@ -1,3 +1,4 @@
---
id: connectors
title: Connectors
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/connectors
tags: ['SDK', 'Software Development Kit', 'Connectors', 'Connectors']
---
# Connectors
Use this API to implement connector functionality.
With this functionality in place, administrators can view available connectors.
@@ -44,9 +44,7 @@ Method | HTTP request | Description
[**Send-ConnectorTranslations**](#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations
[**Update-Connector**](#update-connector) | **PATCH** `/connectors/{scriptName}` | Update Connector by Script Name
## create-custom-connector
Create custom connector.
### Parameters
@@ -55,7 +53,6 @@ Param Type | Name | Data Type | Required | Description
Body | V3CreateConnectorDto | [**V3CreateConnectorDto**](../models/v3-create-connector-dto) | True |
### Return type
[**V3ConnectorDto**](../models/v3-connector-dto)
### Responses
@@ -70,7 +67,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -83,7 +79,9 @@ $V3CreateConnectorDto = @"{
"type" : "custom connector type",
"status" : "RELEASED"
}"@
# Create Custom Connector
try {
$Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto
New-CustomConnector-V3CreateConnectorDto $Result
@@ -95,11 +93,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-custom-connector
Delete a custom connector that using its script name.
### Parameters
@@ -108,7 +103,6 @@ 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
@@ -123,14 +117,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$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
@@ -141,11 +136,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector
Fetches a connector that using its script name.
### Parameters
@@ -155,7 +147,6 @@ Path | ScriptName | **String** | True | The scriptName value of the connector
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**](../models/connector-detail)
### Responses
@@ -170,7 +161,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -178,7 +168,9 @@ Code | Description | Data Type
```powershell
$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
@@ -189,11 +181,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector-list
Fetches list of connectors that have 'RELEASED' status using filtering and pagination.
### Parameters
@@ -206,7 +195,6 @@ Param Type | Name | Data Type | Required | Description
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[]**](../models/v3-connector-dto)
### Responses
@@ -221,7 +209,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -232,7 +219,9 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$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
@@ -243,11 +232,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector-source-config
Fetches a connector's source config using its script name.
### Parameters
@@ -256,7 +242,6 @@ 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
@@ -271,14 +256,15 @@ Code | Description | Data Type
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
```powershell
$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
@@ -289,11 +275,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector-source-template
Fetches a connector's source template using its script name.
### Parameters
@@ -302,7 +285,6 @@ 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
@@ -317,14 +299,15 @@ Code | Description | Data Type
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
```powershell
$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
@@ -335,11 +318,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector-translations
Fetches a connector's translations using its script name.
### Parameters
@@ -349,7 +329,6 @@ Path | ScriptName | **String** | True | The scriptName value of the connector
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
@@ -364,7 +343,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain, application/json
@@ -372,7 +350,9 @@ Code | Description | Data Type
```powershell
$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
@@ -383,11 +363,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-connector-source-config
Update a connector's source config using its script name.
### Parameters
@@ -397,7 +374,6 @@ Path | ScriptName | **String** | True | The scriptName value of the connector
| File | **System.IO.FileInfo** | True | connector source config xml file
### Return type
[**UpdateDetail**](../models/update-detail)
### Responses
@@ -412,7 +388,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
@@ -420,7 +395,9 @@ Code | Description | Data Type
```powershell
$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
@@ -431,11 +408,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-connector-source-template
Update a connector's source template using its script name.
### Parameters
@@ -445,7 +419,6 @@ Path | ScriptName | **String** | True | The scriptName value of the connector
| File | **System.IO.FileInfo** | True | connector source template xml file
### Return type
[**UpdateDetail**](../models/update-detail)
### Responses
@@ -460,7 +433,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
@@ -468,7 +440,9 @@ Code | Description | Data Type
```powershell
$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
@@ -479,11 +453,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-connector-translations
Update a connector's translations using its script name.
### Parameters
@@ -493,7 +464,6 @@ Path | ScriptName | **String** | True | The scriptName value of the connector
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**](../models/update-detail)
### Responses
@@ -508,7 +478,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
@@ -516,7 +485,9 @@ Code | Description | Data Type
```powershell
$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
@@ -527,11 +498,8 @@ try {
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.
The following fields are patchable:
@@ -553,7 +521,6 @@ Path | ScriptName | **String** | True | The scriptName value of the connector
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of connector detail update operations
### Return type
[**ConnectorDetail**](../models/connector-detail)
### Responses
@@ -568,21 +535,21 @@ Code | Description | Data Type
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
```powershell
$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
# JsonPatchOperation[] | A list of connector detail update operations
$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
@@ -594,7 +561,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)