mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 12:27:47 +00:00
Update PowerShell SDK docs: 16529915541
This commit is contained in:
developer-relations-sp
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: beta-sod-policy-dto1
|
||||
title: SodPolicyDto1
|
||||
pagination_label: SodPolicyDto1
|
||||
sidebar_label: SodPolicyDto1
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyDto1', 'BetaSodPolicyDto1']
|
||||
slug: /tools/sdk/powershell/beta/models/sod-policy-dto1
|
||||
tags: ['SDK', 'Software Development Kit', 'SodPolicyDto1', 'BetaSodPolicyDto1']
|
||||
---
|
||||
|
||||
|
||||
# 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-BetaSodPolicyDto1 -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]](#)
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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** | [**[]SodViolationContext1**](sod-violation-context1) | | [optional]
|
||||
**ViolatedPolicies** | [**[]SodPolicyDto**](sod-policy-dto) | A list of the Policies that were violated. | [optional]
|
||||
**ViolatedPolicies** | [**[]SodPolicyDto1**](sod-policy-dto1) | A list of the Policies that were violated. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'SodViolationContext', 'BetaSodViolati
|
||||
|
||||
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
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'SodViolationContext1', 'BetaSodViolat
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Policy** | [**SodPolicyDto**](sod-policy-dto) | | [optional]
|
||||
**Policy** | [**SodPolicyDto1**](sod-policy-dto1) | | [optional]
|
||||
**ConflictingAccessCriteria** | [**SodViolationContext1ConflictingAccessCriteria**](sod-violation-context1-conflicting-access-criteria) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -148,7 +148,56 @@ Code | Description | Data Type
|
||||
```powershell
|
||||
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID.
|
||||
$MachineClassificationConfig = @"{
|
||||
"criteria" : "criteria",
|
||||
"criteria" : {
|
||||
"children" : [ {
|
||||
"children" : [ {
|
||||
"children" : [ "children", "children" ],
|
||||
"caseSensitive" : false,
|
||||
"dataType" : "This is the first level of classification criteria",
|
||||
"attribute" : "sAMAccountName",
|
||||
"operation" : "EQUALS",
|
||||
"value" : "SVC"
|
||||
}, {
|
||||
"children" : [ "children", "children" ],
|
||||
"caseSensitive" : false,
|
||||
"dataType" : "This is the first level of classification criteria",
|
||||
"attribute" : "sAMAccountName",
|
||||
"operation" : "EQUALS",
|
||||
"value" : "SVC"
|
||||
} ],
|
||||
"caseSensitive" : false,
|
||||
"dataType" : "dataType",
|
||||
"attribute" : "employeeType",
|
||||
"operation" : "EQUALS",
|
||||
"value" : "SERVICE"
|
||||
}, {
|
||||
"children" : [ {
|
||||
"children" : [ "children", "children" ],
|
||||
"caseSensitive" : false,
|
||||
"dataType" : "This is the first level of classification criteria",
|
||||
"attribute" : "sAMAccountName",
|
||||
"operation" : "EQUALS",
|
||||
"value" : "SVC"
|
||||
}, {
|
||||
"children" : [ "children", "children" ],
|
||||
"caseSensitive" : false,
|
||||
"dataType" : "This is the first level of classification criteria",
|
||||
"attribute" : "sAMAccountName",
|
||||
"operation" : "EQUALS",
|
||||
"value" : "SVC"
|
||||
} ],
|
||||
"caseSensitive" : false,
|
||||
"dataType" : "dataType",
|
||||
"attribute" : "employeeType",
|
||||
"operation" : "EQUALS",
|
||||
"value" : "SERVICE"
|
||||
} ],
|
||||
"caseSensitive" : false,
|
||||
"dataType" : "dataType",
|
||||
"attribute" : "distinguishedName",
|
||||
"operation" : "EQUALS",
|
||||
"value" : "OU=Service Accounts"
|
||||
},
|
||||
"created" : "2017-07-11T18:45:37.098Z",
|
||||
"modified" : "2018-06-25T20:22:28.104Z",
|
||||
"classificationMethod" : "SOURCE",
|
||||
|
||||
@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'MachineClassificationConfig', 'V2024M
|
||||
|
||||
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
|
||||
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
id: v2024-machine-classification-criteria-level1
|
||||
title: MachineClassificationCriteriaLevel1
|
||||
pagination_label: MachineClassificationCriteriaLevel1
|
||||
sidebar_label: MachineClassificationCriteriaLevel1
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MachineClassificationCriteriaLevel1', 'V2024MachineClassificationCriteriaLevel1']
|
||||
slug: /tools/sdk/powershell/v2024/models/machine-classification-criteria-level1
|
||||
tags: ['SDK', 'Software Development Kit', 'MachineClassificationCriteriaLevel1', 'V2024MachineClassificationCriteriaLevel1']
|
||||
---
|
||||
|
||||
|
||||
# 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-V2024MachineClassificationCriteriaLevel1 -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]](#)
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
id: v2024-machine-classification-criteria-level2
|
||||
title: MachineClassificationCriteriaLevel2
|
||||
pagination_label: MachineClassificationCriteriaLevel2
|
||||
sidebar_label: MachineClassificationCriteriaLevel2
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MachineClassificationCriteriaLevel2', 'V2024MachineClassificationCriteriaLevel2']
|
||||
slug: /tools/sdk/powershell/v2024/models/machine-classification-criteria-level2
|
||||
tags: ['SDK', 'Software Development Kit', 'MachineClassificationCriteriaLevel2', 'V2024MachineClassificationCriteriaLevel2']
|
||||
---
|
||||
|
||||
|
||||
# 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-V2024MachineClassificationCriteriaLevel2 -Operation null `
|
||||
-CaseSensitive false `
|
||||
-DataType null `
|
||||
-Attribute employeeType `
|
||||
-Value SERVICE `
|
||||
-Children null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$MachineClassificationCriteriaLevel2 | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
id: v2024-machine-classification-criteria-level3
|
||||
title: MachineClassificationCriteriaLevel3
|
||||
pagination_label: MachineClassificationCriteriaLevel3
|
||||
sidebar_label: MachineClassificationCriteriaLevel3
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MachineClassificationCriteriaLevel3', 'V2024MachineClassificationCriteriaLevel3']
|
||||
slug: /tools/sdk/powershell/v2024/models/machine-classification-criteria-level3
|
||||
tags: ['SDK', 'Software Development Kit', 'MachineClassificationCriteriaLevel3', 'V2024MachineClassificationCriteriaLevel3']
|
||||
---
|
||||
|
||||
|
||||
# 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-V2024MachineClassificationCriteriaLevel3 -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]](#)
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
id: v2024-machine-classification-criteria-operation
|
||||
title: MachineClassificationCriteriaOperation
|
||||
pagination_label: MachineClassificationCriteriaOperation
|
||||
sidebar_label: MachineClassificationCriteriaOperation
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MachineClassificationCriteriaOperation', 'V2024MachineClassificationCriteriaOperation']
|
||||
slug: /tools/sdk/powershell/v2024/models/machine-classification-criteria-operation
|
||||
tags: ['SDK', 'Software Development Kit', 'MachineClassificationCriteriaOperation', 'V2024MachineClassificationCriteriaOperation']
|
||||
---
|
||||
|
||||
|
||||
# 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]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2024-sod-policy-dto1
|
||||
title: SodPolicyDto1
|
||||
pagination_label: SodPolicyDto1
|
||||
sidebar_label: SodPolicyDto1
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyDto1', 'V2024SodPolicyDto1']
|
||||
slug: /tools/sdk/powershell/v2024/models/sod-policy-dto1
|
||||
tags: ['SDK', 'Software Development Kit', 'SodPolicyDto1', 'V2024SodPolicyDto1']
|
||||
---
|
||||
|
||||
|
||||
# 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-V2024SodPolicyDto1 -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]](#)
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'SodViolationContext', 'V2024SodViolat
|
||||
|
||||
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
|
||||
|
||||
@@ -29,7 +29,7 @@ Name | Type | Description | Notes
|
||||
$SourceAppAccountSource = Initialize-V2024SourceAppAccountSource -Id 2c9180827ca885d7017ca8ce28a000eb `
|
||||
-Type SOURCE `
|
||||
-Name ODS-AD-Source `
|
||||
-UseForPasswordManagement false `
|
||||
-UseForPasswordManagement true `
|
||||
-PasswordPolicies [{type=PASSWORD_POLICY, id=006a072ecc6647f68bba9f4a4ad34649, name=Password Policy 1}]
|
||||
```
|
||||
|
||||
|
||||
@@ -29,7 +29,7 @@ tags: ['SDK', 'Software Development Kit', 'WorkItemTypeManualWorkItems', 'V2024W
|
||||
|
||||
* `Form` (value: `"Form"`)
|
||||
|
||||
* `PolicyVioloation` (value: `"PolicyVioloation"`)
|
||||
* `PolicyViolation` (value: `"PolicyViolation"`)
|
||||
|
||||
* `Challenge` (value: `"Challenge"`)
|
||||
|
||||
|
||||
@@ -31,6 +31,9 @@ Method | HTTP request | Description
|
||||
[**Get-V2025AccessModelMetadataAttributeValue**](#get-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values/{value}` | Get access model metadata value
|
||||
[**Get-V2025AccessModelMetadataAttribute**](#list-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes` | List access model metadata attributes
|
||||
[**Get-V2025AccessModelMetadataAttributeValue**](#list-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values` | List access model metadata values
|
||||
[**Update-V2025AccessModelMetadataByFilter**](#update-access-model-metadata-by-filter) | **POST** `/access-model-metadata/bulk-update/filter` | Metadata Attribute update by filter
|
||||
[**Update-V2025AccessModelMetadataByIds**](#update-access-model-metadata-by-ids) | **POST** `/access-model-metadata/bulk-update/ids` | Metadata Attribute update by ids
|
||||
[**Update-V2025AccessModelMetadataByQuery**](#update-access-model-metadata-by-query) | **POST** `/access-model-metadata/bulk-update/query` | Metadata Attribute update by query
|
||||
|
||||
|
||||
## get-access-model-metadata-attribute
|
||||
@@ -228,3 +231,281 @@ try {
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## update-access-model-metadata-by-filter
|
||||
Bulk update Access Model Metadata Attribute Values using a filter
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-access-model-metadata-by-filter)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Body | EntitlementAttributeBulkUpdateFilterRequest | [**EntitlementAttributeBulkUpdateFilterRequest**](../models/entitlement-attribute-bulk-update-filter-request) | True | Attribute metadata bulk update request body.
|
||||
|
||||
### Return type
|
||||
[**AccessModelMetadataBulkUpdateResponse**](../models/access-model-metadata-bulk-update-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | OK | AccessModelMetadataBulkUpdateResponse
|
||||
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
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$EntitlementAttributeBulkUpdateFilterRequest = @"{
|
||||
"values" : [ {
|
||||
"attribute" : "iscFederalClassifications",
|
||||
"values" : [ "topSecret" ]
|
||||
} ],
|
||||
"filters" : "id eq 2c9180867817ac4d017817c491119a20",
|
||||
"replaceScope" : "attribute",
|
||||
"operation" : "add"
|
||||
}"@
|
||||
|
||||
# Metadata Attribute update by filter
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToEntitlementAttributeBulkUpdateFilterRequest -Json $EntitlementAttributeBulkUpdateFilterRequest
|
||||
Update-V2025AccessModelMetadataByFilter -EntitlementAttributeBulkUpdateFilterRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Update-V2025AccessModelMetadataByFilter -EntitlementAttributeBulkUpdateFilterRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AccessModelMetadataByFilter"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## update-access-model-metadata-by-ids
|
||||
Bulk update Access Model Metadata Attribute Values using ids.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-access-model-metadata-by-ids)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Body | EntitlementAttributeBulkUpdateIdsRequest | [**EntitlementAttributeBulkUpdateIdsRequest**](../models/entitlement-attribute-bulk-update-ids-request) | True | Attribute metadata bulk update request body.
|
||||
|
||||
### Return type
|
||||
[**AccessModelMetadataBulkUpdateResponse**](../models/access-model-metadata-bulk-update-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | OK | AccessModelMetadataBulkUpdateResponse
|
||||
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
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$EntitlementAttributeBulkUpdateIdsRequest = @"{
|
||||
"entitlements" : [ "2c9180867817ac4d017817c491119a20", "2c9180867817ac4d017817c491119a21" ],
|
||||
"values" : [ {
|
||||
"attribute" : "iscFederalClassifications",
|
||||
"values" : [ "topSecret" ]
|
||||
} ],
|
||||
"replaceScope" : "attribute",
|
||||
"operation" : "add"
|
||||
}"@
|
||||
|
||||
# Metadata Attribute update by ids
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToEntitlementAttributeBulkUpdateIdsRequest -Json $EntitlementAttributeBulkUpdateIdsRequest
|
||||
Update-V2025AccessModelMetadataByIds -EntitlementAttributeBulkUpdateIdsRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Update-V2025AccessModelMetadataByIds -EntitlementAttributeBulkUpdateIdsRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AccessModelMetadataByIds"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## update-access-model-metadata-by-query
|
||||
Bulk update Access Model Metadata Attribute Values using a query
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-access-model-metadata-by-query)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Body | EntitlementAttributeBulkUpdateQueryRequest | [**EntitlementAttributeBulkUpdateQueryRequest**](../models/entitlement-attribute-bulk-update-query-request) | True | Attribute metadata bulk update request body.
|
||||
|
||||
### Return type
|
||||
[**AccessModelMetadataBulkUpdateResponse**](../models/access-model-metadata-bulk-update-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | OK | AccessModelMetadataBulkUpdateResponse
|
||||
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
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$EntitlementAttributeBulkUpdateQueryRequest = @"{
|
||||
"query" : {
|
||||
"queryDsl" : {
|
||||
"match" : {
|
||||
"name" : "john.doe"
|
||||
}
|
||||
},
|
||||
"aggregationType" : "DSL",
|
||||
"aggregationsVersion" : "",
|
||||
"query" : {
|
||||
"query" : "name:a*",
|
||||
"timeZone" : "America/Chicago",
|
||||
"fields" : "[firstName,lastName,email]",
|
||||
"innerHit" : {
|
||||
"query" : "source.name:\\\"Active Directory\\\"",
|
||||
"type" : "access"
|
||||
}
|
||||
},
|
||||
"aggregationsDsl" : { },
|
||||
"sort" : [ "displayName", "+id" ],
|
||||
"filters" : { },
|
||||
"queryVersion" : "",
|
||||
"queryType" : "SAILPOINT",
|
||||
"includeNested" : true,
|
||||
"queryResultFilter" : {
|
||||
"excludes" : [ "stacktrace" ],
|
||||
"includes" : [ "name", "displayName" ]
|
||||
},
|
||||
"indices" : [ "identities" ],
|
||||
"typeAheadQuery" : {
|
||||
"field" : "source.name",
|
||||
"size" : 100,
|
||||
"query" : "Work",
|
||||
"sortByValue" : true,
|
||||
"nestedType" : "access",
|
||||
"sort" : "asc",
|
||||
"maxExpansions" : 10
|
||||
},
|
||||
"textQuery" : {
|
||||
"contains" : true,
|
||||
"terms" : [ "The quick brown fox", "3141592", "7" ],
|
||||
"matchAny" : false,
|
||||
"fields" : [ "displayName", "employeeNumber", "roleCount" ]
|
||||
},
|
||||
"searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ],
|
||||
"aggregations" : {
|
||||
"filter" : {
|
||||
"field" : "access.type",
|
||||
"name" : "Entitlements",
|
||||
"type" : "TERM",
|
||||
"value" : "ENTITLEMENT"
|
||||
},
|
||||
"bucket" : {
|
||||
"field" : "attributes.city",
|
||||
"size" : 100,
|
||||
"minDocCount" : 2,
|
||||
"name" : "Identity Locations",
|
||||
"type" : "TERMS"
|
||||
},
|
||||
"metric" : {
|
||||
"field" : "@access.name",
|
||||
"name" : "Access Name Count",
|
||||
"type" : "COUNT"
|
||||
},
|
||||
"subAggregation" : {
|
||||
"filter" : {
|
||||
"field" : "access.type",
|
||||
"name" : "Entitlements",
|
||||
"type" : "TERM",
|
||||
"value" : "ENTITLEMENT"
|
||||
},
|
||||
"bucket" : {
|
||||
"field" : "attributes.city",
|
||||
"size" : 100,
|
||||
"minDocCount" : 2,
|
||||
"name" : "Identity Locations",
|
||||
"type" : "TERMS"
|
||||
},
|
||||
"metric" : {
|
||||
"field" : "@access.name",
|
||||
"name" : "Access Name Count",
|
||||
"type" : "COUNT"
|
||||
},
|
||||
"subAggregation" : {
|
||||
"filter" : {
|
||||
"field" : "access.type",
|
||||
"name" : "Entitlements",
|
||||
"type" : "TERM",
|
||||
"value" : "ENTITLEMENT"
|
||||
},
|
||||
"bucket" : {
|
||||
"field" : "attributes.city",
|
||||
"size" : 100,
|
||||
"minDocCount" : 2,
|
||||
"name" : "Identity Locations",
|
||||
"type" : "TERMS"
|
||||
},
|
||||
"metric" : {
|
||||
"field" : "@access.name",
|
||||
"name" : "Access Name Count",
|
||||
"type" : "COUNT"
|
||||
},
|
||||
"nested" : {
|
||||
"name" : "id",
|
||||
"type" : "access"
|
||||
}
|
||||
},
|
||||
"nested" : {
|
||||
"name" : "id",
|
||||
"type" : "access"
|
||||
}
|
||||
},
|
||||
"nested" : {
|
||||
"name" : "id",
|
||||
"type" : "access"
|
||||
}
|
||||
}
|
||||
},
|
||||
"values" : [ {
|
||||
"attribute" : "iscFederalClassifications",
|
||||
"values" : [ "topSecret" ]
|
||||
} ],
|
||||
"replaceScope" : "attribute",
|
||||
"operation" : "add"
|
||||
}"@
|
||||
|
||||
# Metadata Attribute update by query
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToEntitlementAttributeBulkUpdateQueryRequest -Json $EntitlementAttributeBulkUpdateQueryRequest
|
||||
Update-V2025AccessModelMetadataByQuery -EntitlementAttributeBulkUpdateQueryRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Update-V2025AccessModelMetadataByQuery -EntitlementAttributeBulkUpdateQueryRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AccessModelMetadataByQuery"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -148,7 +148,56 @@ Code | Description | Data Type
|
||||
```powershell
|
||||
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID.
|
||||
$MachineClassificationConfig = @"{
|
||||
"criteria" : "criteria",
|
||||
"criteria" : {
|
||||
"children" : [ {
|
||||
"children" : [ {
|
||||
"children" : [ "children", "children" ],
|
||||
"caseSensitive" : false,
|
||||
"dataType" : "This is the first level of classification criteria",
|
||||
"attribute" : "sAMAccountName",
|
||||
"operation" : "EQUALS",
|
||||
"value" : "SVC"
|
||||
}, {
|
||||
"children" : [ "children", "children" ],
|
||||
"caseSensitive" : false,
|
||||
"dataType" : "This is the first level of classification criteria",
|
||||
"attribute" : "sAMAccountName",
|
||||
"operation" : "EQUALS",
|
||||
"value" : "SVC"
|
||||
} ],
|
||||
"caseSensitive" : false,
|
||||
"dataType" : "dataType",
|
||||
"attribute" : "employeeType",
|
||||
"operation" : "EQUALS",
|
||||
"value" : "SERVICE"
|
||||
}, {
|
||||
"children" : [ {
|
||||
"children" : [ "children", "children" ],
|
||||
"caseSensitive" : false,
|
||||
"dataType" : "This is the first level of classification criteria",
|
||||
"attribute" : "sAMAccountName",
|
||||
"operation" : "EQUALS",
|
||||
"value" : "SVC"
|
||||
}, {
|
||||
"children" : [ "children", "children" ],
|
||||
"caseSensitive" : false,
|
||||
"dataType" : "This is the first level of classification criteria",
|
||||
"attribute" : "sAMAccountName",
|
||||
"operation" : "EQUALS",
|
||||
"value" : "SVC"
|
||||
} ],
|
||||
"caseSensitive" : false,
|
||||
"dataType" : "dataType",
|
||||
"attribute" : "employeeType",
|
||||
"operation" : "EQUALS",
|
||||
"value" : "SERVICE"
|
||||
} ],
|
||||
"caseSensitive" : false,
|
||||
"dataType" : "dataType",
|
||||
"attribute" : "distinguishedName",
|
||||
"operation" : "EQUALS",
|
||||
"value" : "OU=Service Accounts"
|
||||
},
|
||||
"created" : "2017-07-11T18:45:37.098Z",
|
||||
"modified" : "2018-06-25T20:22:28.104Z",
|
||||
"classificationMethod" : "SOURCE",
|
||||
|
||||
@@ -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]](#)
|
||||
|
||||
@@ -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]](#)
|
||||
|
||||
@@ -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]](#)
|
||||
|
||||
@@ -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]](#)
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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]](#)
|
||||
|
||||
@@ -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]](#)
|
||||
|
||||
@@ -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]](#)
|
||||
|
||||
@@ -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]](#)
|
||||
|
||||
@@ -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]](#)
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: sod-policy-dto1
|
||||
title: SodPolicyDto1
|
||||
pagination_label: SodPolicyDto1
|
||||
sidebar_label: SodPolicyDto1
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyDto1', 'SodPolicyDto1']
|
||||
slug: /tools/sdk/powershell/v3/models/sod-policy-dto1
|
||||
tags: ['SDK', 'Software Development Kit', 'SodPolicyDto1', 'SodPolicyDto1']
|
||||
---
|
||||
|
||||
|
||||
# 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-SodPolicyDto1 -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]](#)
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'SodViolationContext', 'SodViolationCo
|
||||
|
||||
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
|
||||
|
||||
Reference in New Issue
Block a user