LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 04:19:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update PowerShell SDK docs: 16508496722

Browse Source
This commit is contained in:
developer-relations-sp
2025-07-24 21:44:52 +00:00
parent 37223abcf7
commit 1f03388f09
12 changed files with 324 additions and 353 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessModelMetadataApi.md
View File

@@ -133,7 +133,11 @@ Get a list of Access Model Metadata Attributes
### Parameters ### Parameters
Param Type | Name | Data Type | Required | Description 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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* 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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* **Supported composite operators**: *and*
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: **name, key**
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Count | **Boolean** | (optional) (default to $false) | 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.
### Return type ### Return type
[**AttributeDTO[]**](../models/attribute-dto) [**AttributeDTO[]**](../models/attribute-dto)
@@ -154,7 +158,11 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$Filters = 'name eq "Privacy"' # 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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) $Filters = 'name eq "Privacy"' # 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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* **Supported composite operators**: *and* (optional)
$Sorters = "name,-key" # 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: **name, key** (optional)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$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)
# List access model metadata attributes # List access model metadata attributes
@@ -162,7 +170,7 @@ try {
Get-BetaAccessModelMetadataAttribute Get-BetaAccessModelMetadataAttribute
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-BetaAccessModelMetadataAttribute -Filters $Filters # Get-BetaAccessModelMetadataAttribute -Filters $Filters -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -179,6 +187,9 @@ Get a list of Access Model Metadata Attribute Values
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Key | **String** | True | Technical name of the Attribute. Path | Key | **String** | True | Technical name of the Attribute.
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Count | **Boolean** | (optional) (default to $false) | 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.
### Return type ### Return type
[**AttributeValueDTO[]**](../models/attribute-value-dto) [**AttributeValueDTO[]**](../models/attribute-value-dto)
@@ -200,6 +211,9 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$Key = "iscPrivacy" # String | Technical name of the Attribute. $Key = "iscPrivacy" # String | Technical name of the Attribute.
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$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)
# List access model metadata values # List access model metadata values
@@ -207,7 +221,7 @@ try {
Get-BetaAccessModelMetadataAttributeValue -Key $Key Get-BetaAccessModelMetadataAttributeValue -Key $Key
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-BetaAccessModelMetadataAttributeValue -Key $Key # Get-BetaAccessModelMetadataAttributeValue -Key $Key -Offset $Offset -Limit $Limit -Count $Count
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

54
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessModelMetadataApi.md
View File

@@ -34,9 +34,6 @@ Method | HTTP request | Description
## get-access-model-metadata-attribute ## get-access-model-metadata-attribute
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Get single Access Model Metadata Attribute Get single Access Model Metadata Attribute
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-model-metadata-attribute) [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-model-metadata-attribute)
@@ -45,7 +42,6 @@ Get single Access Model Metadata Attribute
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Key | **String** | True | Technical name of the Attribute. Path | Key | **String** | True | Technical name of the Attribute.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type ### Return type
[**AttributeDTO**](../models/attribute-dto) [**AttributeDTO**](../models/attribute-dto)
@@ -67,15 +63,14 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$Key = "iscPrivacy" # String | Technical name of the Attribute. $Key = "iscPrivacy" # String | Technical name of the Attribute.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get access model metadata attribute # Get access model metadata attribute
try { try {
Get-V2024AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental Get-V2024AccessModelMetadataAttribute -Key $Key
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental # Get-V2024AccessModelMetadataAttribute -Key $Key
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -84,9 +79,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## get-access-model-metadata-attribute-value ## get-access-model-metadata-attribute-value
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Get single Access Model Metadata Attribute Value Get single Access Model Metadata Attribute Value
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-model-metadata-attribute-value) [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-model-metadata-attribute-value)
@@ -96,7 +88,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Key | **String** | True | Technical name of the Attribute. Path | Key | **String** | True | Technical name of the Attribute.
Path | Value | **String** | True | Technical name of the Attribute value. Path | Value | **String** | True | Technical name of the Attribute value.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type ### Return type
[**AttributeValueDTO**](../models/attribute-value-dto) [**AttributeValueDTO**](../models/attribute-value-dto)
@@ -119,15 +110,14 @@ Code | Description | Data Type
```powershell ```powershell
$Key = "iscPrivacy" # String | Technical name of the Attribute. $Key = "iscPrivacy" # String | Technical name of the Attribute.
$Value = "public" # String | Technical name of the Attribute value. $Value = "public" # String | Technical name of the Attribute value.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get access model metadata value # Get access model metadata value
try { try {
Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental # Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -136,9 +126,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## list-access-model-metadata-attribute ## list-access-model-metadata-attribute
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Get a list of Access Model Metadata Attributes Get a list of Access Model Metadata Attributes
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-model-metadata-attribute) [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-model-metadata-attribute)
@@ -146,8 +133,11 @@ Get a list of Access Model Metadata Attributes
### Parameters ### Parameters
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. 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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* **Supported composite operators**: *and*
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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* 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: **name, key**
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Count | **Boolean** | (optional) (default to $false) | 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.
### Return type ### Return type
[**AttributeDTO[]**](../models/attribute-dto) [**AttributeDTO[]**](../models/attribute-dto)
@@ -168,16 +158,19 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Filters = 'name eq "Privacy"' # 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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* **Supported composite operators**: *and* (optional)
$Filters = 'name eq "Privacy"' # 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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) $Sorters = "name,-key" # 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: **name, key** (optional)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$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)
# List access model metadata attributes # List access model metadata attributes
try { try {
Get-V2024AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental Get-V2024AccessModelMetadataAttribute
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental -Filters $Filters # Get-V2024AccessModelMetadataAttribute -Filters $Filters -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -186,9 +179,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## list-access-model-metadata-attribute-value ## list-access-model-metadata-attribute-value
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Get a list of Access Model Metadata Attribute Values Get a list of Access Model Metadata Attribute Values
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-model-metadata-attribute-value) [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-model-metadata-attribute-value)
@@ -197,7 +187,9 @@ Get a list of Access Model Metadata Attribute Values
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Key | **String** | True | Technical name of the Attribute. Path | Key | **String** | True | Technical name of the Attribute.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Count | **Boolean** | (optional) (default to $false) | 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.
### Return type ### Return type
[**AttributeValueDTO[]**](../models/attribute-value-dto) [**AttributeValueDTO[]**](../models/attribute-value-dto)
@@ -219,15 +211,17 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$Key = "iscPrivacy" # String | Technical name of the Attribute. $Key = "iscPrivacy" # String | Technical name of the Attribute.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$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)
# List access model metadata values # List access model metadata values
try { try {
Get-V2024AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental Get-V2024AccessModelMetadataAttributeValue -Key $Key
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental # Get-V2024AccessModelMetadataAttributeValue -Key $Key -Offset $Offset -Limit $Limit -Count $Count
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

108
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md
View File

@@ -81,9 +81,6 @@ Method | HTTP request | Description
## create-access-model-metadata-for-entitlement ## create-access-model-metadata-for-entitlement
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Add single Access Model Metadata to an entitlement. Add single Access Model Metadata to an entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-access-model-metadata-for-entitlement) [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-access-model-metadata-for-entitlement)
@@ -94,7 +91,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The entitlement id. Path | Id | **String** | True | The entitlement id.
Path | AttributeKey | **String** | True | Technical name of the Attribute. Path | AttributeKey | **String** | True | Technical name of the Attribute.
Path | AttributeValue | **String** | True | Technical name of the Attribute Value. Path | AttributeValue | **String** | True | Technical name of the Attribute Value.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type ### Return type
[**Entitlement**](../models/entitlement) [**Entitlement**](../models/entitlement)
@@ -118,15 +114,14 @@ Code | Description | Data Type
$Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id.
$AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute.
$AttributeValue = "public" # String | Technical name of the Attribute Value. $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. # Add metadata to an entitlement.
try { try {
New-V2024AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental New-V2024AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# New-V2024AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental # New-V2024AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessModelMetadataForEntitlement" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessModelMetadataForEntitlement"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -135,9 +130,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## delete-access-model-metadata-from-entitlement ## delete-access-model-metadata-from-entitlement
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Remove single Access Model Metadata from an entitlement. Remove single Access Model Metadata from an entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-access-model-metadata-from-entitlement) [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-access-model-metadata-from-entitlement)
@@ -148,7 +140,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The entitlement id. Path | Id | **String** | True | The entitlement id.
Path | AttributeKey | **String** | True | Technical name of the Attribute. Path | AttributeKey | **String** | True | Technical name of the Attribute.
Path | AttributeValue | **String** | True | Technical name of the Attribute Value. Path | AttributeValue | **String** | True | Technical name of the Attribute Value.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type ### Return type
(empty response body) (empty response body)
@@ -172,15 +163,14 @@ Code | Description | Data Type
$Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id.
$AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute.
$AttributeValue = "public" # String | Technical name of the Attribute Value. $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. # Remove metadata from an entitlement.
try { try {
Remove-V2024AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental Remove-V2024AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Remove-V2024AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental # Remove-V2024AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessModelMetadataFromEntitlement" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessModelMetadataFromEntitlement"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -189,9 +179,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## get-entitlement ## get-entitlement
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns an entitlement by its ID. This API returns an entitlement by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement) [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement)
@@ -200,7 +187,6 @@ This API returns an entitlement by its ID.
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The entitlement ID Path | Id | **String** | True | The entitlement ID
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type ### Return type
[**Entitlement**](../models/entitlement) [**Entitlement**](../models/entitlement)
@@ -223,15 +209,14 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID $Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get an entitlement # Get an entitlement
try { try {
Get-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental Get-V2024Entitlement -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental # Get-V2024Entitlement -Id $Id
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlement" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlement"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -240,9 +225,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## get-entitlement-request-config ## get-entitlement-request-config
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns the entitlement request config for a specified entitlement. This API returns the entitlement request config for a specified entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement-request-config) [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement-request-config)
@@ -251,7 +233,6 @@ This API returns the entitlement request config for a specified entitlement.
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | Entitlement Id Path | Id | **String** | True | Entitlement Id
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type ### Return type
[**EntitlementRequestConfig**](../models/entitlement-request-config) [**EntitlementRequestConfig**](../models/entitlement-request-config)
@@ -274,15 +255,14 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get entitlement request config # Get entitlement request config
try { try {
Get-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental Get-V2024EntitlementRequestConfig -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental # Get-V2024EntitlementRequestConfig -Id $Id
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementRequestConfig" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementRequestConfig"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -294,9 +274,6 @@ try {
:::caution deprecated :::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API. This endpoint has been deprecated and may be replaced or removed in future versions of the API.
::: :::
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
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). 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. 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.
@@ -309,7 +286,6 @@ If the target source is a delimited file source, then the CSV file needs to be i
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | Source Id Path | Id | **String** | True | Source Id
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
| CsvFile | **System.IO.FileInfo** | (optional) | The CSV file containing the source entitlements to aggregate. | CsvFile | **System.IO.FileInfo** | (optional) | The CSV file containing the source entitlements to aggregate.
### Return type ### Return type
@@ -332,16 +308,15 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id $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) $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional)
# Aggregate entitlements # Aggregate entitlements
try { try {
Import-V2024EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental Import-V2024EntitlementsBySource -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Import-V2024EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental -CsvFile $CsvFile # Import-V2024EntitlementsBySource -Id $Id -CsvFile $CsvFile
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024EntitlementsBySource" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024EntitlementsBySource"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -350,9 +325,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## list-entitlement-children ## list-entitlement-children
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns a list of all child entitlements of a given entitlement. This API returns a list of all child entitlements of a given entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-entitlement-children) [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-entitlement-children)
@@ -361,7 +333,6 @@ This API returns a list of all child entitlements of a given entitlement.
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | Entitlement Id Path | Id | **String** | True | Entitlement Id
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Count | **Boolean** | (optional) (default to $false) | 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. Query | Count | **Boolean** | (optional) (default to $false) | 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.
@@ -389,7 +360,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$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) $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)
@@ -399,10 +369,10 @@ $Filters = 'attribute eq "memberOf"' # String | Filter results using the standar
# List of entitlements children # List of entitlements children
try { try {
Get-V2024EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental Get-V2024EntitlementChildren -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters # Get-V2024EntitlementChildren -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChildren" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChildren"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -411,9 +381,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## list-entitlement-parents ## list-entitlement-parents
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns a list of all parent entitlements of a given entitlement. This API returns a list of all parent entitlements of a given entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-entitlement-parents) [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-entitlement-parents)
@@ -422,7 +389,6 @@ This API returns a list of all parent entitlements of a given entitlement.
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | Entitlement Id Path | Id | **String** | True | Entitlement Id
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Count | **Boolean** | (optional) (default to $false) | 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. Query | Count | **Boolean** | (optional) (default to $false) | 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.
@@ -450,7 +416,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id $Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$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) $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)
@@ -460,10 +425,10 @@ $Filters = 'attribute eq "memberOf"' # String | Filter results using the standar
# List of entitlements parents # List of entitlements parents
try { try {
Get-V2024EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental Get-V2024EntitlementParents -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters # Get-V2024EntitlementParents -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementParents" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementParents"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -472,9 +437,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## list-entitlements ## list-entitlements
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns a list of 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). 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).
@@ -486,7 +448,6 @@ Any authenticated token can call this API.
### Parameters ### Parameters
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Query | AccountId | **String** | (optional) | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). Query | AccountId | **String** | (optional) | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s).
Query | SegmentedForIdentity | **String** | (optional) | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. Query | SegmentedForIdentity | **String** | (optional) | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity.
Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s).
@@ -516,7 +477,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional)
$SegmentedForIdentity = "e554098913544630b5985e9042f5e44b" # String | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) $SegmentedForIdentity = "e554098913544630b5985e9042f5e44b" # String | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional)
$ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) $ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional)
@@ -530,10 +490,10 @@ $Filters = 'attribute eq "memberOf"' # String | Filter results using the standar
# Gets a list of entitlements. # Gets a list of entitlements.
try { try {
Get-V2024Entitlements -XSailPointExperimental $XSailPointExperimental Get-V2024Entitlements
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024Entitlements -XSailPointExperimental $XSailPointExperimental -AccountId $AccountId -SegmentedForIdentity $SegmentedForIdentity -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters # Get-V2024Entitlements -AccountId $AccountId -SegmentedForIdentity $SegmentedForIdentity -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlements" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlements"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -542,9 +502,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## patch-entitlement ## patch-entitlement
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. 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** The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields**
@@ -557,7 +514,6 @@ When you're patching owner, only owner type and owner id must be provided. Owner
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | ID of the entitlement to patch Path | Id | **String** | True | ID of the entitlement to patch
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) | Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) |
### Return type ### Return type
@@ -581,7 +537,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch $Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$JsonPatchOperation = @"{ $JsonPatchOperation = @"{
"op" : "replace", "op" : "replace",
"path" : "/description", "path" : "/description",
@@ -592,10 +547,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Patch an entitlement # Patch an entitlement
try { try {
Update-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental Update-V2024Entitlement -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Update-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result # Update-V2024Entitlement -Id $Id -JsonPatchOperation $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Entitlement" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Entitlement"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -604,9 +559,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## put-entitlement-request-config ## put-entitlement-request-config
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API replaces the entitlement request config for a specified entitlement. This API replaces the entitlement request config for a specified entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-entitlement-request-config) [API Spec](https://developer.sailpoint.com/docs/api/v2024/put-entitlement-request-config)
@@ -615,7 +567,6 @@ This API replaces the entitlement request config for a specified entitlement.
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | Entitlement ID Path | Id | **String** | True | Entitlement ID
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | EntitlementRequestConfig | [**EntitlementRequestConfig**](../models/entitlement-request-config) | True | Body | EntitlementRequestConfig | [**EntitlementRequestConfig**](../models/entitlement-request-config) | True |
### Return type ### Return type
@@ -639,7 +590,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID $Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$EntitlementRequestConfig = @"{ $EntitlementRequestConfig = @"{
"accessRequestConfig" : { "accessRequestConfig" : {
"denialCommentRequired" : false, "denialCommentRequired" : false,
@@ -668,10 +618,10 @@ $EntitlementRequestConfig = @"{
try { try {
$Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig
Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result Send-V2024EntitlementRequestConfig -Id $Id -EntitlementRequestConfig $Result
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result # Send-V2024EntitlementRequestConfig -Id $Id -EntitlementRequestConfig $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024EntitlementRequestConfig" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024EntitlementRequestConfig"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -680,9 +630,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## reset-source-entitlements ## reset-source-entitlements
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Remove all entitlements from a specific source. 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`. 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`.
@@ -692,7 +639,6 @@ To reload the accounts along with the entitlements you removed, you must run an
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | ID of source for the entitlement reset 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 ### Return type
[**EntitlementSourceResetBaseReferenceDto**](../models/entitlement-source-reset-base-reference-dto) [**EntitlementSourceResetBaseReferenceDto**](../models/entitlement-source-reset-base-reference-dto)
@@ -714,15 +660,14 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset $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 # Reset source entitlements
try { try {
Reset-V2024SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental Reset-V2024SourceEntitlements -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Reset-V2024SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental # Reset-V2024SourceEntitlements -Id $Id
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024SourceEntitlements" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024SourceEntitlements"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -731,9 +676,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## update-entitlements-in-bulk ## update-entitlements-in-bulk
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API applies an update to every entitlement of the list. This API applies an update to every entitlement of the list.
@@ -754,7 +696,6 @@ A token with ORG_ADMIN or API authority is required to call this API.
### Parameters ### Parameters
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | EntitlementBulkUpdateRequest | [**EntitlementBulkUpdateRequest**](../models/entitlement-bulk-update-request) | True | Body | EntitlementBulkUpdateRequest | [**EntitlementBulkUpdateRequest**](../models/entitlement-bulk-update-request) | True |
### Return type ### Return type
@@ -776,7 +717,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$EntitlementBulkUpdateRequest = @"{ $EntitlementBulkUpdateRequest = @"{
"entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ],
"jsonPatch" : [ { "jsonPatch" : [ {
@@ -798,10 +738,10 @@ $EntitlementBulkUpdateRequest = @"{
try { try {
$Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest
Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result Update-V2024EntitlementsInBulk -EntitlementBulkUpdateRequest $Result
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result # Update-V2024EntitlementsInBulk -EntitlementBulkUpdateRequest $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsInBulk" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsInBulk"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

9
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SourcesApi.md
View File

@@ -1646,9 +1646,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## import-entitlements ## import-entitlements
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Starts an entitlement aggregation on the specified source. Starts an entitlement aggregation on the specified source.
If the target source is a delimited file source, then the CSV file needs to be included in the request body. If the target source is a delimited file source, then the CSV file needs to be included in the request body.
You will also need to set the Content-Type header to `multipart/form-data`. You will also need to set the Content-Type header to `multipart/form-data`.
@@ -1660,7 +1657,6 @@ A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required t
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | SourceId | **String** | True | Source Id Path | SourceId | **String** | True | Source Id
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
| File | **System.IO.FileInfo** | (optional) | The CSV file containing the source entitlements to aggregate. | File | **System.IO.FileInfo** | (optional) | The CSV file containing the source entitlements to aggregate.
### Return type ### Return type
@@ -1683,16 +1679,15 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$File = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) $File = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional)
# Entitlement aggregation # Entitlement aggregation
try { try {
Import-V2024Entitlements -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental Import-V2024Entitlements -SourceId $SourceId
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Import-V2024Entitlements -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -File $File # Import-V2024Entitlements -SourceId $SourceId -File $File
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024Entitlements" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024Entitlements"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

54
docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessModelMetadataApi.md
View File

@@ -34,9 +34,6 @@ Method | HTTP request | Description
## get-access-model-metadata-attribute ## get-access-model-metadata-attribute
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Get single Access Model Metadata Attribute Get single Access Model Metadata Attribute
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-model-metadata-attribute) [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-model-metadata-attribute)
@@ -45,7 +42,6 @@ Get single Access Model Metadata Attribute
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Key | **String** | True | Technical name of the Attribute. Path | Key | **String** | True | Technical name of the Attribute.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type ### Return type
[**AttributeDTO**](../models/attribute-dto) [**AttributeDTO**](../models/attribute-dto)
@@ -67,15 +63,14 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$Key = "iscPrivacy" # String | Technical name of the Attribute. $Key = "iscPrivacy" # String | Technical name of the Attribute.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get access model metadata attribute # Get access model metadata attribute
try { try {
Get-V2025AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental Get-V2025AccessModelMetadataAttribute -Key $Key
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2025AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental # Get-V2025AccessModelMetadataAttribute -Key $Key
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttribute" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttribute"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -84,9 +79,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## get-access-model-metadata-attribute-value ## get-access-model-metadata-attribute-value
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Get single Access Model Metadata Attribute Value Get single Access Model Metadata Attribute Value
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-model-metadata-attribute-value) [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-model-metadata-attribute-value)
@@ -96,7 +88,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Key | **String** | True | Technical name of the Attribute. Path | Key | **String** | True | Technical name of the Attribute.
Path | Value | **String** | True | Technical name of the Attribute value. Path | Value | **String** | True | Technical name of the Attribute value.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type ### Return type
[**AttributeValueDTO**](../models/attribute-value-dto) [**AttributeValueDTO**](../models/attribute-value-dto)
@@ -119,15 +110,14 @@ Code | Description | Data Type
```powershell ```powershell
$Key = "iscPrivacy" # String | Technical name of the Attribute. $Key = "iscPrivacy" # String | Technical name of the Attribute.
$Value = "public" # String | Technical name of the Attribute value. $Value = "public" # String | Technical name of the Attribute value.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get access model metadata value # Get access model metadata value
try { try {
Get-V2025AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental Get-V2025AccessModelMetadataAttributeValue -Key $Key -Value $Value
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2025AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental # Get-V2025AccessModelMetadataAttributeValue -Key $Key -Value $Value
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttributeValue" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttributeValue"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -136,9 +126,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## list-access-model-metadata-attribute ## list-access-model-metadata-attribute
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Get a list of Access Model Metadata Attributes Get a list of Access Model Metadata Attributes
[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-access-model-metadata-attribute) [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-access-model-metadata-attribute)
@@ -146,8 +133,11 @@ Get a list of Access Model Metadata Attributes
### Parameters ### Parameters
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. 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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* **Supported composite operators**: *and*
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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* 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: **name, key**
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Count | **Boolean** | (optional) (default to $false) | 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.
### Return type ### Return type
[**AttributeDTO[]**](../models/attribute-dto) [**AttributeDTO[]**](../models/attribute-dto)
@@ -168,16 +158,19 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Filters = 'name eq "Privacy"' # 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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* **Supported composite operators**: *and* (optional)
$Filters = 'name eq "Privacy"' # 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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) $Sorters = "name,-key" # 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: **name, key** (optional)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$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)
# List access model metadata attributes # List access model metadata attributes
try { try {
Get-V2025AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental Get-V2025AccessModelMetadataAttribute
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2025AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental -Filters $Filters # Get-V2025AccessModelMetadataAttribute -Filters $Filters -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttribute" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttribute"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -186,9 +179,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## list-access-model-metadata-attribute-value ## list-access-model-metadata-attribute-value
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Get a list of Access Model Metadata Attribute Values Get a list of Access Model Metadata Attribute Values
[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-access-model-metadata-attribute-value) [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-access-model-metadata-attribute-value)
@@ -197,7 +187,9 @@ Get a list of Access Model Metadata Attribute Values
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Key | **String** | True | Technical name of the Attribute. Path | Key | **String** | True | Technical name of the Attribute.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Count | **Boolean** | (optional) (default to $false) | 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.
### Return type ### Return type
[**AttributeValueDTO[]**](../models/attribute-value-dto) [**AttributeValueDTO[]**](../models/attribute-value-dto)
@@ -219,15 +211,17 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$Key = "iscPrivacy" # String | Technical name of the Attribute. $Key = "iscPrivacy" # String | Technical name of the Attribute.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$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)
# List access model metadata values # List access model metadata values
try { try {
Get-V2025AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental Get-V2025AccessModelMetadataAttributeValue -Key $Key
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2025AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental # Get-V2025AccessModelMetadataAttributeValue -Key $Key -Offset $Offset -Limit $Limit -Count $Count
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttributeValue" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttributeValue"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

108
docs/tools/sdk/powershell/Reference/V2025/Methods/V2025EntitlementsApi.md
View File

@@ -81,9 +81,6 @@ Method | HTTP request | Description
## create-access-model-metadata-for-entitlement ## create-access-model-metadata-for-entitlement
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Add single Access Model Metadata to an entitlement. Add single Access Model Metadata to an entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-access-model-metadata-for-entitlement) [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-access-model-metadata-for-entitlement)
@@ -94,7 +91,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The entitlement id. Path | Id | **String** | True | The entitlement id.
Path | AttributeKey | **String** | True | Technical name of the Attribute. Path | AttributeKey | **String** | True | Technical name of the Attribute.
Path | AttributeValue | **String** | True | Technical name of the Attribute Value. Path | AttributeValue | **String** | True | Technical name of the Attribute Value.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type ### Return type
[**Entitlement**](../models/entitlement) [**Entitlement**](../models/entitlement)
@@ -118,15 +114,14 @@ Code | Description | Data Type
$Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id.
$AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute.
$AttributeValue = "public" # String | Technical name of the Attribute Value. $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. # Add metadata to an entitlement.
try { try {
New-V2025AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental New-V2025AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# New-V2025AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental # New-V2025AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025AccessModelMetadataForEntitlement" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025AccessModelMetadataForEntitlement"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -135,9 +130,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## delete-access-model-metadata-from-entitlement ## delete-access-model-metadata-from-entitlement
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Remove single Access Model Metadata from an entitlement. Remove single Access Model Metadata from an entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-access-model-metadata-from-entitlement) [API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-access-model-metadata-from-entitlement)
@@ -148,7 +140,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The entitlement id. Path | Id | **String** | True | The entitlement id.
Path | AttributeKey | **String** | True | Technical name of the Attribute. Path | AttributeKey | **String** | True | Technical name of the Attribute.
Path | AttributeValue | **String** | True | Technical name of the Attribute Value. Path | AttributeValue | **String** | True | Technical name of the Attribute Value.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type ### Return type
(empty response body) (empty response body)
@@ -172,15 +163,14 @@ Code | Description | Data Type
$Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id.
$AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute.
$AttributeValue = "public" # String | Technical name of the Attribute Value. $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. # Remove metadata from an entitlement.
try { try {
Remove-V2025AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental Remove-V2025AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Remove-V2025AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental # Remove-V2025AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccessModelMetadataFromEntitlement" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccessModelMetadataFromEntitlement"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -189,9 +179,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## get-entitlement ## get-entitlement
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns an entitlement by its ID. This API returns an entitlement by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-entitlement) [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-entitlement)
@@ -200,7 +187,6 @@ This API returns an entitlement by its ID.
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The entitlement ID Path | Id | **String** | True | The entitlement ID
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type ### Return type
[**Entitlement**](../models/entitlement) [**Entitlement**](../models/entitlement)
@@ -223,15 +209,14 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID $Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get an entitlement # Get an entitlement
try { try {
Get-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental Get-V2025Entitlement -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental # Get-V2025Entitlement -Id $Id
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Entitlement" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Entitlement"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -240,9 +225,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## get-entitlement-request-config ## get-entitlement-request-config
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns the entitlement request config for a specified entitlement. This API returns the entitlement request config for a specified entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-entitlement-request-config) [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-entitlement-request-config)
@@ -251,7 +233,6 @@ This API returns the entitlement request config for a specified entitlement.
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | Entitlement Id Path | Id | **String** | True | Entitlement Id
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type ### Return type
[**EntitlementRequestConfig**](../models/entitlement-request-config) [**EntitlementRequestConfig**](../models/entitlement-request-config)
@@ -274,15 +255,14 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get entitlement request config # Get entitlement request config
try { try {
Get-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental Get-V2025EntitlementRequestConfig -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental # Get-V2025EntitlementRequestConfig -Id $Id
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementRequestConfig" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementRequestConfig"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -294,9 +274,6 @@ try {
:::caution deprecated :::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API. This endpoint has been deprecated and may be replaced or removed in future versions of the API.
::: :::
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
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). 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. 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.
@@ -309,7 +286,6 @@ If the target source is a delimited file source, then the CSV file needs to be i
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | Source Id Path | Id | **String** | True | Source Id
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
| CsvFile | **System.IO.FileInfo** | (optional) | The CSV file containing the source entitlements to aggregate. | CsvFile | **System.IO.FileInfo** | (optional) | The CSV file containing the source entitlements to aggregate.
### Return type ### Return type
@@ -332,16 +308,15 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id $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) $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional)
# Aggregate entitlements # Aggregate entitlements
try { try {
Import-V2025EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental Import-V2025EntitlementsBySource -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Import-V2025EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental -CsvFile $CsvFile # Import-V2025EntitlementsBySource -Id $Id -CsvFile $CsvFile
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025EntitlementsBySource" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025EntitlementsBySource"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -350,9 +325,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## list-entitlement-children ## list-entitlement-children
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns a list of all child entitlements of a given entitlement. This API returns a list of all child entitlements of a given entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-entitlement-children) [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-entitlement-children)
@@ -361,7 +333,6 @@ This API returns a list of all child entitlements of a given entitlement.
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | Entitlement Id Path | Id | **String** | True | Entitlement Id
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Count | **Boolean** | (optional) (default to $false) | 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. Query | Count | **Boolean** | (optional) (default to $false) | 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.
@@ -389,7 +360,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$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) $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)
@@ -399,10 +369,10 @@ $Filters = 'attribute eq "memberOf"' # String | Filter results using the standar
# List of entitlements children # List of entitlements children
try { try {
Get-V2025EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental Get-V2025EntitlementChildren -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2025EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters # Get-V2025EntitlementChildren -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementChildren" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementChildren"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -411,9 +381,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## list-entitlement-parents ## list-entitlement-parents
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns a list of all parent entitlements of a given entitlement. This API returns a list of all parent entitlements of a given entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-entitlement-parents) [API Spec](https://developer.sailpoint.com/docs/api/v2025/list-entitlement-parents)
@@ -422,7 +389,6 @@ This API returns a list of all parent entitlements of a given entitlement.
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | Entitlement Id Path | Id | **String** | True | Entitlement Id
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Count | **Boolean** | (optional) (default to $false) | 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. Query | Count | **Boolean** | (optional) (default to $false) | 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.
@@ -450,7 +416,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id $Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$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) $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)
@@ -460,10 +425,10 @@ $Filters = 'attribute eq "memberOf"' # String | Filter results using the standar
# List of entitlements parents # List of entitlements parents
try { try {
Get-V2025EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental Get-V2025EntitlementParents -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2025EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters # Get-V2025EntitlementParents -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementParents" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementParents"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -472,9 +437,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## list-entitlements ## list-entitlements
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns a list of 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). 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).
@@ -486,7 +448,6 @@ Any authenticated token can call this API.
### Parameters ### Parameters
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Query | AccountId | **String** | (optional) | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). Query | AccountId | **String** | (optional) | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s).
Query | SegmentedForIdentity | **String** | (optional) | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. Query | SegmentedForIdentity | **String** | (optional) | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity.
Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s).
@@ -516,7 +477,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional)
$SegmentedForIdentity = "e554098913544630b5985e9042f5e44b" # String | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) $SegmentedForIdentity = "e554098913544630b5985e9042f5e44b" # String | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional)
$ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) $ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional)
@@ -530,10 +490,10 @@ $Filters = 'attribute eq "memberOf"' # String | Filter results using the standar
# Gets a list of entitlements. # Gets a list of entitlements.
try { try {
Get-V2025Entitlements -XSailPointExperimental $XSailPointExperimental Get-V2025Entitlements
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2025Entitlements -XSailPointExperimental $XSailPointExperimental -AccountId $AccountId -SegmentedForIdentity $SegmentedForIdentity -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters # Get-V2025Entitlements -AccountId $AccountId -SegmentedForIdentity $SegmentedForIdentity -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Entitlements" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Entitlements"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -542,9 +502,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## patch-entitlement ## patch-entitlement
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. 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** The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields**
@@ -557,7 +514,6 @@ When you're patching owner, only owner type and owner id must be provided. Owner
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | ID of the entitlement to patch Path | Id | **String** | True | ID of the entitlement to patch
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) | Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) |
### Return type ### Return type
@@ -581,7 +537,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch $Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$JsonPatchOperation = @"{ $JsonPatchOperation = @"{
"op" : "replace", "op" : "replace",
"path" : "/description", "path" : "/description",
@@ -592,10 +547,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Patch an entitlement # Patch an entitlement
try { try {
Update-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental Update-V2025Entitlement -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Update-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result # Update-V2025Entitlement -Id $Id -JsonPatchOperation $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Entitlement" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Entitlement"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -604,9 +559,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## put-entitlement-request-config ## put-entitlement-request-config
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API replaces the entitlement request config for a specified entitlement. This API replaces the entitlement request config for a specified entitlement.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-entitlement-request-config) [API Spec](https://developer.sailpoint.com/docs/api/v2025/put-entitlement-request-config)
@@ -615,7 +567,6 @@ This API replaces the entitlement request config for a specified entitlement.
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | Entitlement ID Path | Id | **String** | True | Entitlement ID
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | EntitlementRequestConfig | [**EntitlementRequestConfig**](../models/entitlement-request-config) | True | Body | EntitlementRequestConfig | [**EntitlementRequestConfig**](../models/entitlement-request-config) | True |
### Return type ### Return type
@@ -639,7 +590,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID $Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$EntitlementRequestConfig = @"{ $EntitlementRequestConfig = @"{
"accessRequestConfig" : { "accessRequestConfig" : {
"denialCommentRequired" : false, "denialCommentRequired" : false,
@@ -668,10 +618,10 @@ $EntitlementRequestConfig = @"{
try { try {
$Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig
Send-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result Send-V2025EntitlementRequestConfig -Id $Id -EntitlementRequestConfig $Result
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Send-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result # Send-V2025EntitlementRequestConfig -Id $Id -EntitlementRequestConfig $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025EntitlementRequestConfig" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025EntitlementRequestConfig"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -680,9 +630,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## reset-source-entitlements ## reset-source-entitlements
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Remove all entitlements from a specific source. 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`. 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`.
@@ -692,7 +639,6 @@ To reload the accounts along with the entitlements you removed, you must run an
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | ID of source for the entitlement reset 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 ### Return type
[**EntitlementSourceResetBaseReferenceDto**](../models/entitlement-source-reset-base-reference-dto) [**EntitlementSourceResetBaseReferenceDto**](../models/entitlement-source-reset-base-reference-dto)
@@ -714,15 +660,14 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset $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 # Reset source entitlements
try { try {
Reset-V2025SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental Reset-V2025SourceEntitlements -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Reset-V2025SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental # Reset-V2025SourceEntitlements -Id $Id
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2025SourceEntitlements" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2025SourceEntitlements"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -731,9 +676,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## update-entitlements-in-bulk ## update-entitlements-in-bulk
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API applies an update to every entitlement of the list. This API applies an update to every entitlement of the list.
@@ -754,7 +696,6 @@ A token with ORG_ADMIN or API authority is required to call this API.
### Parameters ### Parameters
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | EntitlementBulkUpdateRequest | [**EntitlementBulkUpdateRequest**](../models/entitlement-bulk-update-request) | True | Body | EntitlementBulkUpdateRequest | [**EntitlementBulkUpdateRequest**](../models/entitlement-bulk-update-request) | True |
### Return type ### Return type
@@ -776,7 +717,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$EntitlementBulkUpdateRequest = @"{ $EntitlementBulkUpdateRequest = @"{
"entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ],
"jsonPatch" : [ { "jsonPatch" : [ {
@@ -798,10 +738,10 @@ $EntitlementBulkUpdateRequest = @"{
try { try {
$Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest
Update-V2025EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result Update-V2025EntitlementsInBulk -EntitlementBulkUpdateRequest $Result
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Update-V2025EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result # Update-V2025EntitlementsInBulk -EntitlementBulkUpdateRequest $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025EntitlementsInBulk" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025EntitlementsInBulk"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

53
docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentitiesApi.md
View File

@@ -37,6 +37,7 @@ Method | HTTP request | Description
[**Get-V2025IdentityOwnershipDetails**](#get-identity-ownership-details) | **GET** `/identities/{identityId}/ownership` | Get ownership details [**Get-V2025IdentityOwnershipDetails**](#get-identity-ownership-details) | **GET** `/identities/{identityId}/ownership` | Get ownership details
[**Get-V2025RoleAssignment**](#get-role-assignment) | **GET** `/identities/{identityId}/role-assignments/{assignmentId}` | Role assignment details [**Get-V2025RoleAssignment**](#get-role-assignment) | **GET** `/identities/{identityId}/role-assignments/{assignmentId}` | Role assignment details
[**Get-V2025RoleAssignments**](#get-role-assignments) | **GET** `/identities/{identityId}/role-assignments` | List role assignments [**Get-V2025RoleAssignments**](#get-role-assignments) | **GET** `/identities/{identityId}/role-assignments` | List role assignments
[**Get-V2025EntitlementsByIdentity**](#list-entitlements-by-identity) | **GET** `/entitlements/identities/{id}/entitlements` | List of entitlements by identity.
[**Get-V2025Identities**](#list-identities) | **GET** `/identities` | List identities [**Get-V2025Identities**](#list-identities) | **GET** `/identities` | List identities
[**Reset-V2025Identity**](#reset-identity) | **POST** `/identities/{id}/reset` | Reset an identity [**Reset-V2025Identity**](#reset-identity) | **POST** `/identities/{id}/reset` | Reset an identity
[**Send-V2025IdentityVerificationAccountToken**](#send-identity-verification-account-token) | **POST** `/identities/{id}/verification/account/send` | Send password reset email [**Send-V2025IdentityVerificationAccountToken**](#send-identity-verification-account-token) | **POST** `/identities/{id}/verification/account/send` | Send password reset email
@@ -288,6 +289,58 @@ try {
``` ```
[[Back to top]](#) [[Back to top]](#)
## list-entitlements-by-identity
The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-entitlements-by-identity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | Identity Id
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Count | **Boolean** | (optional) (default to $false) | 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.
### Return type
[**IdentityEntitlements[]**](../models/identity-entitlements)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | List of all Entitlements for given Identity | IdentityEntitlements[]
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
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$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)
# List of entitlements by identity.
try {
Get-V2025EntitlementsByIdentity -Id $Id
# Below is a request that includes all optional parameters
# Get-V2025EntitlementsByIdentity -Id $Id -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementsByIdentity"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identities ## list-identities
This API returns a list of identities. This API returns a list of identities.

9
docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SourcesApi.md
View File

@@ -1646,9 +1646,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## import-entitlements ## import-entitlements
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Starts an entitlement aggregation on the specified source. Starts an entitlement aggregation on the specified source.
If the target source is a delimited file source, then the CSV file needs to be included in the request body. If the target source is a delimited file source, then the CSV file needs to be included in the request body.
You will also need to set the Content-Type header to `multipart/form-data`. You will also need to set the Content-Type header to `multipart/form-data`.
@@ -1660,7 +1657,6 @@ A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required t
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | SourceId | **String** | True | Source Id Path | SourceId | **String** | True | Source Id
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
| File | **System.IO.FileInfo** | (optional) | The CSV file containing the source entitlements to aggregate. | File | **System.IO.FileInfo** | (optional) | The CSV file containing the source entitlements to aggregate.
### Return type ### Return type
@@ -1683,16 +1679,15 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$File = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) $File = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional)
# Entitlement aggregation # Entitlement aggregation
try { try {
Import-V2025Entitlements -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental Import-V2025Entitlements -SourceId $SourceId
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Import-V2025Entitlements -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -File $File # Import-V2025Entitlements -SourceId $SourceId -File $File
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025Entitlements" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025Entitlements"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

37
docs/tools/sdk/powershell/Reference/V2025/Models/IdentityEntitlements.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: v2025-identity-entitlements
title: IdentityEntitlements
pagination_label: IdentityEntitlements
sidebar_label: IdentityEntitlements
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityEntitlements', 'V2025IdentityEntitlements']
slug: /tools/sdk/powershell/v2025/models/identity-entitlements
tags: ['SDK', 'Software Development Kit', 'IdentityEntitlements', 'V2025IdentityEntitlements']
---
# IdentityEntitlements
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ObjectRef** | [**TaggedObjectDto**](tagged-object-dto) | | [optional]
**Tags** | **[]String** | Labels to be applied to object. | [optional]
## Examples
- Prepare the resource
```powershell
$IdentityEntitlements = Initialize-V2025IdentityEntitlements -ObjectRef null `
-Tags [BU_FINANCE, PCI]
```
- Convert the resource to JSON
```powershell
$IdentityEntitlements | ConvertTo-JSON
```
[[Back to top]](#)

13
static/code-examples/beta/powershell_code_examples_overlay.yaml
View File

@@ -43,7 +43,11 @@
- lang: PowerShell - lang: PowerShell
label: SDK_tools/sdk/powershell/beta/methods/access-model-metadata#list-access-model-metadata-attribute label: SDK_tools/sdk/powershell/beta/methods/access-model-metadata#list-access-model-metadata-attribute
source: | source: |
$Filters = "name eq "Privacy"" # 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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) $Filters = "name eq "Privacy"" # 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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* **Supported composite operators**: *and* (optional)
$Sorters = "name,-key" # 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: **name, key** (optional)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$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)
# List access model metadata attributes # List access model metadata attributes
@@ -51,7 +55,7 @@
Get-BetaAccessModelMetadataAttribute Get-BetaAccessModelMetadataAttribute
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-BetaAccessModelMetadataAttribute -Filters $Filters # Get-BetaAccessModelMetadataAttribute -Filters $Filters -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -63,6 +67,9 @@
label: SDK_tools/sdk/powershell/beta/methods/access-model-metadata#list-access-model-metadata-attribute-value label: SDK_tools/sdk/powershell/beta/methods/access-model-metadata#list-access-model-metadata-attribute-value
source: | source: |
$Key = "iscPrivacy" # String | Technical name of the Attribute. $Key = "iscPrivacy" # String | Technical name of the Attribute.
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$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)
# List access model metadata values # List access model metadata values
@@ -70,7 +77,7 @@
Get-BetaAccessModelMetadataAttributeValue -Key $Key Get-BetaAccessModelMetadataAttributeValue -Key $Key
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-BetaAccessModelMetadataAttributeValue -Key $Key # Get-BetaAccessModelMetadataAttributeValue -Key $Key -Offset $Offset -Limit $Limit -Count $Count
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

94
static/code-examples/v2024/powershell_code_examples_overlay.yaml
View File

@@ -5,15 +5,14 @@
label: SDK_tools/sdk/powershell/v2024/methods/access-model-metadata#get-access-model-metadata-attribute label: SDK_tools/sdk/powershell/v2024/methods/access-model-metadata#get-access-model-metadata-attribute
source: | source: |
$Key = "iscPrivacy" # String | Technical name of the Attribute. $Key = "iscPrivacy" # String | Technical name of the Attribute.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get access model metadata attribute # Get access model metadata attribute
try { try {
Get-V2024AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental Get-V2024AccessModelMetadataAttribute -Key $Key
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental # Get-V2024AccessModelMetadataAttribute -Key $Key
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -26,15 +25,14 @@
source: | source: |
$Key = "iscPrivacy" # String | Technical name of the Attribute. $Key = "iscPrivacy" # String | Technical name of the Attribute.
$Value = "public" # String | Technical name of the Attribute value. $Value = "public" # String | Technical name of the Attribute value.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get access model metadata value # Get access model metadata value
try { try {
Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental # Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -45,16 +43,19 @@
- lang: PowerShell - lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/access-model-metadata#list-access-model-metadata-attribute label: SDK_tools/sdk/powershell/v2024/methods/access-model-metadata#list-access-model-metadata-attribute
source: | source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Filters = "name eq "Privacy"" # 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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* **Supported composite operators**: *and* (optional)
$Filters = "name eq "Privacy"" # 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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) $Sorters = "name,-key" # 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: **name, key** (optional)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$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)
# List access model metadata attributes # List access model metadata attributes
try { try {
Get-V2024AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental Get-V2024AccessModelMetadataAttribute
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental -Filters $Filters # Get-V2024AccessModelMetadataAttribute -Filters $Filters -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -66,15 +67,17 @@
label: SDK_tools/sdk/powershell/v2024/methods/access-model-metadata#list-access-model-metadata-attribute-value label: SDK_tools/sdk/powershell/v2024/methods/access-model-metadata#list-access-model-metadata-attribute-value
source: | source: |
$Key = "iscPrivacy" # String | Technical name of the Attribute. $Key = "iscPrivacy" # String | Technical name of the Attribute.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$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)
# List access model metadata values # List access model metadata values
try { try {
Get-V2024AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental Get-V2024AccessModelMetadataAttributeValue -Key $Key
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental # Get-V2024AccessModelMetadataAttributeValue -Key $Key -Offset $Offset -Limit $Limit -Count $Count
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -5512,15 +5515,14 @@
$Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id.
$AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute.
$AttributeValue = "public" # String | Technical name of the Attribute Value. $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. # Add metadata to an entitlement.
try { try {
New-V2024AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental New-V2024AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# New-V2024AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental # New-V2024AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessModelMetadataForEntitlement" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessModelMetadataForEntitlement"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -5534,15 +5536,14 @@
$Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id.
$AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute.
$AttributeValue = "public" # String | Technical name of the Attribute Value. $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. # Remove metadata from an entitlement.
try { try {
Remove-V2024AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental Remove-V2024AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Remove-V2024AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental # Remove-V2024AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessModelMetadataFromEntitlement" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessModelMetadataFromEntitlement"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -5554,15 +5555,14 @@
label: SDK_tools/sdk/powershell/v2024/methods/entitlements#get-entitlement label: SDK_tools/sdk/powershell/v2024/methods/entitlements#get-entitlement
source: | source: |
$Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID $Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get an entitlement # Get an entitlement
try { try {
Get-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental Get-V2024Entitlement -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental # Get-V2024Entitlement -Id $Id
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlement" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlement"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -5574,15 +5574,14 @@
label: SDK_tools/sdk/powershell/v2024/methods/entitlements#get-entitlement-request-config label: SDK_tools/sdk/powershell/v2024/methods/entitlements#get-entitlement-request-config
source: | source: |
$Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get entitlement request config # Get entitlement request config
try { try {
Get-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental Get-V2024EntitlementRequestConfig -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental # Get-V2024EntitlementRequestConfig -Id $Id
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementRequestConfig" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementRequestConfig"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -5594,16 +5593,15 @@
label: SDK_tools/sdk/powershell/v2024/methods/entitlements#import-entitlements-by-source label: SDK_tools/sdk/powershell/v2024/methods/entitlements#import-entitlements-by-source
source: | source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id $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) $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional)
# Aggregate entitlements # Aggregate entitlements
try { try {
Import-V2024EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental Import-V2024EntitlementsBySource -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Import-V2024EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental -CsvFile $CsvFile # Import-V2024EntitlementsBySource -Id $Id -CsvFile $CsvFile
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024EntitlementsBySource" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024EntitlementsBySource"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -5615,7 +5613,6 @@
label: SDK_tools/sdk/powershell/v2024/methods/entitlements#list-entitlement-children label: SDK_tools/sdk/powershell/v2024/methods/entitlements#list-entitlement-children
source: | source: |
$Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$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) $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)
@@ -5625,10 +5622,10 @@
# List of entitlements children # List of entitlements children
try { try {
Get-V2024EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental Get-V2024EntitlementChildren -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters # Get-V2024EntitlementChildren -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChildren" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChildren"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -5640,7 +5637,6 @@
label: SDK_tools/sdk/powershell/v2024/methods/entitlements#list-entitlement-parents label: SDK_tools/sdk/powershell/v2024/methods/entitlements#list-entitlement-parents
source: | source: |
$Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id $Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$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) $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)
@@ -5650,10 +5646,10 @@
# List of entitlements parents # List of entitlements parents
try { try {
Get-V2024EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental Get-V2024EntitlementParents -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters # Get-V2024EntitlementParents -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementParents" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementParents"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -5664,7 +5660,6 @@
- lang: PowerShell - lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/entitlements#list-entitlements label: SDK_tools/sdk/powershell/v2024/methods/entitlements#list-entitlements
source: | source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional)
$SegmentedForIdentity = "e554098913544630b5985e9042f5e44b" # String | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) $SegmentedForIdentity = "e554098913544630b5985e9042f5e44b" # String | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional)
$ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) $ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional)
@@ -5678,10 +5673,10 @@
# Gets a list of entitlements. # Gets a list of entitlements.
try { try {
Get-V2024Entitlements -XSailPointExperimental $XSailPointExperimental Get-V2024Entitlements
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024Entitlements -XSailPointExperimental $XSailPointExperimental -AccountId $AccountId -SegmentedForIdentity $SegmentedForIdentity -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters # Get-V2024Entitlements -AccountId $AccountId -SegmentedForIdentity $SegmentedForIdentity -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlements" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlements"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -5693,7 +5688,6 @@
label: SDK_tools/sdk/powershell/v2024/methods/entitlements#patch-entitlement label: SDK_tools/sdk/powershell/v2024/methods/entitlements#patch-entitlement
source: | source: |
$Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch $Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$JsonPatchOperation = @"{ $JsonPatchOperation = @"{
"op" : "replace", "op" : "replace",
"path" : "/description", "path" : "/description",
@@ -5704,10 +5698,10 @@
# Patch an entitlement # Patch an entitlement
try { try {
Update-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental Update-V2024Entitlement -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Update-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result # Update-V2024Entitlement -Id $Id -JsonPatchOperation $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Entitlement" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Entitlement"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -5719,7 +5713,6 @@
label: SDK_tools/sdk/powershell/v2024/methods/entitlements#put-entitlement-request-config label: SDK_tools/sdk/powershell/v2024/methods/entitlements#put-entitlement-request-config
source: | source: |
$Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID $Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$EntitlementRequestConfig = @" $EntitlementRequestConfig = @"
{ {
"accessRequestConfig" : { "accessRequestConfig" : {
@@ -5750,10 +5743,10 @@
try { try {
$Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig
Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result Send-V2024EntitlementRequestConfig -Id $Id -EntitlementRequestConfig $Result
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result # Send-V2024EntitlementRequestConfig -Id $Id -EntitlementRequestConfig $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024EntitlementRequestConfig" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024EntitlementRequestConfig"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -5765,15 +5758,14 @@
label: SDK_tools/sdk/powershell/v2024/methods/entitlements#reset-source-entitlements label: SDK_tools/sdk/powershell/v2024/methods/entitlements#reset-source-entitlements
source: | source: |
$Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset $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 # Reset source entitlements
try { try {
Reset-V2024SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental Reset-V2024SourceEntitlements -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Reset-V2024SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental # Reset-V2024SourceEntitlements -Id $Id
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024SourceEntitlements" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024SourceEntitlements"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -5784,7 +5776,6 @@
- lang: PowerShell - lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/entitlements#update-entitlements-in-bulk label: SDK_tools/sdk/powershell/v2024/methods/entitlements#update-entitlements-in-bulk
source: | source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$EntitlementBulkUpdateRequest = @" $EntitlementBulkUpdateRequest = @"
{ {
"entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ],
@@ -5808,10 +5799,10 @@
try { try {
$Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest
Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result Update-V2024EntitlementsInBulk -EntitlementBulkUpdateRequest $Result
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result # Update-V2024EntitlementsInBulk -EntitlementBulkUpdateRequest $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsInBulk" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsInBulk"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -16025,16 +16016,15 @@
label: SDK_tools/sdk/powershell/v2024/methods/sources#import-entitlements label: SDK_tools/sdk/powershell/v2024/methods/sources#import-entitlements
source: | source: |
$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$File = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) $File = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional)
# Entitlement aggregation # Entitlement aggregation
try { try {
Import-V2024Entitlements -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental Import-V2024Entitlements -SourceId $SourceId
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Import-V2024Entitlements -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -File $File # Import-V2024Entitlements -SourceId $SourceId -File $File
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024Entitlements" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024Entitlements"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

116
static/code-examples/v2025/powershell_code_examples_overlay.yaml
View File

@@ -5,15 +5,14 @@
label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#get-access-model-metadata-attribute label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#get-access-model-metadata-attribute
source: | source: |
$Key = "iscPrivacy" # String | Technical name of the Attribute. $Key = "iscPrivacy" # String | Technical name of the Attribute.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get access model metadata attribute # Get access model metadata attribute
try { try {
Get-V2025AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental Get-V2025AccessModelMetadataAttribute -Key $Key
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2025AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental # Get-V2025AccessModelMetadataAttribute -Key $Key
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttribute" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttribute"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -26,15 +25,14 @@
source: | source: |
$Key = "iscPrivacy" # String | Technical name of the Attribute. $Key = "iscPrivacy" # String | Technical name of the Attribute.
$Value = "public" # String | Technical name of the Attribute value. $Value = "public" # String | Technical name of the Attribute value.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get access model metadata value # Get access model metadata value
try { try {
Get-V2025AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental Get-V2025AccessModelMetadataAttributeValue -Key $Key -Value $Value
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2025AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental # Get-V2025AccessModelMetadataAttributeValue -Key $Key -Value $Value
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttributeValue" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttributeValue"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -45,16 +43,19 @@
- lang: PowerShell - lang: PowerShell
label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#list-access-model-metadata-attribute label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#list-access-model-metadata-attribute
source: | source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Filters = "name eq "Privacy"" # 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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* **Supported composite operators**: *and* (optional)
$Filters = "name eq "Privacy"" # 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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) $Sorters = "name,-key" # 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: **name, key** (optional)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$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)
# List access model metadata attributes # List access model metadata attributes
try { try {
Get-V2025AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental Get-V2025AccessModelMetadataAttribute
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2025AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental -Filters $Filters # Get-V2025AccessModelMetadataAttribute -Filters $Filters -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttribute" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttribute"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -66,15 +67,17 @@
label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#list-access-model-metadata-attribute-value label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#list-access-model-metadata-attribute-value
source: | source: |
$Key = "iscPrivacy" # String | Technical name of the Attribute. $Key = "iscPrivacy" # String | Technical name of the Attribute.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$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)
# List access model metadata values # List access model metadata values
try { try {
Get-V2025AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental Get-V2025AccessModelMetadataAttributeValue -Key $Key
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2025AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental # Get-V2025AccessModelMetadataAttributeValue -Key $Key -Offset $Offset -Limit $Limit -Count $Count
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttributeValue" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttributeValue"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -5763,15 +5766,14 @@
$Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id.
$AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute.
$AttributeValue = "public" # String | Technical name of the Attribute Value. $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. # Add metadata to an entitlement.
try { try {
New-V2025AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental New-V2025AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# New-V2025AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental # New-V2025AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025AccessModelMetadataForEntitlement" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025AccessModelMetadataForEntitlement"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -5785,15 +5787,14 @@
$Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id.
$AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute.
$AttributeValue = "public" # String | Technical name of the Attribute Value. $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. # Remove metadata from an entitlement.
try { try {
Remove-V2025AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental Remove-V2025AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Remove-V2025AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental # Remove-V2025AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccessModelMetadataFromEntitlement" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccessModelMetadataFromEntitlement"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -5805,15 +5806,14 @@
label: SDK_tools/sdk/powershell/v2025/methods/entitlements#get-entitlement label: SDK_tools/sdk/powershell/v2025/methods/entitlements#get-entitlement
source: | source: |
$Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID $Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get an entitlement # Get an entitlement
try { try {
Get-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental Get-V2025Entitlement -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental # Get-V2025Entitlement -Id $Id
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Entitlement" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Entitlement"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -5825,15 +5825,14 @@
label: SDK_tools/sdk/powershell/v2025/methods/entitlements#get-entitlement-request-config label: SDK_tools/sdk/powershell/v2025/methods/entitlements#get-entitlement-request-config
source: | source: |
$Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get entitlement request config # Get entitlement request config
try { try {
Get-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental Get-V2025EntitlementRequestConfig -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental # Get-V2025EntitlementRequestConfig -Id $Id
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementRequestConfig" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementRequestConfig"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -5845,16 +5844,15 @@
label: SDK_tools/sdk/powershell/v2025/methods/entitlements#import-entitlements-by-source label: SDK_tools/sdk/powershell/v2025/methods/entitlements#import-entitlements-by-source
source: | source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id $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) $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional)
# Aggregate entitlements # Aggregate entitlements
try { try {
Import-V2025EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental Import-V2025EntitlementsBySource -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Import-V2025EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental -CsvFile $CsvFile # Import-V2025EntitlementsBySource -Id $Id -CsvFile $CsvFile
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025EntitlementsBySource" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025EntitlementsBySource"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -5866,7 +5864,6 @@
label: SDK_tools/sdk/powershell/v2025/methods/entitlements#list-entitlement-children label: SDK_tools/sdk/powershell/v2025/methods/entitlements#list-entitlement-children
source: | source: |
$Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$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) $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)
@@ -5876,10 +5873,10 @@
# List of entitlements children # List of entitlements children
try { try {
Get-V2025EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental Get-V2025EntitlementChildren -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2025EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters # Get-V2025EntitlementChildren -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementChildren" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementChildren"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -5891,7 +5888,6 @@
label: SDK_tools/sdk/powershell/v2025/methods/entitlements#list-entitlement-parents label: SDK_tools/sdk/powershell/v2025/methods/entitlements#list-entitlement-parents
source: | source: |
$Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id $Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$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) $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)
@@ -5901,10 +5897,10 @@
# List of entitlements parents # List of entitlements parents
try { try {
Get-V2025EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental Get-V2025EntitlementParents -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2025EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters # Get-V2025EntitlementParents -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementParents" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementParents"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -5915,7 +5911,6 @@
- lang: PowerShell - lang: PowerShell
label: SDK_tools/sdk/powershell/v2025/methods/entitlements#list-entitlements label: SDK_tools/sdk/powershell/v2025/methods/entitlements#list-entitlements
source: | source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional)
$SegmentedForIdentity = "e554098913544630b5985e9042f5e44b" # String | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) $SegmentedForIdentity = "e554098913544630b5985e9042f5e44b" # String | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional)
$ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) $ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional)
@@ -5929,10 +5924,10 @@
# Gets a list of entitlements. # Gets a list of entitlements.
try { try {
Get-V2025Entitlements -XSailPointExperimental $XSailPointExperimental Get-V2025Entitlements
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2025Entitlements -XSailPointExperimental $XSailPointExperimental -AccountId $AccountId -SegmentedForIdentity $SegmentedForIdentity -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters # Get-V2025Entitlements -AccountId $AccountId -SegmentedForIdentity $SegmentedForIdentity -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Entitlements" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Entitlements"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -5944,7 +5939,6 @@
label: SDK_tools/sdk/powershell/v2025/methods/entitlements#patch-entitlement label: SDK_tools/sdk/powershell/v2025/methods/entitlements#patch-entitlement
source: | source: |
$Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch $Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$JsonPatchOperation = @"{ $JsonPatchOperation = @"{
"op" : "replace", "op" : "replace",
"path" : "/description", "path" : "/description",
@@ -5955,10 +5949,10 @@
# Patch an entitlement # Patch an entitlement
try { try {
Update-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental Update-V2025Entitlement -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Update-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result # Update-V2025Entitlement -Id $Id -JsonPatchOperation $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Entitlement" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Entitlement"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -5970,7 +5964,6 @@
label: SDK_tools/sdk/powershell/v2025/methods/entitlements#put-entitlement-request-config label: SDK_tools/sdk/powershell/v2025/methods/entitlements#put-entitlement-request-config
source: | source: |
$Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID $Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$EntitlementRequestConfig = @" $EntitlementRequestConfig = @"
{ {
"accessRequestConfig" : { "accessRequestConfig" : {
@@ -6001,10 +5994,10 @@
try { try {
$Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig
Send-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result Send-V2025EntitlementRequestConfig -Id $Id -EntitlementRequestConfig $Result
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Send-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result # Send-V2025EntitlementRequestConfig -Id $Id -EntitlementRequestConfig $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025EntitlementRequestConfig" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025EntitlementRequestConfig"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -6016,15 +6009,14 @@
label: SDK_tools/sdk/powershell/v2025/methods/entitlements#reset-source-entitlements label: SDK_tools/sdk/powershell/v2025/methods/entitlements#reset-source-entitlements
source: | source: |
$Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset $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 # Reset source entitlements
try { try {
Reset-V2025SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental Reset-V2025SourceEntitlements -Id $Id
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Reset-V2025SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental # Reset-V2025SourceEntitlements -Id $Id
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2025SourceEntitlements" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2025SourceEntitlements"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -6035,7 +6027,6 @@
- lang: PowerShell - lang: PowerShell
label: SDK_tools/sdk/powershell/v2025/methods/entitlements#update-entitlements-in-bulk label: SDK_tools/sdk/powershell/v2025/methods/entitlements#update-entitlements-in-bulk
source: | source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$EntitlementBulkUpdateRequest = @" $EntitlementBulkUpdateRequest = @"
{ {
"entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ],
@@ -6059,10 +6050,10 @@
try { try {
$Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest
Update-V2025EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result Update-V2025EntitlementsInBulk -EntitlementBulkUpdateRequest $Result
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Update-V2025EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result # Update-V2025EntitlementsInBulk -EntitlementBulkUpdateRequest $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025EntitlementsInBulk" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025EntitlementsInBulk"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -7949,6 +7940,28 @@
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleAssignments" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleAssignments"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
} }
- path: /entitlements/identities/{id}/entitlements
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2025/methods/identities#list-entitlements-by-identity
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$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)
# List of entitlements by identity.
try {
Get-V2025EntitlementsByIdentity -Id $Id
# Below is a request that includes all optional parameters
# Get-V2025EntitlementsByIdentity -Id $Id -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementsByIdentity"
Write-Host $_.ErrorDetails
}
- path: /identities - path: /identities
method: GET method: GET
xCodeSample: xCodeSample:
@@ -16296,16 +16309,15 @@
label: SDK_tools/sdk/powershell/v2025/methods/sources#import-entitlements label: SDK_tools/sdk/powershell/v2025/methods/sources#import-entitlements
source: | source: |
$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$File = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) $File = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional)
# Entitlement aggregation # Entitlement aggregation
try { try {
Import-V2025Entitlements -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental Import-V2025Entitlements -SourceId $SourceId
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Import-V2025Entitlements -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -File $File # Import-V2025Entitlements -SourceId $SourceId -File $File
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025Entitlements" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025Entitlements"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails