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 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

2
docs/tools/sdk/powershell/Reference/V3/Models/AccessCriteriaCriteriaListInner.md
View File

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'AccessCriteriaCriteriaListInner', 'Ac
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "ENTITLEMENT" ] | Type of the propery to which this reference applies to | [optional]
**Type** | **Enum** [ "ENTITLEMENT" ] | Type of the property to which this reference applies to | [optional]
**Id** | **String** | ID of the object to which this reference applies to | [optional]
**Name** | **String** | Human-readable display name of the object to which this reference applies to | [optional]

37
docs/tools/sdk/powershell/Reference/V3/Models/AccessCriteriaRequest.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: access-criteria-request
title: AccessCriteriaRequest
pagination_label: AccessCriteriaRequest
sidebar_label: AccessCriteriaRequest
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessCriteriaRequest', 'AccessCriteriaRequest']
slug: /tools/sdk/powershell/v3/models/access-criteria-request
tags: ['SDK', 'Software Development Kit', 'AccessCriteriaRequest', 'AccessCriteriaRequest']
---
# AccessCriteriaRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | **String** | Business name for the access construct list | [optional]
**CriteriaList** | [**[]AccessCriteriaRequestCriteriaListInner**](access-criteria-request-criteria-list-inner) | List of criteria. There is a min of 1 and max of 50 items in the list. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessCriteriaRequest = Initialize-AccessCriteriaRequest -Name money-in `
-CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}]
```
- Convert the resource to JSON
```powershell
$AccessCriteriaRequest | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V3/Models/AccessCriteriaRequestCriteriaListInner.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: access-criteria-request-criteria-list-inner
title: AccessCriteriaRequestCriteriaListInner
pagination_label: AccessCriteriaRequestCriteriaListInner
sidebar_label: AccessCriteriaRequestCriteriaListInner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessCriteriaRequestCriteriaListInner', 'AccessCriteriaRequestCriteriaListInner']
slug: /tools/sdk/powershell/v3/models/access-criteria-request-criteria-list-inner
tags: ['SDK', 'Software Development Kit', 'AccessCriteriaRequestCriteriaListInner', 'AccessCriteriaRequestCriteriaListInner']
---
# AccessCriteriaRequestCriteriaListInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "ENTITLEMENT" ] | Type of the property to which this reference applies to | [optional]
**Id** | **String** | ID of the object to which this reference applies to | [optional]
## Examples
- Prepare the resource
```powershell
$AccessCriteriaRequestCriteriaListInner = Initialize-AccessCriteriaRequestCriteriaListInner -Type ENTITLEMENT `
-Id 2c91808568c529c60168cca6f90c1313
```
- Convert the resource to JSON
```powershell
$AccessCriteriaRequestCriteriaListInner | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V3/Models/ConflictingAccessCriteriaRequest.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: conflicting-access-criteria-request
title: ConflictingAccessCriteriaRequest
pagination_label: ConflictingAccessCriteriaRequest
sidebar_label: ConflictingAccessCriteriaRequest
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ConflictingAccessCriteriaRequest', 'ConflictingAccessCriteriaRequest']
slug: /tools/sdk/powershell/v3/models/conflicting-access-criteria-request
tags: ['SDK', 'Software Development Kit', 'ConflictingAccessCriteriaRequest', 'ConflictingAccessCriteriaRequest']
---
# ConflictingAccessCriteriaRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**LeftCriteria** | [**AccessCriteriaRequest**](access-criteria-request) | | [optional]
**RightCriteria** | [**AccessCriteriaRequest**](access-criteria-request) | | [optional]
## Examples
- Prepare the resource
```powershell
$ConflictingAccessCriteriaRequest = Initialize-ConflictingAccessCriteriaRequest -LeftCriteria null `
-RightCriteria null
```
- Convert the resource to JSON
```powershell
$ConflictingAccessCriteriaRequest | ConvertTo-JSON
```
[[Back to top]](#)

4
docs/tools/sdk/powershell/Reference/V3/Models/SodPolicy.md
View File

@@ -33,7 +33,6 @@ Name | Type | Description | Notes
**ViolationOwnerAssignmentConfig** | [**ViolationOwnerAssignmentConfig**](violation-owner-assignment-config) | | [optional]
**Scheduled** | **Boolean** | defines whether a policy has been scheduled or not | [optional] [default to $false]
**Type** | **Enum** [ "GENERAL", "CONFLICTING_ACCESS_BASED" ] | whether a policy is query based or conflicting access based | [optional] [default to "GENERAL"]
**ConflictingAccessCriteria** | [**SodPolicyConflictingAccessCriteria**](sod-policy-conflicting-access-criteria) | | [optional]
## Examples
@@ -55,8 +54,7 @@ $SodPolicy = Initialize-SodPolicy -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde `
-ModifierId 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde `
-ViolationOwnerAssignmentConfig null `
-Scheduled true `
-Type GENERAL `
-ConflictingAccessCriteria null
-Type GENERAL
```
- Convert the resource to JSON

37
docs/tools/sdk/powershell/Reference/V3/Models/SodPolicyConflictingAccessCriteria.md
View File

@@ -1,37 +0,0 @@
---
id: sod-policy-conflicting-access-criteria
title: SodPolicyConflictingAccessCriteria
pagination_label: SodPolicyConflictingAccessCriteria
sidebar_label: SodPolicyConflictingAccessCriteria
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyConflictingAccessCriteria', 'SodPolicyConflictingAccessCriteria']
slug: /tools/sdk/powershell/v3/models/sod-policy-conflicting-access-criteria
tags: ['SDK', 'Software Development Kit', 'SodPolicyConflictingAccessCriteria', 'SodPolicyConflictingAccessCriteria']
---
# SodPolicyConflictingAccessCriteria
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**LeftCriteria** | [**AccessCriteria**](access-criteria) | | [optional]
**RightCriteria** | [**AccessCriteria**](access-criteria) | | [optional]
## Examples
- Prepare the resource
```powershell
$SodPolicyConflictingAccessCriteria = Initialize-SodPolicyConflictingAccessCriteria -LeftCriteria null `
-RightCriteria null
```
- Convert the resource to JSON
```powershell
$SodPolicyConflictingAccessCriteria | ConvertTo-JSON
```
[[Back to top]](#)

69
docs/tools/sdk/powershell/Reference/V3/Models/SodPolicyRead.md Normal file
View File

@@ -0,0 +1,69 @@
---
id: sod-policy-read
title: SodPolicyRead
pagination_label: SodPolicyRead
sidebar_label: SodPolicyRead
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyRead', 'SodPolicyRead']
slug: /tools/sdk/powershell/v3/models/sod-policy-read
tags: ['SDK', 'Software Development Kit', 'SodPolicyRead', 'SodPolicyRead']
---
# SodPolicyRead
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | Policy id | [optional] [readonly]
**Name** | **String** | Policy Business Name | [optional]
**Created** | **System.DateTime** | The time when this SOD policy is created. | [optional] [readonly]
**Modified** | **System.DateTime** | The time when this SOD policy is modified. | [optional] [readonly]
**Description** | **String** | Optional description of the SOD policy | [optional]
**OwnerRef** | [**SodPolicyOwnerRef**](sod-policy-owner-ref) | | [optional]
**ExternalPolicyReference** | **String** | Optional External Policy Reference | [optional]
**PolicyQuery** | **String** | Search query of the SOD policy | [optional]
**CompensatingControls** | **String** | Optional compensating controls(Mitigating Controls) | [optional]
**CorrectionAdvice** | **String** | Optional correction advice | [optional]
**State** | **Enum** [ "ENFORCED", "NOT_ENFORCED" ] | whether the policy is enforced or not | [optional]
**Tags** | **[]String** | tags for this policy object | [optional]
**CreatorId** | **String** | Policy's creator ID | [optional] [readonly]
**ModifierId** | **String** | Policy's modifier ID | [optional] [readonly]
**ViolationOwnerAssignmentConfig** | [**ViolationOwnerAssignmentConfig**](violation-owner-assignment-config) | | [optional]
**Scheduled** | **Boolean** | defines whether a policy has been scheduled or not | [optional] [default to $false]
**Type** | **Enum** [ "GENERAL", "CONFLICTING_ACCESS_BASED" ] | whether a policy is query based or conflicting access based | [optional] [default to "GENERAL"]
**ConflictingAccessCriteria** | [**SodPolicyReadAllOfConflictingAccessCriteria**](sod-policy-read-all-of-conflicting-access-criteria) | | [optional]
## Examples
- Prepare the resource
```powershell
$SodPolicyRead = Initialize-SodPolicyRead -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde `
-Name policy-xyz `
-Created 2020-01-01T00:00Z `
-Modified 2020-01-01T00:00Z `
-Description This policy ensures compliance of xyz `
-OwnerRef null `
-ExternalPolicyReference XYZ policy `
-PolicyQuery @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf) `
-CompensatingControls Have a manager review the transaction decisions for their "out of compliance" employee `
-CorrectionAdvice Based on the role of the employee, managers should remove access that is not required for their job function. `
-State ENFORCED `
-Tags [TAG1, TAG2] `
-CreatorId 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde `
-ModifierId 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde `
-ViolationOwnerAssignmentConfig null `
-Scheduled true `
-Type GENERAL `
-ConflictingAccessCriteria null
```
- Convert the resource to JSON
```powershell
$SodPolicyRead | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V3/Models/SodPolicyReadAllOfConflictingAccessCriteria.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: sod-policy-read-all-of-conflicting-access-criteria
title: SodPolicyReadAllOfConflictingAccessCriteria
pagination_label: SodPolicyReadAllOfConflictingAccessCriteria
sidebar_label: SodPolicyReadAllOfConflictingAccessCriteria
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyReadAllOfConflictingAccessCriteria', 'SodPolicyReadAllOfConflictingAccessCriteria']
slug: /tools/sdk/powershell/v3/models/sod-policy-read-all-of-conflicting-access-criteria
tags: ['SDK', 'Software Development Kit', 'SodPolicyReadAllOfConflictingAccessCriteria', 'SodPolicyReadAllOfConflictingAccessCriteria']
---
# SodPolicyReadAllOfConflictingAccessCriteria
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**LeftCriteria** | [**AccessCriteria**](access-criteria) | | [optional]
**RightCriteria** | [**AccessCriteria**](access-criteria) | | [optional]
## Examples
- Prepare the resource
```powershell
$SodPolicyReadAllOfConflictingAccessCriteria = Initialize-SodPolicyReadAllOfConflictingAccessCriteria -LeftCriteria null `
-RightCriteria null
```
- Convert the resource to JSON
```powershell
$SodPolicyReadAllOfConflictingAccessCriteria | ConvertTo-JSON
```
[[Back to top]](#)

69
docs/tools/sdk/powershell/Reference/V3/Models/SodPolicyRequest.md Normal file
View File

@@ -0,0 +1,69 @@
---
id: sod-policy-request
title: SodPolicyRequest
pagination_label: SodPolicyRequest
sidebar_label: SodPolicyRequest
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyRequest', 'SodPolicyRequest']
slug: /tools/sdk/powershell/v3/models/sod-policy-request
tags: ['SDK', 'Software Development Kit', 'SodPolicyRequest', 'SodPolicyRequest']
---
# SodPolicyRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | Policy id | [optional] [readonly]
**Name** | **String** | Policy Business Name | [optional]
**Created** | **System.DateTime** | The time when this SOD policy is created. | [optional] [readonly]
**Modified** | **System.DateTime** | The time when this SOD policy is modified. | [optional] [readonly]
**Description** | **String** | Optional description of the SOD policy | [optional]
**OwnerRef** | [**SodPolicyOwnerRef**](sod-policy-owner-ref) | | [optional]
**ExternalPolicyReference** | **String** | Optional External Policy Reference | [optional]
**PolicyQuery** | **String** | Search query of the SOD policy | [optional]
**CompensatingControls** | **String** | Optional compensating controls(Mitigating Controls) | [optional]
**CorrectionAdvice** | **String** | Optional correction advice | [optional]
**State** | **Enum** [ "ENFORCED", "NOT_ENFORCED" ] | whether the policy is enforced or not | [optional]
**Tags** | **[]String** | tags for this policy object | [optional]
**CreatorId** | **String** | Policy's creator ID | [optional] [readonly]
**ModifierId** | **String** | Policy's modifier ID | [optional] [readonly]
**ViolationOwnerAssignmentConfig** | [**ViolationOwnerAssignmentConfig**](violation-owner-assignment-config) | | [optional]
**Scheduled** | **Boolean** | defines whether a policy has been scheduled or not | [optional] [default to $false]
**Type** | **Enum** [ "GENERAL", "CONFLICTING_ACCESS_BASED" ] | whether a policy is query based or conflicting access based | [optional] [default to "GENERAL"]
**ConflictingAccessCriteria** | [**SodPolicyRequestAllOfConflictingAccessCriteria**](sod-policy-request-all-of-conflicting-access-criteria) | | [optional]
## Examples
- Prepare the resource
```powershell
$SodPolicyRequest = Initialize-SodPolicyRequest -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde `
-Name policy-xyz `
-Created 2020-01-01T00:00Z `
-Modified 2020-01-01T00:00Z `
-Description This policy ensures compliance of xyz `
-OwnerRef null `
-ExternalPolicyReference XYZ policy `
-PolicyQuery @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf) `
-CompensatingControls Have a manager review the transaction decisions for their "out of compliance" employee `
-CorrectionAdvice Based on the role of the employee, managers should remove access that is not required for their job function. `
-State ENFORCED `
-Tags [TAG1, TAG2] `
-CreatorId 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde `
-ModifierId 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde `
-ViolationOwnerAssignmentConfig null `
-Scheduled true `
-Type GENERAL `
-ConflictingAccessCriteria null
```
- Convert the resource to JSON
```powershell
$SodPolicyRequest | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V3/Models/SodPolicyRequestAllOfConflictingAccessCriteria.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: sod-policy-request-all-of-conflicting-access-criteria
title: SodPolicyRequestAllOfConflictingAccessCriteria
pagination_label: SodPolicyRequestAllOfConflictingAccessCriteria
sidebar_label: SodPolicyRequestAllOfConflictingAccessCriteria
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyRequestAllOfConflictingAccessCriteria', 'SodPolicyRequestAllOfConflictingAccessCriteria']
slug: /tools/sdk/powershell/v3/models/sod-policy-request-all-of-conflicting-access-criteria
tags: ['SDK', 'Software Development Kit', 'SodPolicyRequestAllOfConflictingAccessCriteria', 'SodPolicyRequestAllOfConflictingAccessCriteria']
---
# SodPolicyRequestAllOfConflictingAccessCriteria
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**LeftCriteria** | [**AccessCriteriaRequest**](access-criteria-request) | | [optional]
**RightCriteria** | [**AccessCriteriaRequest**](access-criteria-request) | | [optional]
## Examples
- Prepare the resource
```powershell
$SodPolicyRequestAllOfConflictingAccessCriteria = Initialize-SodPolicyRequestAllOfConflictingAccessCriteria -LeftCriteria null `
-RightCriteria null
```
- Convert the resource to JSON
```powershell
$SodPolicyRequestAllOfConflictingAccessCriteria | ConvertTo-JSON
```
[[Back to top]](#)