Update to powershell SDK docs: 13122455471

2025-12-09 20:37:47 +00:00 · 2025-02-03 20:42:04 +00:00
parent aeda961e54
commit bdb088c15d
207 changed files with 3520 additions and 8694 deletions
--- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIOutliersApi.md
+++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIOutliersApi.md
@@ -1,3 +1,4 @@
+
 ---
 id: beta-iai-outliers
 title: IAIOutliers
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/iai-outliers
 tags: ['SDK', 'Software Development Kit', 'IAIOutliers', 'BetaIAIOutliers']
 ---

-
 # IAIOutliers
   
  
@@ -28,9 +28,7 @@ Method | HTTP request | Description
 [**Get-BetaOutliersContributingFeatureAccessItems**](#list-outliers-contributing-feature-access-items) | **GET** `/outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items` | Gets a list of access items associated with each identity outlier contributing feature
 [**Invoke-BetaUnIgnoreIdentityOutliers**](#un-ignore-identity-outliers) | **POST** `/outliers/unignore` | IAI Identity Outliers Unignore

-
 ## export-outliers-zip
-
 This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported.

 Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes).
@@ -42,7 +40,6 @@ Param Type | Name | Data Type | Required  | Description
  Query | Type | **String** |   (optional) | Type of the identity outliers snapshot to filter on

 ### Return type
-
 **System.IO.FileInfo**

 ### Responses
@@ -56,14 +53,15 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/zip, application/json

 ### Example
 ```powershell
 $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional)
+
 # IAI Identity Outliers Export
+
 try {
    Export-BetaOutliersZip
    
@@ -74,11 +72,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## get-identity-outlier-snapshots
-
 This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier.

 ### Parameters 
@@ -91,7 +86,6 @@ 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: **snapshotDate**

 ### Return type
-
 [**OutlierSummary[]**](../models/outlier-summary)

 ### Responses
@@ -106,7 +100,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/json

@@ -117,7 +110,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
 $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional)
 $Filters = 'snapshotDate ge "2022-02-07T20:13:29.356648026Z"' # 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:  **snapshotDate**: *ge, le* (optional)
 $Sorters = "snapshotDate" # String | 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: **snapshotDate** (optional)
+
 # IAI Identity Outliers Summary
+
 try {
    Get-BetaIdentityOutlierSnapshots
    
@@ -128,11 +123,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## get-identity-outliers
-
 This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information.

 ### Parameters 
@@ -146,7 +138,6 @@ 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: **firstDetectionDate, attributes, score**

 ### Return type
-
 [**Outlier[]**](../models/outlier)

 ### Responses
@@ -160,7 +151,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/json

@@ -172,7 +162,9 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
 $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional)
 $Filters = 'attributes.displayName sw "John" and certStatus eq "false"' # 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:  **attributes**: *eq, sw, co, in*  **firstDetectionDate**: *ge, le*  **certStatus**: *eq*  **ignored**: *eq*  **score**: *ge, le* (optional)
 $Sorters = "attributes.displayName,firstDetectionDate,-score" # String | 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: **firstDetectionDate, attributes, score** (optional)
+
 # IAI Get Identity Outliers
+
 try {
    Get-BetaIdentityOutliers
    
@@ -183,11 +175,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## get-latest-identity-outlier-snapshots
-
 This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier.

 ### Parameters 
@@ -196,7 +185,6 @@ Param Type | Name | Data Type | Required  | Description
  Query | Type | **String** |   (optional) | Type of the identity outliers snapshot to filter on

 ### Return type
-
 [**LatestOutlierSummary[]**](../models/latest-outlier-summary)

 ### Responses
@@ -211,14 +199,15 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/json

 ### Example
 ```powershell
 $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional)
+
 # IAI Identity Outliers Latest Summary
+
 try {
    Get-BetaLatestIdentityOutlierSnapshots
    
@@ -229,11 +218,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## get-outlier-contributing-feature-summary
-
 This API returns a summary of a contributing feature for an identity outlier.

 The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object.
@@ -245,7 +231,6 @@ Param Type | Name | Data Type | Required  | Description
 Path   | OutlierFeatureId | **String** | True  | Contributing feature id

 ### Return type
-
 [**OutlierFeatureSummary**](../models/outlier-feature-summary)

 ### Responses
@@ -260,14 +245,15 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/json

 ### Example
 ```powershell
 $OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af" # String | Contributing feature id
+
 # Get identity outlier contibuting feature summary
+
 try {
    Get-BetaOutlierContributingFeatureSummary-BetaOutlierFeatureId $OutlierFeatureId 
    
@@ -278,11 +264,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## get-peer-group-outliers-contributing-features
-
 This API returns a list of contributing feature objects for a single outlier.

 The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object.
@@ -299,7 +282,6 @@ Path   | OutlierId | **String** | True  | The outlier id
  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: **importance**

 ### Return type
-
 [**OutlierContributingFeature[]**](../models/outlier-contributing-feature)

 ### Responses
@@ -314,7 +296,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/json

@@ -326,7 +307,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
 $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
 $IncludeTranslationMessages = "include-translation-messages=" # String | Whether or not to include translation messages object in returned response (optional)
 $Sorters = "importance" # String | 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: **importance** (optional)
+
 # Get identity outlier's contibuting features
+
 try {
    Get-BetaPeerGroupOutliersContributingFeatures-BetaOutlierId $OutlierId 
    
@@ -337,11 +320,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## ignore-identity-outliers
-
 This API receives a list of identity IDs in the request, changes the outliers to be ignored.

 ### Parameters 
@@ -350,7 +330,6 @@ Param Type | Name | Data Type | Required  | Description
 Body  | RequestBody | **[]String** | True  | 

 ### Return type
-
 (empty response body)

 ### Responses
@@ -364,16 +343,17 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: application/json
 - **Accept**: application/json

 ### Example
 ```powershell
 $RequestBody = "MyRequestBody" # String[] | 
- $RequestBody = @""@ 
+ $RequestBody = @""@ # String[] | 
+ 

 # IAI Identity Outliers Ignore
+
 try {
    $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
    Invoke-BetaIgnoreIdentityOutliers-BetaRequestBody $Result
@@ -385,11 +365,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## list-outliers-contributing-feature-access-items
-
 This API returns a list of the enriched access items associated with each feature filtered by the access item type.

 The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare.
@@ -407,7 +384,6 @@ Path   | ContributingFeatureName | **String** | True  | The name of contributing
  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: **displayName**

 ### Return type
-
 [**OutliersContributingFeatureAccessItems[]**](../models/outliers-contributing-feature-access-items)

 ### Responses
@@ -422,7 +398,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/json

@@ -435,7 +410,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
 $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
 $AccessType = "ENTITLEMENT" # String | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional)
 $Sorters = "displayName" # String | 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: **displayName** (optional)
+
 # Gets a list of access items associated with each identity outlier contributing feature
+
 try {
    Get-BetaOutliersContributingFeatureAccessItems-BetaOutlierId $OutlierId -BetaContributingFeatureName $ContributingFeatureName 
    
@@ -446,11 +423,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## un-ignore-identity-outliers
-
 This API receives a list of identity IDs in the request, changes the outliers to be un-ignored.

 ### Parameters 
@@ -459,7 +433,6 @@ Param Type | Name | Data Type | Required  | Description
 Body  | RequestBody | **[]String** | True  | 

 ### Return type
-
 (empty response body)

 ### Responses
@@ -473,16 +446,17 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: application/json
 - **Accept**: application/json

 ### Example
 ```powershell
 $RequestBody = "MyRequestBody" # String[] | 
- $RequestBody = @""@ 
+ $RequestBody = @""@ # String[] | 
+ 

 # IAI Identity Outliers Unignore
+
 try {
    $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
    Invoke-BetaUnIgnoreIdentityOutliers-BetaRequestBody $Result
@@ -494,7 +468,4 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
-