LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-06 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

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

@@ -30,10 +30,13 @@ 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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-connector-rule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -89,20 +92,23 @@ $ConnectorRuleCreateRequest = @"{
try {
$Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest
New-BetaConnectorRule -BetaConnectorRuleCreateRequest $Result
New-BetaConnectorRule -BetaConnectorRuleCreateRequest $Result
# Below is a request that includes all optional parameters
# New-BetaConnectorRule -BetaConnectorRuleCreateRequest $ConnectorRuleCreateRequest
# New-BetaConnectorRule -BetaConnectorRuleCreateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaConnectorRule"
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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-connector-rule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -133,20 +139,23 @@ $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to
# Delete a Connector-Rule
try {
Remove-BetaConnectorRule -BetaId $Id
Remove-BetaConnectorRule -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaConnectorRule -BetaId $Id
# Remove-BetaConnectorRule -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaConnectorRule"
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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-connector-rule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -177,20 +186,23 @@ $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to
# Connector-Rule by ID
try {
Get-BetaConnectorRule -BetaId $Id
Get-BetaConnectorRule -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaConnectorRule -BetaId $Id
# Get-BetaConnectorRule -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorRule"
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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-connector-rule-list)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -218,7 +230,7 @@ Code | Description | Data Type
# List Connector Rules
try {
Get-BetaConnectorRuleList
Get-BetaConnectorRuleList
# Below is a request that includes all optional parameters
# Get-BetaConnectorRuleList
@@ -228,10 +240,13 @@ try {
}
```
[[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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/update-connector-rule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -290,20 +305,23 @@ $ConnectorRuleUpdateRequest = @"{
# Update a Connector Rule
try {
Update-BetaConnectorRule -BetaId $Id
Update-BetaConnectorRule -Id $Id
# Below is a request that includes all optional parameters
# Update-BetaConnectorRule -BetaId $Id -BetaConnectorRuleUpdateRequest $ConnectorRuleUpdateRequest
# Update-BetaConnectorRule -Id $Id -BetaConnectorRuleUpdateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaConnectorRule"
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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/validate-connector-rule)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -337,10 +355,10 @@ $SourceCode = @"{
try {
$Result = ConvertFrom-JsonToSourceCode -Json $SourceCode
Confirm-BetaConnectorRule -BetaSourceCode $Result
Confirm-BetaConnectorRule -BetaSourceCode $Result
# Below is a request that includes all optional parameters
# Confirm-BetaConnectorRule -BetaSourceCode $SourceCode
# Confirm-BetaConnectorRule -BetaSourceCode $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Confirm-BetaConnectorRule"
Write-Host $_.ErrorDetails