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/V2024/Methods/V2024EntitlementsApi.md
+++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md
@@ -1,3 +1,4 @@
+
 ---
 id: v2024-entitlements
 title: Entitlements
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v2024/methods/entitlements
 tags: ['SDK', 'Software Development Kit', 'Entitlements', 'V2024Entitlements']
 ---

-
 # Entitlements
  Use this API to implement and customize entitlement functionality.
 With this functionality in place, administrators can view entitlements and configure them for use throughout Identity Security Cloud in certifications, access profiles, and roles.
@@ -80,9 +80,7 @@ Method | HTTP request | Description
 [**Reset-V2024SourceEntitlements**](#reset-source-entitlements) | **POST** `/entitlements/reset/sources/{id}` | Reset Source Entitlements
 [**Update-V2024EntitlementsInBulk**](#update-entitlements-in-bulk) | **POST** `/entitlements/bulk-update` | Bulk update an entitlement list

-
 ## create-access-model-metadata-for-entitlement
-
 Add single Access Model Metadata to an entitlement.

 ### Parameters 
@@ -94,7 +92,6 @@ Path   | AttributeValue | **String** | True  | Technical name of the Attribute V
   | XSailPointExperimental | **String** | True  (default to "true") | Use this header to enable this experimental API.

 ### Return type
-
 [**Entitlement1**](../models/entitlement1)

 ### Responses
@@ -108,7 +105,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

@@ -118,7 +114,9 @@ $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id.
 $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute.
 $AttributeValue = "public" # String | Technical name of the Attribute Value.
 $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
+
 # Add metadata to an entitlement.
+
 try {
    New-V2024AccessModelMetadataForEntitlement-V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue -V2024XSailPointExperimental $XSailPointExperimental 
    
@@ -129,11 +127,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## delete-access-model-metadata-from-entitlement
-
 Remove single Access Model Metadata from an entitlement.

 ### Parameters 
@@ -145,7 +140,6 @@ Path   | AttributeValue | **String** | True  | Technical name of the Attribute V
   | XSailPointExperimental | **String** | True  (default to "true") | Use this header to enable this experimental API.

 ### Return type
-
 (empty response body)

 ### Responses
@@ -159,7 +153,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

@@ -169,7 +162,9 @@ $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id.
 $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute.
 $AttributeValue = "public" # String | Technical name of the Attribute Value.
 $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
+
 # Remove metadata from an entitlement.
+
 try {
    Remove-V2024AccessModelMetadataFromEntitlement-V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue -V2024XSailPointExperimental $XSailPointExperimental 
    
@@ -180,11 +175,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## get-entitlement
-
 This API returns an entitlement by its ID.

 ### Parameters 
@@ -194,7 +186,6 @@ Path   | Id | **String** | True  | The entitlement ID
   | XSailPointExperimental | **String** | True  (default to "true") | Use this header to enable this experimental API.

 ### Return type
-
 [**Entitlement1**](../models/entitlement1)

 ### Responses
@@ -209,7 +200,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

@@ -217,7 +207,9 @@ Code | Description  | Data Type
 ```powershell
 $Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID
 $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
+
 # Get an entitlement
+
 try {
    Get-V2024Entitlement-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental 
    
@@ -228,11 +220,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## get-entitlement-request-config
-
 This API returns the entitlement request config for a specified entitlement.

 ### Parameters 
@@ -242,7 +231,6 @@ Path   | Id | **String** | True  | Entitlement Id
   | XSailPointExperimental | **String** | True  (default to "true") | Use this header to enable this experimental API.

 ### Return type
-
 [**EntitlementRequestConfig**](../models/entitlement-request-config)

 ### Responses
@@ -257,7 +245,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

@@ -265,7 +252,9 @@ Code | Description  | Data Type
 ```powershell
 $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id
 $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
+
 # Get Entitlement Request Config
+
 try {
    Get-V2024EntitlementRequestConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental 
    
@@ -276,11 +265,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## import-entitlements-by-source
-
 Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements).

 If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error.
@@ -295,7 +281,6 @@ Path   | Id | **String** | True  | Source Id
   | CsvFile | **System.IO.FileInfo** |   (optional) | The CSV file containing the source entitlements to aggregate.

 ### Return type
-
 [**LoadEntitlementTask**](../models/load-entitlement-task)

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

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

@@ -318,7 +302,9 @@ Code | Description  | Data Type
 $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id
 $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
 $CsvFile =  # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional)
+
 # Aggregate Entitlements
+
 try {
    Import-V2024EntitlementsBySource-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental 
    
@@ -329,11 +315,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## list-entitlement-children
-
 This API returns a list of all child entitlements of a given entitlement.

 ### Parameters 
@@ -348,7 +331,6 @@ Path   | Id | **String** | True  | Entitlement Id
  Query | Filters | **String** |   (optional) | 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, in*  **name**: *eq, in, sw*  **type**: *eq, in*  **attribute**: *eq, in*  **value**: *eq, in, sw*  **source.id**: *eq, in*  **requestable**: *eq*  **created**: *gt, lt, ge, le*  **modified**: *gt, lt, ge, le*

 ### Return type
-
 [**Entitlement1[]**](../models/entitlement1)

 ### Responses
@@ -363,7 +345,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

@@ -376,7 +357,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)
 $Sorters = "name,-modified" # 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: **id, name, created, modified, type, attribute, value, source.id** (optional)
 $Filters = 'attribute eq "memberOf"' # 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, in*  **name**: *eq, in, sw*  **type**: *eq, in*  **attribute**: *eq, in*  **value**: *eq, in, sw*  **source.id**: *eq, in*  **requestable**: *eq*  **created**: *gt, lt, ge, le*  **modified**: *gt, lt, ge, le* (optional)
+
 # List of entitlements children
+
 try {
    Get-V2024EntitlementChildren-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental 
    
@@ -387,11 +370,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## list-entitlement-parents
-
 This API returns a list of all parent entitlements of a given entitlement.

 ### Parameters 
@@ -406,7 +386,6 @@ Path   | Id | **String** | True  | Entitlement Id
  Query | Filters | **String** |   (optional) | 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, in*  **name**: *eq, in, sw*  **type**: *eq, in*  **attribute**: *eq, in*  **value**: *eq, in, sw*  **source.id**: *eq, in*  **requestable**: *eq*  **created**: *gt, lt, ge, le*  **modified**: *gt, lt, ge, le*

 ### Return type
-
 [**Entitlement1[]**](../models/entitlement1)

 ### Responses
@@ -421,7 +400,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

@@ -434,7 +412,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)
 $Sorters = "name,-modified" # 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: **id, name, created, modified, type, attribute, value, source.id** (optional)
 $Filters = 'attribute eq "memberOf"' # 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, in*  **name**: *eq, in, sw*  **type**: *eq, in*  **attribute**: *eq, in*  **value**: *eq, in, sw*  **source.id**: *eq, in*  **requestable**: *eq*  **created**: *gt, lt, ge, le*  **modified**: *gt, lt, ge, le* (optional)
+
 # List of entitlements parents
+
 try {
    Get-V2024EntitlementParents-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental 
    
@@ -445,11 +425,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## list-entitlements
-
 This API returns a list of entitlements.

 This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive).
@@ -471,7 +448,6 @@ Param Type | Name | Data Type | Required  | Description
  Query | Filters | **String** |   (optional) | 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, in*  **name**: *eq, in, sw*  **type**: *eq, in*  **attribute**: *eq, in*  **value**: *eq, in, sw*  **source.id**: *eq, in*  **requestable**: *eq*  **created**: *gt, lt, ge, le*  **modified**: *gt, lt, ge, le*  **owner.id**: *eq, in*

 ### Return type
-
 [**Entitlement1[]**](../models/entitlement1)

 ### Responses
@@ -485,7 +461,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

@@ -501,7 +476,9 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
 $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)
 $Sorters = "name,-modified" # 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: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional)
 $Filters = 'attribute eq "memberOf"' # 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, in*  **name**: *eq, in, sw*  **type**: *eq, in*  **attribute**: *eq, in*  **value**: *eq, in, sw*  **source.id**: *eq, in*  **requestable**: *eq*  **created**: *gt, lt, ge, le*  **modified**: *gt, lt, ge, le*  **owner.id**: *eq, in* (optional)
+
 # Gets a list of entitlements.
+
 try {
    Get-V2024Entitlements-V2024XSailPointExperimental $XSailPointExperimental 
    
@@ -512,11 +489,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## patch-entitlement
-
 This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.

 The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields**
@@ -531,7 +505,6 @@ Path   | Id | **String** | True  | ID of the entitlement to patch
 Body  | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) |   (optional) | 

 ### Return type
-
 [**Entitlement1**](../models/entitlement1)

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

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

@@ -554,14 +526,15 @@ Code | Description  | Data Type
 ```powershell
 $Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch
 $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
- # JsonPatchOperation[] |  (optional)
 $JsonPatchOperation = @"{
  "op" : "replace",
  "path" : "/description",
  "value" : "New description"
-}"@ 
+}"@ # JsonPatchOperation[] |  (optional)
+ 

 # Patch an entitlement
+
 try {
    Update-V2024Entitlement-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental 
    
@@ -572,11 +545,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## put-entitlement-request-config
-
 This API replaces the entitlement request config for a specified entitlement.

 ### Parameters 
@@ -587,7 +557,6 @@ Path   | Id | **String** | True  | Entitlement ID
 Body  | EntitlementRequestConfig | [**EntitlementRequestConfig**](../models/entitlement-request-config) | True  | 

 ### Return type
-
 [**EntitlementRequestConfig**](../models/entitlement-request-config)

 ### Responses
@@ -602,7 +571,6 @@ 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

@@ -623,7 +591,9 @@ $EntitlementRequestConfig = @"{
    "requestCommentRequired" : true
  }
 }"@
+
 # Replace Entitlement Request Config
+
 try {
    $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig
    Send-V2024EntitlementRequestConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024EntitlementRequestConfig $Result
@@ -635,11 +605,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## reset-source-entitlements
-
 Remove all entitlements from a specific source.
 To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation.  To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. 

@@ -650,7 +617,6 @@ Path   | Id | **String** | True  | ID of source for the entitlement reset
   | XSailPointExperimental | **String** | True  (default to "true") | Use this header to enable this experimental API.

 ### Return type
-
 [**EntitlementSourceResetBaseReferenceDto**](../models/entitlement-source-reset-base-reference-dto)

 ### Responses
@@ -664,7 +630,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

@@ -672,7 +637,9 @@ Code | Description  | Data Type
 ```powershell
 $Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset
 $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
+
 # Reset Source Entitlements
+
 try {
    Reset-V2024SourceEntitlements-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental 
    
@@ -683,11 +650,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## update-entitlements-in-bulk
-
 "This API applies an update to every entitlement of the list.\n\nThe\
 \ number of entitlements to update is limited to 50 items maximum.\n\nThe JsonPatch\
 \ update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\
@@ -703,7 +667,6 @@ Param Type | Name | Data Type | Required  | Description
 Body  | EntitlementBulkUpdateRequest | [**EntitlementBulkUpdateRequest**](../models/entitlement-bulk-update-request) | True  | 

 ### Return type
-
 (empty response body)

 ### Responses
@@ -717,7 +680,6 @@ 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

@@ -736,7 +698,9 @@ $EntitlementBulkUpdateRequest = @"{
    "value" : false
  } ]
 }"@
+
 # Bulk update an entitlement list
+
 try {
    $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest
    Update-V2024EntitlementsInBulk-V2024XSailPointExperimental $XSailPointExperimental -V2024EntitlementBulkUpdateRequest $Result
@@ -748,7 +712,4 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
-