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

46
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaConnectorRuleManagementApi.md
View File

@@ -1,3 +1,4 @@
---
id: beta-connector-rule-management
title: ConnectorRuleManagement
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/connector-rule-management
tags: ['SDK', 'Software Development Kit', 'ConnectorRuleManagement', 'BetaConnectorRuleManagement']
---
# ConnectorRuleManagement
Use this API to implement connector rule management functionality.
With this functionality in place, administrators can implement connector-executed rules in a programmatic, scalable way.
@@ -31,9 +31,7 @@ Method | HTTP request | Description
[**Update-BetaConnectorRule**](#update-connector-rule) | **PUT** `/connector-rules/{id}` | Update a Connector Rule
[**Confirm-BetaConnectorRule**](#validate-connector-rule) | **POST** `/connector-rules/validate` | Validate Connector Rule
## create-connector-rule
Creates a new connector rule.
A token with ORG_ADMIN authority is required to call this API.
@@ -43,7 +41,6 @@ Param Type | Name | Data Type | Required | Description
Body | ConnectorRuleCreateRequest | [**ConnectorRuleCreateRequest**](../models/connector-rule-create-request) | True | The connector rule to create
### Return type
[**ConnectorRuleResponse**](../models/connector-rule-response)
### Responses
@@ -57,7 +54,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
@@ -89,7 +85,9 @@ $ConnectorRuleCreateRequest = @"{
"attributes" : { },
"type" : "BuildMap"
}"@
# Create Connector Rule
try {
$Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest
New-BetaConnectorRule-BetaConnectorRuleCreateRequest $Result
@@ -101,11 +99,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-connector-rule
Deletes the connector rule specified by the given ID.
A token with ORG_ADMIN authority is required to call this API.
@@ -115,7 +110,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the connector rule to delete
### Return type
(empty response body)
### Responses
@@ -130,14 +124,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
$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete
# Delete a Connector-Rule
try {
Remove-BetaConnectorRule-BetaId $Id
@@ -148,11 +143,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector-rule
Returns the connector rule specified by ID.
A token with ORG_ADMIN authority is required to call this API.
@@ -162,7 +154,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the connector rule to retrieve
### Return type
[**ConnectorRuleResponse**](../models/connector-rule-response)
### Responses
@@ -177,14 +168,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
$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to retrieve
# Connector-Rule by ID
try {
Get-BetaConnectorRule-BetaId $Id
@@ -195,11 +187,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-connector-rule-list
Returns the list of connector rules.
A token with ORG_ADMIN authority is required to call this API.
@@ -208,7 +197,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**ConnectorRuleResponse[]**](../models/connector-rule-response)
### Responses
@@ -222,13 +210,14 @@ 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
# List Connector Rules
try {
Get-BetaConnectorRuleList
@@ -239,11 +228,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-connector-rule
Updates an existing connector rule with the one provided in the request body. Note that the fields 'id', 'name', and 'type' are immutable.
A token with ORG_ADMIN authority is required to call this API.
@@ -254,7 +240,6 @@ Path | Id | **String** | True | ID of the connector rule to update
Body | ConnectorRuleUpdateRequest | [**ConnectorRuleUpdateRequest**](../models/connector-rule-update-request) | (optional) | The connector rule with updated data
### Return type
[**ConnectorRuleResponse**](../models/connector-rule-response)
### Responses
@@ -269,7 +254,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
@@ -303,7 +287,9 @@ $ConnectorRuleUpdateRequest = @"{
"id" : "8113d48c0b914f17b4c6072d4dcb9dfe",
"type" : "BuildMap"
}"@
# Update a Connector Rule
try {
Update-BetaConnectorRule-BetaId $Id
@@ -314,11 +300,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## validate-connector-rule
Returns a list of issues within the code to fix, if any.
A token with ORG_ADMIN authority is required to call this API.
@@ -328,7 +311,6 @@ Param Type | Name | Data Type | Required | Description
Body | SourceCode | [**SourceCode**](../models/source-code) | True | The code to validate
### Return type
[**ConnectorRuleValidationResponse**](../models/connector-rule-validation-response)
### Responses
@@ -342,7 +324,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
@@ -352,7 +333,9 @@ $SourceCode = @"{
"version" : "1.0",
"script" : "return \"Mr. \" + firstName;"
}"@
# Validate Connector Rule
try {
$Result = ConvertFrom-JsonToSourceCode -Json $SourceCode
Confirm-BetaConnectorRule-BetaSourceCode $Result
@@ -364,7 +347,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)