mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 20:37:46 +00:00
Update to powershell SDK docs: 13122455471
This commit is contained in:
developer-relations-sp
@@ -1,3 +1,4 @@
|
||||
|
||||
---
|
||||
id: beta-iai-access-request-recommendations
|
||||
title: IAIAccessRequestRecommendations
|
||||
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/iai-access-request-recommendations
|
||||
tags: ['SDK', 'Software Development Kit', 'IAIAccessRequestRecommendations', 'BetaIAIAccessRequestRecommendations']
|
||||
---
|
||||
|
||||
|
||||
# IAIAccessRequestRecommendations
|
||||
|
||||
|
||||
@@ -27,9 +27,7 @@ Method | HTTP request | Description
|
||||
[**Get-BetaAccessRequestRecommendationsRequestedItems**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List of Requested Access Request Recommendations
|
||||
[**Get-BetaAccessRequestRecommendationsViewedItems**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List of Viewed Access Request Recommendations
|
||||
|
||||
|
||||
## add-access-request-recommendations-ignored-item
|
||||
|
||||
This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations.
|
||||
|
||||
### Parameters
|
||||
@@ -38,7 +36,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Body | AccessRequestRecommendationActionItemDto | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access item to ignore for an identity.
|
||||
|
||||
### Return type
|
||||
|
||||
[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto)
|
||||
|
||||
### Responses
|
||||
@@ -52,7 +49,6 @@ Code | Description | Data Type
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
@@ -65,7 +61,9 @@ $AccessRequestRecommendationActionItemDto = @"{
|
||||
},
|
||||
"identityId" : "2c91808570313110017040b06f344ec9"
|
||||
}"@
|
||||
|
||||
# Notification of Ignored Access Request Recommendations
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
|
||||
Add-BetaAccessRequestRecommendationsIgnoredItem-BetaAccessRequestRecommendationActionItemDto $Result
|
||||
@@ -77,11 +75,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## add-access-request-recommendations-requested-item
|
||||
|
||||
This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations.
|
||||
|
||||
### Parameters
|
||||
@@ -90,7 +85,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Body | AccessRequestRecommendationActionItemDto | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access item that was requested for an identity.
|
||||
|
||||
### Return type
|
||||
|
||||
[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto)
|
||||
|
||||
### Responses
|
||||
@@ -104,7 +98,6 @@ Code | Description | Data Type
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
@@ -117,7 +110,9 @@ $AccessRequestRecommendationActionItemDto = @"{
|
||||
},
|
||||
"identityId" : "2c91808570313110017040b06f344ec9"
|
||||
}"@
|
||||
|
||||
# Notification of Requested Access Request Recommendations
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
|
||||
Add-BetaAccessRequestRecommendationsRequestedItem-BetaAccessRequestRecommendationActionItemDto $Result
|
||||
@@ -129,11 +124,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## add-access-request-recommendations-viewed-item
|
||||
|
||||
This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations.
|
||||
|
||||
### Parameters
|
||||
@@ -142,7 +134,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Body | AccessRequestRecommendationActionItemDto | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access that was viewed for an identity.
|
||||
|
||||
### Return type
|
||||
|
||||
[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto)
|
||||
|
||||
### Responses
|
||||
@@ -156,7 +147,6 @@ Code | Description | Data Type
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
@@ -169,7 +159,9 @@ $AccessRequestRecommendationActionItemDto = @"{
|
||||
},
|
||||
"identityId" : "2c91808570313110017040b06f344ec9"
|
||||
}"@
|
||||
|
||||
# Notification of Viewed Access Request Recommendations
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
|
||||
Add-BetaAccessRequestRecommendationsViewedItem-BetaAccessRequestRecommendationActionItemDto $Result
|
||||
@@ -181,11 +173,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## add-access-request-recommendations-viewed-items
|
||||
|
||||
This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations.
|
||||
|
||||
### Parameters
|
||||
@@ -194,7 +183,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Body | AccessRequestRecommendationActionItemDto | [**[]AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access items that were viewed for an identity.
|
||||
|
||||
### Return type
|
||||
|
||||
[**AccessRequestRecommendationActionItemResponseDto[]**](../models/access-request-recommendation-action-item-response-dto)
|
||||
|
||||
### Responses
|
||||
@@ -208,22 +196,22 @@ Code | Description | Data Type
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
# AccessRequestRecommendationActionItemDto[] | The recommended access items that were viewed for an identity.
|
||||
$AccessRequestRecommendationActionItemDto = @"{
|
||||
"access" : {
|
||||
"id" : "2c9180835d2e5168015d32f890ca1581",
|
||||
"type" : "ACCESS_PROFILE"
|
||||
},
|
||||
"identityId" : "2c91808570313110017040b06f344ec9"
|
||||
}"@
|
||||
}"@ # AccessRequestRecommendationActionItemDto[] | The recommended access items that were viewed for an identity.
|
||||
|
||||
|
||||
# Notification of Viewed Access Request Recommendations in Bulk
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
|
||||
Add-BetaAccessRequestRecommendationsViewedItems-BetaAccessRequestRecommendationActionItemDto $Result
|
||||
@@ -235,11 +223,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-access-request-recommendations
|
||||
|
||||
This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user.
|
||||
|
||||
### Parameters
|
||||
@@ -254,7 +239,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first.
|
||||
|
||||
### Return type
|
||||
|
||||
[**AccessRequestRecommendationItemDetail[]**](../models/access-request-recommendation-item-detail)
|
||||
|
||||
### Responses
|
||||
@@ -268,7 +252,6 @@ Code | Description | Data Type
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
@@ -281,7 +264,9 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
|
||||
$IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false)
|
||||
$Filters = 'access.name co "admin"' # 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional)
|
||||
$Sorters = "MySorters" # 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional)
|
||||
|
||||
# Identity Access Request Recommendations
|
||||
|
||||
try {
|
||||
Get-BetaAccessRequestRecommendations
|
||||
|
||||
@@ -292,11 +277,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-access-request-recommendations-ignored-items
|
||||
|
||||
This API returns the list of ignored access request recommendations.
|
||||
|
||||
### Parameters
|
||||
@@ -309,7 +291,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp**
|
||||
|
||||
### Return type
|
||||
|
||||
[**AccessRequestRecommendationActionItemResponseDto[]**](../models/access-request-recommendation-action-item-response-dto)
|
||||
|
||||
### Responses
|
||||
@@ -323,7 +304,6 @@ Code | Description | Data Type
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
@@ -334,7 +314,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
|
||||
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
||||
$Filters = 'identityId eq "2c9180846b0a0583016b299f210c1314"' # 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
|
||||
$Sorters = "access.id" # 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: **access.id, access.type, identityId, timestamp** (optional)
|
||||
|
||||
# List of Ignored Access Request Recommendations
|
||||
|
||||
try {
|
||||
Get-BetaAccessRequestRecommendationsIgnoredItems
|
||||
|
||||
@@ -345,11 +327,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-access-request-recommendations-requested-items
|
||||
|
||||
This API returns a list of requested access request recommendations.
|
||||
|
||||
### Parameters
|
||||
@@ -362,7 +341,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp**
|
||||
|
||||
### Return type
|
||||
|
||||
[**AccessRequestRecommendationActionItemResponseDto[]**](../models/access-request-recommendation-action-item-response-dto)
|
||||
|
||||
### Responses
|
||||
@@ -376,7 +354,6 @@ Code | Description | Data Type
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
@@ -387,7 +364,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
|
||||
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
||||
$Filters = 'access.id eq "2c9180846b0a0583016b299f210c1314"' # 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
|
||||
$Sorters = "MySorters" # 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: **access.id, access.type, identityId, timestamp** (optional)
|
||||
|
||||
# List of Requested Access Request Recommendations
|
||||
|
||||
try {
|
||||
Get-BetaAccessRequestRecommendationsRequestedItems
|
||||
|
||||
@@ -398,11 +377,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-access-request-recommendations-viewed-items
|
||||
|
||||
This API returns the list of viewed access request recommendations.
|
||||
|
||||
### Parameters
|
||||
@@ -415,7 +391,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp**
|
||||
|
||||
### Return type
|
||||
|
||||
[**AccessRequestRecommendationActionItemResponseDto[]**](../models/access-request-recommendation-action-item-response-dto)
|
||||
|
||||
### Responses
|
||||
@@ -429,7 +404,6 @@ Code | Description | Data Type
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
@@ -440,7 +414,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
|
||||
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
||||
$Filters = 'access.id eq "2c9180846b0a0583016b299f210c1314"' # 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
|
||||
$Sorters = "MySorters" # 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: **access.id, access.type, identityId, timestamp** (optional)
|
||||
|
||||
# List of Viewed Access Request Recommendations
|
||||
|
||||
try {
|
||||
Get-BetaAccessRequestRecommendationsViewedItems
|
||||
|
||||
@@ -451,7 +427,4 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user