mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 20:37:46 +00:00
Update to powershell SDK docs: 13207859154
This commit is contained in:
developer-relations-sp
@@ -61,10 +61,13 @@ Method | HTTP request | Description
|
||||
[**Start-SodAllPoliciesForOrg**](#start-sod-all-policies-for-org) | **POST** `/sod-violation-report/run` | Runs all policies for org
|
||||
[**Start-SodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report
|
||||
|
||||
|
||||
## create-sod-policy
|
||||
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/v3/create-sod-policy)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -150,20 +153,23 @@ $SodPolicy = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
|
||||
New-SodPolicy -SodPolicy $Result
|
||||
New-SodPolicy -SodPolicy $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-SodPolicy -SodPolicy $SodPolicy
|
||||
# New-SodPolicy -SodPolicy $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-sod-policy
|
||||
This deletes a specified SOD policy.
|
||||
Requires role of ORG_ADMIN.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-sod-policy)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -206,9 +212,12 @@ try {
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-sod-policy-schedule
|
||||
This deletes schedule for a specified SOD policy by ID.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-sod-policy-schedule)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -249,9 +258,12 @@ try {
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-custom-violation-report
|
||||
This allows to download a specified named violation report for a given report reference.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-custom-violation-report)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -284,7 +296,7 @@ $FileName = "custom-name" # String | Custom Name for the file.
|
||||
# Download custom violation report
|
||||
|
||||
try {
|
||||
Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName
|
||||
Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName
|
||||
@@ -294,9 +306,12 @@ try {
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-default-violation-report
|
||||
This allows to download a violation report for a given report reference.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-default-violation-report)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -337,9 +352,12 @@ try {
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-sod-all-report-run-status
|
||||
This endpoint gets the status for a violation report for all policy run.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-all-report-run-status)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -367,7 +385,7 @@ Code | Description | Data Type
|
||||
# Get multi-report run task status
|
||||
|
||||
try {
|
||||
Get-SodAllReportRunStatus
|
||||
Get-SodAllReportRunStatus
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-SodAllReportRunStatus
|
||||
@@ -377,10 +395,13 @@ try {
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-sod-policy
|
||||
This gets specified SOD policy.
|
||||
Requires role of ORG_ADMIN.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-policy)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -421,9 +442,12 @@ try {
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-sod-policy-schedule
|
||||
This endpoint gets a specified SOD policy's schedule.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-policy-schedule)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -463,9 +487,12 @@ try {
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-sod-violation-report-run-status
|
||||
This gets the status for a violation report run task that has already been invoked.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-violation-report-run-status)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -506,9 +533,12 @@ try {
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-sod-violation-report-status
|
||||
This gets the status for a violation report run task that has already been invoked.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-violation-report-status)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -549,10 +579,13 @@ try {
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-sod-policies
|
||||
This gets list of all SOD policies.
|
||||
Requires role of ORG_ADMIN
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-sod-policies)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -590,7 +623,7 @@ $Sorters = "id,name" # String | Sort results using the standard syntax described
|
||||
# List SOD policies
|
||||
|
||||
try {
|
||||
Get-SodPolicies
|
||||
Get-SodPolicies
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
|
||||
@@ -600,11 +633,14 @@ try {
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## patch-sod-policy
|
||||
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/v3/patch-sod-policy)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -643,19 +679,22 @@ $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
||||
Update-SodPolicy -Id $Id -JsonPatchOperation $Result
|
||||
Update-SodPolicy -Id $Id -JsonPatchOperation $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Update-SodPolicy -Id $Id -JsonPatchOperation $JsonPatchOperation
|
||||
# Update-SodPolicy -Id $Id -JsonPatchOperation $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## put-policy-schedule
|
||||
This updates schedule for a specified SOD policy.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-policy-schedule)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -725,20 +764,23 @@ $SodPolicySchedule = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule
|
||||
Send-PolicySchedule -Id $Id -SodPolicySchedule $Result
|
||||
Send-PolicySchedule -Id $Id -SodPolicySchedule $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Send-PolicySchedule -Id $Id -SodPolicySchedule $SodPolicySchedule
|
||||
# Send-PolicySchedule -Id $Id -SodPolicySchedule $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## put-sod-policy
|
||||
This updates a specified SOD policy.
|
||||
Requires role of ORG_ADMIN.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/put-sod-policy)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -827,19 +869,22 @@ $SodPolicy = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
|
||||
Send-SodPolicy -Id $Id -SodPolicy $Result
|
||||
Send-SodPolicy -Id $Id -SodPolicy $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Send-SodPolicy -Id $Id -SodPolicy $SodPolicy
|
||||
# Send-SodPolicy -Id $Id -SodPolicy $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SodPolicy"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## start-evaluate-sod-policy
|
||||
Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/start-evaluate-sod-policy)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -879,9 +924,12 @@ try {
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## start-sod-all-policies-for-org
|
||||
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.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/start-sod-all-policies-for-org)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -913,19 +961,22 @@ $MultiPolicyRequest = @"{
|
||||
# Runs all policies for org
|
||||
|
||||
try {
|
||||
Start-SodAllPoliciesForOrg
|
||||
Start-SodAllPoliciesForOrg
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Start-SodAllPoliciesForOrg -MultiPolicyRequest $MultiPolicyRequest
|
||||
# Start-SodAllPoliciesForOrg -MultiPolicyRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodAllPoliciesForOrg"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## start-sod-policy
|
||||
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.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/start-sod-policy)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
|
||||
Reference in New Issue
Block a user