Update to powershell SDK docs: 13207859154

2025-12-07 20:37:46 +00:00 · 2025-02-07 20:53:08 +00:00
parent fea17715f4
commit 09ed592191
244 changed files with 12907 additions and 6931 deletions
--- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODPoliciesApi.md
+++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODPoliciesApi.md
@@ -60,10 +60,16 @@ Method | HTTP request | Description
 [**Start-BetaSodAllPoliciesForOrg**](#start-sod-all-policies-for-org) | **POST** `/sod-violation-report/run` | Runs all policies for org
 [**Start-BetaSodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report

+
 ## create-sod-policy
+:::caution deprecated 
+This endpoint has been deprecated and may be replaced or removed in future versions of the API.
+:::
 This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy.
 Requires role of ORG_ADMIN.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/create-sod-policy)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -149,20 +155,26 @@ $SodPolicy = @"{

 try {
    $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
-    New-BetaSodPolicy -BetaSodPolicy $Result
+    New-BetaSodPolicy -BetaSodPolicy $Result 
    
    # Below is a request that includes all optional parameters
-    # New-BetaSodPolicy -BetaSodPolicy $SodPolicy  
+    # New-BetaSodPolicy -BetaSodPolicy $Result  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSodPolicy"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## delete-sod-policy
+:::caution deprecated 
+This endpoint has been deprecated and may be replaced or removed in future versions of the API.
+:::
 This deletes a specified SOD policy.
 Requires role of ORG_ADMIN.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-sod-policy)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -195,20 +207,26 @@ $Logical = $true # Boolean | Indicates whether this is a soft delete (logical tr
 # Delete SOD policy by ID

 try {
-    Remove-BetaSodPolicy -BetaId $Id 
+    Remove-BetaSodPolicy -Id $Id 
    
    # Below is a request that includes all optional parameters
-    # Remove-BetaSodPolicy -BetaId $Id -BetaLogical $Logical  
+    # Remove-BetaSodPolicy -Id $Id -Logical $Logical  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicy"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## delete-sod-policy-schedule
+:::caution deprecated 
+This endpoint has been deprecated and may be replaced or removed in future versions of the API.
+:::
 This deletes schedule for a specified SOD policy.
 Requires role of ORG_ADMIN.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-sod-policy-schedule)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -239,20 +257,26 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy the
 # Delete SOD policy schedule

 try {
-    Remove-BetaSodPolicySchedule -BetaId $Id 
+    Remove-BetaSodPolicySchedule -Id $Id 
    
    # Below is a request that includes all optional parameters
-    # Remove-BetaSodPolicySchedule -BetaId $Id  
+    # Remove-BetaSodPolicySchedule -Id $Id  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicySchedule"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## get-custom-violation-report
+:::caution deprecated 
+This endpoint has been deprecated and may be replaced or removed in future versions of the API.
+:::
 This allows to download a specified named violation report for a given report reference.
 Requires role of ORG_ADMIN.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/get-custom-violation-report)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -285,20 +309,26 @@ $FileName = "custom-name" # String | Custom Name for the  file.
 # Download custom violation report

 try {
-    Get-BetaCustomViolationReport -BetaReportResultId $ReportResultId  -BetaFileName $FileName 
+    Get-BetaCustomViolationReport -ReportResultId $ReportResultId -FileName $FileName 
    
    # Below is a request that includes all optional parameters
-    # Get-BetaCustomViolationReport -BetaReportResultId $ReportResultId -BetaFileName $FileName  
+    # Get-BetaCustomViolationReport -ReportResultId $ReportResultId -FileName $FileName  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomViolationReport"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## get-default-violation-report
+:::caution deprecated 
+This endpoint has been deprecated and may be replaced or removed in future versions of the API.
+:::
 This allows to download a violation report for a given report reference.
 Requires role of ORG_ADMIN.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/get-default-violation-report)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -329,20 +359,26 @@ $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the re
 # Download violation report

 try {
-    Get-BetaDefaultViolationReport -BetaReportResultId $ReportResultId 
+    Get-BetaDefaultViolationReport -ReportResultId $ReportResultId 
    
    # Below is a request that includes all optional parameters
-    # Get-BetaDefaultViolationReport -BetaReportResultId $ReportResultId  
+    # Get-BetaDefaultViolationReport -ReportResultId $ReportResultId  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultViolationReport"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## get-sod-all-report-run-status
+:::caution deprecated 
+This endpoint has been deprecated and may be replaced or removed in future versions of the API.
+:::
 This endpoint gets the status for a violation report for all policy run.
 Requires role of ORG_ADMIN.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sod-all-report-run-status)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -370,7 +406,7 @@ Code | Description  | Data Type
 # Get multi-report run task status

 try {
-    Get-BetaSodAllReportRunStatus
+    Get-BetaSodAllReportRunStatus 
    
    # Below is a request that includes all optional parameters
    # Get-BetaSodAllReportRunStatus  
@@ -380,10 +416,16 @@ try {
 }
 ```
 [[Back to top]](#) 
+
 ## get-sod-policy
+:::caution deprecated 
+This endpoint has been deprecated and may be replaced or removed in future versions of the API.
+:::
 This gets specified SOD policy.
 Requires role of ORG_ADMIN.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sod-policy)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -414,20 +456,26 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object referen
 # Get SOD policy by ID

 try {
-    Get-BetaSodPolicy -BetaId $Id 
+    Get-BetaSodPolicy -Id $Id 
    
    # Below is a request that includes all optional parameters
-    # Get-BetaSodPolicy -BetaId $Id  
+    # Get-BetaSodPolicy -Id $Id  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicy"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## get-sod-policy-schedule
+:::caution deprecated 
+This endpoint has been deprecated and may be replaced or removed in future versions of the API.
+:::
 This endpoint gets a specified SOD policy's schedule.
 Requires the role of ORG_ADMIN.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sod-policy-schedule)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -457,20 +505,26 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object referen
 # Get SOD policy schedule

 try {
-    Get-BetaSodPolicySchedule -BetaId $Id 
+    Get-BetaSodPolicySchedule -Id $Id 
    
    # Below is a request that includes all optional parameters
-    # Get-BetaSodPolicySchedule -BetaId $Id  
+    # Get-BetaSodPolicySchedule -Id $Id  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicySchedule"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## get-sod-violation-report-run-status
+:::caution deprecated 
+This endpoint has been deprecated and may be replaced or removed in future versions of the API.
+:::
 This gets the status for a violation report run task that has already been invoked.
 Requires role of ORG_ADMIN.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sod-violation-report-run-status)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -501,20 +555,26 @@ $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of th
 # Get violation report run status

 try {
-    Get-BetaSodViolationReportRunStatus -BetaReportResultId $ReportResultId 
+    Get-BetaSodViolationReportRunStatus -ReportResultId $ReportResultId 
    
    # Below is a request that includes all optional parameters
-    # Get-BetaSodViolationReportRunStatus -BetaReportResultId $ReportResultId  
+    # Get-BetaSodViolationReportRunStatus -ReportResultId $ReportResultId  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportRunStatus"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## get-sod-violation-report-status
+:::caution deprecated 
+This endpoint has been deprecated and may be replaced or removed in future versions of the API.
+:::
 This gets the status for a violation report run task that has already been invoked.
 Requires role of ORG_ADMIN.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sod-violation-report-status)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -545,20 +605,26 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object referen
 # Get SOD violation report status

 try {
-    Get-BetaSodViolationReportStatus -BetaId $Id 
+    Get-BetaSodViolationReportStatus -Id $Id 
    
    # Below is a request that includes all optional parameters
-    # Get-BetaSodViolationReportStatus -BetaId $Id  
+    # Get-BetaSodViolationReportStatus -Id $Id  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportStatus"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## list-sod-policies
+:::caution deprecated 
+This endpoint has been deprecated and may be replaced or removed in future versions of the API.
+:::
 This gets list of all SOD policies.
 Requires role of ORG_ADMIN

+[API Spec](https://developer.sailpoint.com/docs/api/beta/list-sod-policies)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -596,21 +662,27 @@ $Sorters = "id,name" # String | Sort results using the standard syntax described
 # List SOD policies

 try {
-    Get-BetaSodPolicies
+    Get-BetaSodPolicies 
    
    # Below is a request that includes all optional parameters
-    # Get-BetaSodPolicies -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters  
+    # Get-BetaSodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicies"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## patch-sod-policy
+:::caution deprecated 
+This endpoint has been deprecated and may be replaced or removed in future versions of the API.
+:::
 Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
 Requires role of ORG_ADMIN.
 This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-sod-policy)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -646,20 +718,26 @@ $RequestBody =  # SystemCollectionsHashtable[] | A list of SOD Policy update ope

 try {
    $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
-    Update-BetaSodPolicy -BetaId $Id  -BetaRequestBody $Result
+    Update-BetaSodPolicy -Id $Id -RequestBody $Result 
    
    # Below is a request that includes all optional parameters
-    # Update-BetaSodPolicy -BetaId $Id -BetaRequestBody $RequestBody  
+    # Update-BetaSodPolicy -Id $Id -RequestBody $Result  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSodPolicy"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## put-policy-schedule
+:::caution deprecated 
+This endpoint has been deprecated and may be replaced or removed in future versions of the API.
+:::
 This updates schedule for a specified SOD policy.
 Requires role of ORG_ADMIN.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/put-policy-schedule)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -777,20 +855,26 @@ $SodPolicySchedule = @"{

 try {
    $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule
-    Send-BetaPolicySchedule -BetaId $Id  -BetaSodPolicySchedule $Result
+    Send-BetaPolicySchedule -Id $Id -BetaSodPolicySchedule $Result 
    
    # Below is a request that includes all optional parameters
-    # Send-BetaPolicySchedule -BetaId $Id -BetaSodPolicySchedule $SodPolicySchedule  
+    # Send-BetaPolicySchedule -Id $Id -BetaSodPolicySchedule $Result  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPolicySchedule"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## put-sod-policy
+:::caution deprecated 
+This endpoint has been deprecated and may be replaced or removed in future versions of the API.
+:::
 This updates a specified SOD policy.
 Requires role of ORG_ADMIN.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/put-sod-policy)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -879,20 +963,26 @@ $SodPolicy = @"{

 try {
    $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
-    Send-BetaSodPolicy -BetaId $Id  -BetaSodPolicy $Result
+    Send-BetaSodPolicy -Id $Id -BetaSodPolicy $Result 
    
    # Below is a request that includes all optional parameters
-    # Send-BetaSodPolicy -BetaId $Id -BetaSodPolicy $SodPolicy  
+    # Send-BetaSodPolicy -Id $Id -BetaSodPolicy $Result  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSodPolicy"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## start-sod-all-policies-for-org
+:::caution deprecated 
+This endpoint has been deprecated and may be replaced or removed in future versions of the API.
+:::
 Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided.
 Requires role of ORG_ADMIN.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/start-sod-all-policies-for-org)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -924,20 +1014,26 @@ $MultiPolicyRequest = @"{
 # Runs all policies for org

 try {
-    Start-BetaSodAllPoliciesForOrg
+    Start-BetaSodAllPoliciesForOrg 
    
    # Below is a request that includes all optional parameters
-    # Start-BetaSodAllPoliciesForOrg -BetaMultiPolicyRequest $MultiPolicyRequest  
+    # Start-BetaSodAllPoliciesForOrg -BetaMultiPolicyRequest $Result  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodAllPoliciesForOrg"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## start-sod-policy
+:::caution deprecated 
+This endpoint has been deprecated and may be replaced or removed in future versions of the API.
+:::
 This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message.
 Requires role of ORG_ADMIN.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/start-sod-policy)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -968,10 +1064,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The SOD policy ID to run.
 # Runs SOD policy violation report

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