Update PowerShell SDK docs: 16529915541

2025-12-09 12:27:47 +00:00 · 2025-07-25 19:22:56 +00:00
parent 96e808b98b
commit 456f1a8b11
35 changed files with 1367 additions and 26 deletions
--- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessModelMetadataBulkUpdateResponse.md
+++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessModelMetadataBulkUpdateResponse.md
@@ -0,0 +1,41 @@
+---
+id: v2025-access-model-metadata-bulk-update-response
+title: AccessModelMetadataBulkUpdateResponse
+pagination_label: AccessModelMetadataBulkUpdateResponse
+sidebar_label: AccessModelMetadataBulkUpdateResponse
+sidebar_class_name: powershellsdk
+keywords: ['powershell', 'PowerShell', 'sdk', 'AccessModelMetadataBulkUpdateResponse', 'V2025AccessModelMetadataBulkUpdateResponse'] 
+slug: /tools/sdk/powershell/v2025/models/access-model-metadata-bulk-update-response
+tags: ['SDK', 'Software Development Kit', 'AccessModelMetadataBulkUpdateResponse', 'V2025AccessModelMetadataBulkUpdateResponse']
+---
+
+
+# AccessModelMetadataBulkUpdateResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Id** | **String** | ID of the task which is executing the bulk update. | [optional] 
+**Type** | **String** | Type of the bulk update object. | [optional] 
+**Status** |  **Enum** [  "CREATED",    "PRE_PROCESS",    "PRE_PROCESS_COMPLETED",    "POST_PROCESS",    "COMPLETED",    "CHUNK_PENDING",    "CHUNK_PROCESSING",    "RE_PROCESSING",    "PRE_PROCESS_FAILED",    "FAILED" ] | The status of the bulk update request, only list unfinished request's status. | [optional] 
+**Created** | **System.DateTime** | Time when the bulk update request was created | [optional] 
+
+## Examples
+
+- Prepare the resource
+```powershell
+$AccessModelMetadataBulkUpdateResponse = Initialize-V2025AccessModelMetadataBulkUpdateResponse  -Id 2c9180867817ac4d017817c491119a20 `
+ -Type Role `
+ -Status CREATED `
+ -Created 2020-10-08T18:33:52.029Z
+```
+
+- Convert the resource to JSON
+```powershell
+$AccessModelMetadataBulkUpdateResponse | ConvertTo-JSON
+```
+
+
+[[Back to top]](#) 
+
--- a/docs/tools/sdk/powershell/Reference/V2025/Models/EntitlementAttributeBulkUpdateFilterRequest.md
+++ b/docs/tools/sdk/powershell/Reference/V2025/Models/EntitlementAttributeBulkUpdateFilterRequest.md
@@ -0,0 +1,41 @@
+---
+id: v2025-entitlement-attribute-bulk-update-filter-request
+title: EntitlementAttributeBulkUpdateFilterRequest
+pagination_label: EntitlementAttributeBulkUpdateFilterRequest
+sidebar_label: EntitlementAttributeBulkUpdateFilterRequest
+sidebar_class_name: powershellsdk
+keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementAttributeBulkUpdateFilterRequest', 'V2025EntitlementAttributeBulkUpdateFilterRequest'] 
+slug: /tools/sdk/powershell/v2025/models/entitlement-attribute-bulk-update-filter-request
+tags: ['SDK', 'Software Development Kit', 'EntitlementAttributeBulkUpdateFilterRequest', 'V2025EntitlementAttributeBulkUpdateFilterRequest']
+---
+
+
+# EntitlementAttributeBulkUpdateFilterRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Filters** | **String** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators:  **id**: *eq* | [optional] 
+**Operation** |  **Enum** [  "ADD",    "REMOVE",    "REPLACE" ] | Operation to perform on the attributes in the bulk update request. | [optional] 
+**ReplaceScope** |  **Enum** [  "ALL",    "ATTRIBUTE" ] | The choice of update scope. | [optional] 
+**Values** | [**[]RoleMetadataBulkUpdateByIdRequestValuesInner**](role-metadata-bulk-update-by-id-request-values-inner) | The metadata to be updated, including attribute and values. | [optional] 
+
+## Examples
+
+- Prepare the resource
+```powershell
+$EntitlementAttributeBulkUpdateFilterRequest = Initialize-V2025EntitlementAttributeBulkUpdateFilterRequest  -Filters id eq 2c9180867817ac4d017817c491119a20 `
+ -Operation add `
+ -ReplaceScope attribute `
+ -Values [{attribute=iscFederalClassifications, values=[topSecret]}]
+```
+
+- Convert the resource to JSON
+```powershell
+$EntitlementAttributeBulkUpdateFilterRequest | ConvertTo-JSON
+```
+
+
+[[Back to top]](#) 
+
--- a/docs/tools/sdk/powershell/Reference/V2025/Models/EntitlementAttributeBulkUpdateIdsRequest.md
+++ b/docs/tools/sdk/powershell/Reference/V2025/Models/EntitlementAttributeBulkUpdateIdsRequest.md
@@ -0,0 +1,41 @@
+---
+id: v2025-entitlement-attribute-bulk-update-ids-request
+title: EntitlementAttributeBulkUpdateIdsRequest
+pagination_label: EntitlementAttributeBulkUpdateIdsRequest
+sidebar_label: EntitlementAttributeBulkUpdateIdsRequest
+sidebar_class_name: powershellsdk
+keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementAttributeBulkUpdateIdsRequest', 'V2025EntitlementAttributeBulkUpdateIdsRequest'] 
+slug: /tools/sdk/powershell/v2025/models/entitlement-attribute-bulk-update-ids-request
+tags: ['SDK', 'Software Development Kit', 'EntitlementAttributeBulkUpdateIdsRequest', 'V2025EntitlementAttributeBulkUpdateIdsRequest']
+---
+
+
+# EntitlementAttributeBulkUpdateIdsRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Entitlements** | **[]String** | List of entitlement IDs to update. | [optional] 
+**Operation** |  **Enum** [  "ADD",    "REMOVE",    "REPLACE" ] | Operation to perform on the attributes in the bulk update request. | [optional] 
+**ReplaceScope** |  **Enum** [  "ALL",    "ATTRIBUTE" ] | The choice of update scope. | [optional] 
+**Values** | [**[]RoleMetadataBulkUpdateByIdRequestValuesInner**](role-metadata-bulk-update-by-id-request-values-inner) | The metadata to be updated, including attribute and values. | [optional] 
+
+## Examples
+
+- Prepare the resource
+```powershell
+$EntitlementAttributeBulkUpdateIdsRequest = Initialize-V2025EntitlementAttributeBulkUpdateIdsRequest  -Entitlements [2c9180867817ac4d017817c491119a20, 2c9180867817ac4d017817c491119a21] `
+ -Operation add `
+ -ReplaceScope attribute `
+ -Values [{attribute=iscFederalClassifications, values=[topSecret]}]
+```
+
+- Convert the resource to JSON
+```powershell
+$EntitlementAttributeBulkUpdateIdsRequest | ConvertTo-JSON
+```
+
+
+[[Back to top]](#) 
+
--- a/docs/tools/sdk/powershell/Reference/V2025/Models/EntitlementAttributeBulkUpdateQueryRequest.md
+++ b/docs/tools/sdk/powershell/Reference/V2025/Models/EntitlementAttributeBulkUpdateQueryRequest.md
@@ -0,0 +1,41 @@
+---
+id: v2025-entitlement-attribute-bulk-update-query-request
+title: EntitlementAttributeBulkUpdateQueryRequest
+pagination_label: EntitlementAttributeBulkUpdateQueryRequest
+sidebar_label: EntitlementAttributeBulkUpdateQueryRequest
+sidebar_class_name: powershellsdk
+keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementAttributeBulkUpdateQueryRequest', 'V2025EntitlementAttributeBulkUpdateQueryRequest'] 
+slug: /tools/sdk/powershell/v2025/models/entitlement-attribute-bulk-update-query-request
+tags: ['SDK', 'Software Development Kit', 'EntitlementAttributeBulkUpdateQueryRequest', 'V2025EntitlementAttributeBulkUpdateQueryRequest']
+---
+
+
+# EntitlementAttributeBulkUpdateQueryRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Query** | [**Search**](search) |  | [optional] 
+**Operation** |  **Enum** [  "ADD",    "REMOVE",    "REPLACE" ] | Operation to perform on the attributes in the bulk update request. | [optional] 
+**ReplaceScope** |  **Enum** [  "ALL",    "ATTRIBUTE" ] | The choice of update scope. | [optional] 
+**Values** | [**[]RoleMetadataBulkUpdateByIdRequestValuesInner**](role-metadata-bulk-update-by-id-request-values-inner) | The metadata to be updated, including attribute and values. | [optional] 
+
+## Examples
+
+- Prepare the resource
+```powershell
+$EntitlementAttributeBulkUpdateQueryRequest = Initialize-V2025EntitlementAttributeBulkUpdateQueryRequest  -Query null `
+ -Operation add `
+ -ReplaceScope attribute `
+ -Values [{attribute=iscFederalClassifications, values=[topSecret]}]
+```
+
+- Convert the resource to JSON
+```powershell
+$EntitlementAttributeBulkUpdateQueryRequest | ConvertTo-JSON
+```
+
+
+[[Back to top]](#) 
+
--- a/docs/tools/sdk/powershell/Reference/V2025/Models/MachineClassificationConfig.md
+++ b/docs/tools/sdk/powershell/Reference/V2025/Models/MachineClassificationConfig.md
@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'MachineClassificationConfig', 'V2025M

 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Enabled** | **Boolean** | Indicates if the Classification is enabled for a Source | [optional] [default to $false]
-**ClassificationMethod** |  **Enum** [  "SOURCE" ] | Classification Method | [optional] 
-**Criteria** | **String** | A classification criteria object | [optional] 
-**Created** | **System.DateTime** | Time when the config was created | [optional] 
-**Modified** | **System.DateTime** | Time when the config was last updated | [optional] 
+**Enabled** | **Boolean** | Indicates whether Classification is enabled for a Source | [optional] [default to $false]
+**ClassificationMethod** |  **Enum** [  "SOURCE",    "CRITERIA" ] | Classification Method | [optional] 
+**Criteria** | [**MachineClassificationCriteriaLevel1**](machine-classification-criteria-level1) |  | [optional] 
+**Created** | **System.DateTime** | Date the config was created | [optional] 
+**Modified** | **System.DateTime** | Date the config was last updated | [optional] 

 ## Examples

--- a/docs/tools/sdk/powershell/Reference/V2025/Models/MachineClassificationCriteriaLevel1.md
+++ b/docs/tools/sdk/powershell/Reference/V2025/Models/MachineClassificationCriteriaLevel1.md
@@ -0,0 +1,45 @@
+---
+id: v2025-machine-classification-criteria-level1
+title: MachineClassificationCriteriaLevel1
+pagination_label: MachineClassificationCriteriaLevel1
+sidebar_label: MachineClassificationCriteriaLevel1
+sidebar_class_name: powershellsdk
+keywords: ['powershell', 'PowerShell', 'sdk', 'MachineClassificationCriteriaLevel1', 'V2025MachineClassificationCriteriaLevel1'] 
+slug: /tools/sdk/powershell/v2025/models/machine-classification-criteria-level1
+tags: ['SDK', 'Software Development Kit', 'MachineClassificationCriteriaLevel1', 'V2025MachineClassificationCriteriaLevel1']
+---
+
+
+# MachineClassificationCriteriaLevel1
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Operation** | [**MachineClassificationCriteriaOperation**](machine-classification-criteria-operation) |  | [optional] 
+**CaseSensitive** | **Boolean** | Indicates whether case matters when evaluating the criteria | [optional] [default to $false]
+**DataType** | **String** | The data type of the attribute being evaluated | [optional] 
+**Attribute** | **String** | The attribute to evaluate in the classification criteria | [optional] 
+**Value** | **String** | The value to compare against the attribute in the classification criteria | [optional] 
+**Children** | [**[]MachineClassificationCriteriaLevel2**](machine-classification-criteria-level2) | An array of child classification criteria objects | [optional] 
+
+## Examples
+
+- Prepare the resource
+```powershell
+$MachineClassificationCriteriaLevel1 = Initialize-V2025MachineClassificationCriteriaLevel1  -Operation null `
+ -CaseSensitive false `
+ -DataType null `
+ -Attribute distinguishedName `
+ -Value OU=Service Accounts `
+ -Children null
+```
+
+- Convert the resource to JSON
+```powershell
+$MachineClassificationCriteriaLevel1 | ConvertTo-JSON
+```
+
+
+[[Back to top]](#) 
+
--- a/docs/tools/sdk/powershell/Reference/V2025/Models/MachineClassificationCriteriaLevel2.md
+++ b/docs/tools/sdk/powershell/Reference/V2025/Models/MachineClassificationCriteriaLevel2.md
@@ -0,0 +1,45 @@
+---
+id: v2025-machine-classification-criteria-level2
+title: MachineClassificationCriteriaLevel2
+pagination_label: MachineClassificationCriteriaLevel2
+sidebar_label: MachineClassificationCriteriaLevel2
+sidebar_class_name: powershellsdk
+keywords: ['powershell', 'PowerShell', 'sdk', 'MachineClassificationCriteriaLevel2', 'V2025MachineClassificationCriteriaLevel2'] 
+slug: /tools/sdk/powershell/v2025/models/machine-classification-criteria-level2
+tags: ['SDK', 'Software Development Kit', 'MachineClassificationCriteriaLevel2', 'V2025MachineClassificationCriteriaLevel2']
+---
+
+
+# MachineClassificationCriteriaLevel2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Operation** | [**MachineClassificationCriteriaOperation**](machine-classification-criteria-operation) |  | [optional] 
+**CaseSensitive** | **Boolean** | Indicates whether case matters when evaluating the criteria | [optional] [default to $false]
+**DataType** | **String** | The data type of the attribute being evaluated | [optional] 
+**Attribute** | **String** | The attribute to evaluate in the classification criteria | [optional] 
+**Value** | **String** | The value to compare against the attribute in the classification criteria | [optional] 
+**Children** | [**[]MachineClassificationCriteriaLevel3**](machine-classification-criteria-level3) | An array of child classification criteria objects | [optional] 
+
+## Examples
+
+- Prepare the resource
+```powershell
+$MachineClassificationCriteriaLevel2 = Initialize-V2025MachineClassificationCriteriaLevel2  -Operation null `
+ -CaseSensitive false `
+ -DataType null `
+ -Attribute employeeType `
+ -Value SERVICE `
+ -Children null
+```
+
+- Convert the resource to JSON
+```powershell
+$MachineClassificationCriteriaLevel2 | ConvertTo-JSON
+```
+
+
+[[Back to top]](#) 
+
--- a/docs/tools/sdk/powershell/Reference/V2025/Models/MachineClassificationCriteriaLevel3.md
+++ b/docs/tools/sdk/powershell/Reference/V2025/Models/MachineClassificationCriteriaLevel3.md
@@ -0,0 +1,45 @@
+---
+id: v2025-machine-classification-criteria-level3
+title: MachineClassificationCriteriaLevel3
+pagination_label: MachineClassificationCriteriaLevel3
+sidebar_label: MachineClassificationCriteriaLevel3
+sidebar_class_name: powershellsdk
+keywords: ['powershell', 'PowerShell', 'sdk', 'MachineClassificationCriteriaLevel3', 'V2025MachineClassificationCriteriaLevel3'] 
+slug: /tools/sdk/powershell/v2025/models/machine-classification-criteria-level3
+tags: ['SDK', 'Software Development Kit', 'MachineClassificationCriteriaLevel3', 'V2025MachineClassificationCriteriaLevel3']
+---
+
+
+# MachineClassificationCriteriaLevel3
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Operation** | [**MachineClassificationCriteriaOperation**](machine-classification-criteria-operation) |  | [optional] 
+**CaseSensitive** | **Boolean** | Indicates whether or not case matters when evaluating the criteria | [optional] [default to $false]
+**DataType** | **String** | The data type of the attribute being evaluated | [optional] 
+**Attribute** | **String** | The attribute to evaluate in the classification criteria | [optional] 
+**Value** | **String** | The value to compare against the attribute in the classification criteria | [optional] 
+**Children** | **[]String** | An array of child classification criteria objects | [optional] 
+
+## Examples
+
+- Prepare the resource
+```powershell
+$MachineClassificationCriteriaLevel3 = Initialize-V2025MachineClassificationCriteriaLevel3  -Operation null `
+ -CaseSensitive false `
+ -DataType This is the first level of classification criteria `
+ -Attribute sAMAccountName `
+ -Value SVC `
+ -Children null
+```
+
+- Convert the resource to JSON
+```powershell
+$MachineClassificationCriteriaLevel3 | ConvertTo-JSON
+```
+
+
+[[Back to top]](#) 
+
--- a/docs/tools/sdk/powershell/Reference/V2025/Models/MachineClassificationCriteriaOperation.md
+++ b/docs/tools/sdk/powershell/Reference/V2025/Models/MachineClassificationCriteriaOperation.md
@@ -0,0 +1,34 @@
+---
+id: v2025-machine-classification-criteria-operation
+title: MachineClassificationCriteriaOperation
+pagination_label: MachineClassificationCriteriaOperation
+sidebar_label: MachineClassificationCriteriaOperation
+sidebar_class_name: powershellsdk
+keywords: ['powershell', 'PowerShell', 'sdk', 'MachineClassificationCriteriaOperation', 'V2025MachineClassificationCriteriaOperation'] 
+slug: /tools/sdk/powershell/v2025/models/machine-classification-criteria-operation
+tags: ['SDK', 'Software Development Kit', 'MachineClassificationCriteriaOperation', 'V2025MachineClassificationCriteriaOperation']
+---
+
+
+# MachineClassificationCriteriaOperation
+
+## Enum
+
+
+* `EQUALS` (value: `"EQUALS"`)
+
+* `NOT_EQUALS` (value: `"NOT_EQUALS"`)
+
+* `STARTS_WITH` (value: `"STARTS_WITH"`)
+
+* `ENDS_WITH` (value: `"ENDS_WITH"`)
+
+* `CONTAINS` (value: `"CONTAINS"`)
+
+* `AND` (value: `"AND"`)
+
+* `OR` (value: `"OR"`)
+
+
+[[Back to top]](#) 
+
--- a/docs/tools/sdk/powershell/Reference/V2025/Models/SodPolicyDto1.md
+++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SodPolicyDto1.md
@@ -0,0 +1,39 @@
+---
+id: v2025-sod-policy-dto1
+title: SodPolicyDto1
+pagination_label: SodPolicyDto1
+sidebar_label: SodPolicyDto1
+sidebar_class_name: powershellsdk
+keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyDto1', 'V2025SodPolicyDto1'] 
+slug: /tools/sdk/powershell/v2025/models/sod-policy-dto1
+tags: ['SDK', 'Software Development Kit', 'SodPolicyDto1', 'V2025SodPolicyDto1']
+---
+
+
+# SodPolicyDto1
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Type** |  **Enum** [  "SOD_POLICY" ] | SOD policy DTO type. | [optional] 
+**Id** | **String** | SOD policy ID. | [optional] 
+**Name** | **String** | SOD policy display name. | [optional] 
+
+## Examples
+
+- Prepare the resource
+```powershell
+$SodPolicyDto1 = Initialize-V2025SodPolicyDto1  -Type SOD_POLICY `
+ -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde `
+ -Name Business SOD Policy
+```
+
+- Convert the resource to JSON
+```powershell
+$SodPolicyDto1 | ConvertTo-JSON
+```
+
+
+[[Back to top]](#) 
+
--- a/docs/tools/sdk/powershell/Reference/V2025/Models/SodViolationCheckResult.md
+++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SodViolationCheckResult.md
@@ -19,7 +19,7 @@ Name | Type | Description | Notes
 **Message** | [**ErrorMessageDto**](error-message-dto) |  | [optional] 
 **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] 
 **ViolationContexts** | [**[]SodViolationContext**](sod-violation-context) |  | [optional] 
-**ViolatedPolicies** | [**[]SodPolicyDto**](sod-policy-dto) | A list of the SOD policies that were violated. | [optional] 
+**ViolatedPolicies** | [**[]SodPolicyDto1**](sod-policy-dto1) | A list of the SOD policies that were violated. | [optional] 

 ## Examples

--- a/docs/tools/sdk/powershell/Reference/V2025/Models/SodViolationContext.md
+++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SodViolationContext.md
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'SodViolationContext', 'V2025SodViolat

 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Policy** | [**SodPolicyDto**](sod-policy-dto) |  | [optional] 
+**Policy** | [**SodPolicyDto1**](sod-policy-dto1) |  | [optional] 
 **ConflictingAccessCriteria** | [**SodViolationContextConflictingAccessCriteria**](sod-violation-context-conflicting-access-criteria) |  | [optional] 

 ## Examples