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

Update PowerShell SDK docs: 15934859530

Browse Source
This commit is contained in:
developer-relations-sp
2025-06-27 20:00:07 +00:00
parent 6d68ac0f95
commit 6944b83521
19 changed files with 379 additions and 339 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/tools/sdk/powershell/Reference/V3/Methods/SODPoliciesApi.md
View File

@@ -71,15 +71,15 @@ Requires role of ORG_ADMIN.
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Body | SodPolicy | [**SodPolicy**](../models/sod-policy) | True |
Body | SodPolicyRequest | [**SodPolicyRequest**](../models/sod-policy-request) | True |
### Return type
[**SodPolicy**](../models/sod-policy)
[**SodPolicyRead**](../models/sod-policy-read)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
201 | SOD policy created | SodPolicy
201 | SOD policy created | SodPolicyRead
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -92,7 +92,7 @@ Code | Description | Data Type
### Example
```powershell
$SodPolicy = @"{
$SodPolicyRequest = @"{
"conflictingAccessCriteria" : {
"leftCriteria" : {
"name" : "money-in",
@@ -152,11 +152,11 @@ $SodPolicy = @"{
# Create sod policy
try {
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
New-SodPolicy -SodPolicy $Result
$Result = ConvertFrom-JsonToSodPolicyRequest -Json $SodPolicyRequest
New-SodPolicy -SodPolicyRequest $Result
# Below is a request that includes all optional parameters
# New-SodPolicy -SodPolicy $Result
# New-SodPolicy -SodPolicyRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy"
Write-Host $_.ErrorDetails
@@ -408,12 +408,12 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The ID of the SOD Policy to retrieve.
### Return type
[**SodPolicy**](../models/sod-policy)
[**SodPolicyRead**](../models/sod-policy-read)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | SOD policy ID. | SodPolicy
200 | SOD policy ID. | SodPolicyRead
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -596,12 +596,12 @@ Param Type | Name | Data Type | Required | Description
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description**
### Return type
[**SodPolicy[]**](../models/sod-policy)
[**SodPolicyRead[]**](../models/sod-policy-read)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | List of all SOD policies. | SodPolicy[]
200 | List of all SOD policies. | SodPolicyRead[]
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -648,12 +648,12 @@ Path | Id | **String** | True | The ID of the SOD policy being modified.
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria
### Return type
[**SodPolicy**](../models/sod-policy)
[**SodPolicyRead**](../models/sod-policy-read)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Indicates the PATCH operation succeeded, and returns the SOD policy's new representation. | SodPolicy
200 | Indicates the PATCH operation succeeded, and returns the SOD policy's new representation. | SodPolicyRead
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -785,15 +785,15 @@ Requires role of ORG_ADMIN.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The ID of the SOD policy to update.
Body | SodPolicy | [**SodPolicy**](../models/sod-policy) | True |
Body | SodPolicyRead | [**SodPolicyRead**](../models/sod-policy-read) | True |
### Return type
[**SodPolicy**](../models/sod-policy)
[**SodPolicyRead**](../models/sod-policy-read)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | SOD Policy by ID | SodPolicy
200 | SOD Policy by ID | SodPolicyRead
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -808,7 +808,7 @@ Code | Description | Data Type
### Example
```powershell
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update.
$SodPolicy = @"{
$SodPolicyRead = @"{
"conflictingAccessCriteria" : {
"leftCriteria" : {
"name" : "money-in",
@@ -868,11 +868,11 @@ $SodPolicy = @"{
# Update sod policy by id
try {
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
Send-SodPolicy -Id $Id -SodPolicy $Result
$Result = ConvertFrom-JsonToSodPolicyRead -Json $SodPolicyRead
Send-SodPolicy -Id $Id -SodPolicyRead $Result
# Below is a request that includes all optional parameters
# Send-SodPolicy -Id $Id -SodPolicy $Result
# Send-SodPolicy -Id $Id -SodPolicyRead $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SodPolicy"
Write-Host $_.ErrorDetails