mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 20:37:46 +00:00
Update PowerShell SDK docs: 15934859530
This commit is contained in:
developer-relations-sp
@@ -117,9 +117,14 @@ __GRANT_ACCESS__
|
||||
* Roles, access profiles and entitlements can be requested.
|
||||
* You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time.
|
||||
* If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time.
|
||||
* While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request.
|
||||
* Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source.
|
||||
|
||||
|
||||
:::caution
|
||||
|
||||
If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits.
|
||||
|
||||
:::
|
||||
|
||||
__REVOKE_ACCESS__
|
||||
* Can only be requested for a single identity at a time.
|
||||
* You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning.
|
||||
@@ -188,39 +193,6 @@ $AccessRequest = @"{
|
||||
"type" : "ACCESS_PROFILE",
|
||||
"assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc",
|
||||
"nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN"
|
||||
}, {
|
||||
"clientMetadata" : {
|
||||
"requestedAppName" : "test-app",
|
||||
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1"
|
||||
},
|
||||
"removeDate" : "2020-07-11T21:23:15Z",
|
||||
"comment" : "Requesting access profile for John Doe",
|
||||
"id" : "2c9180835d2e5168015d32f890ca1581",
|
||||
"type" : "ACCESS_PROFILE",
|
||||
"assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc",
|
||||
"nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN"
|
||||
}, {
|
||||
"clientMetadata" : {
|
||||
"requestedAppName" : "test-app",
|
||||
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1"
|
||||
},
|
||||
"removeDate" : "2020-07-11T21:23:15Z",
|
||||
"comment" : "Requesting access profile for John Doe",
|
||||
"id" : "2c9180835d2e5168015d32f890ca1581",
|
||||
"type" : "ACCESS_PROFILE",
|
||||
"assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc",
|
||||
"nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN"
|
||||
}, {
|
||||
"clientMetadata" : {
|
||||
"requestedAppName" : "test-app",
|
||||
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1"
|
||||
},
|
||||
"removeDate" : "2020-07-11T21:23:15Z",
|
||||
"comment" : "Requesting access profile for John Doe",
|
||||
"id" : "2c9180835d2e5168015d32f890ca1581",
|
||||
"type" : "ACCESS_PROFILE",
|
||||
"assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc",
|
||||
"nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN"
|
||||
} ],
|
||||
"requestedForWithRequestedItems" : [ {
|
||||
"identityId" : "cb89bc2f1ee6445fbea12224c526ba3a",
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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]
|
||||
|
||||
|
||||
@@ -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]](#)
|
||||
|
||||
@@ -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]](#)
|
||||
|
||||
@@ -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]](#)
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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]](#)
|
||||
|
||||
@@ -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]](#)
|
||||
|
||||
@@ -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]](#)
|
||||
|
||||
@@ -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]](#)
|
||||
|
||||
@@ -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]](#)
|
||||
|
||||
Reference in New Issue
Block a user