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

Update to powershell SDK docs: 13122455471

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-03 20:42:04 +00:00
parent aeda961e54
commit bdb088c15d
207 changed files with 3520 additions and 8694 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRecommendationsApi.md
View File

@@ -1,3 +1,4 @@
---
id: beta-iai-recommendations
title: IAIRecommendations
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/iai-recommendations
tags: ['SDK', 'Software Development Kit', 'IAIRecommendations', 'BetaIAIRecommendations']
---
# IAIRecommendations
@@ -22,9 +22,7 @@ Method | HTTP request | Description
[**Get-BetaRecommendationsConfig**](#get-recommendations-config) | **GET** `/recommendations/config` | Get certification recommendation config values
[**Update-BetaRecommendationsConfig**](#update-recommendations-config) | **PUT** `/recommendations/config` | Update certification recommendation config values
## get-recommendations
The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations.
### Parameters
@@ -33,7 +31,6 @@ Param Type | Name | Data Type | Required | Description
Body | RecommendationRequestDto | [**RecommendationRequestDto**](../models/recommendation-request-dto) | True |
### Return type
[**RecommendationResponseDto**](../models/recommendation-response-dto)
### Responses
@@ -47,7 +44,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
@@ -72,7 +68,9 @@ $RecommendationRequestDto = @"{
"includeTranslationMessages" : false,
"includeDebugInformation" : true
}"@
# Returns a Recommendation Based on Object
try {
$Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto
Get-BetaRecommendations-BetaRecommendationRequestDto $Result
@@ -84,11 +82,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-recommendations-config
Retrieves configuration attributes used by certification recommendations.
### Parameters
@@ -96,7 +91,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**RecommendationConfigDto**](../models/recommendation-config-dto)
### Responses
@@ -109,13 +103,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# Get certification recommendation config values
try {
Get-BetaRecommendationsConfig
@@ -126,11 +121,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-recommendations-config
Updates configuration attributes used by certification recommendations.
### Parameters
@@ -139,7 +131,6 @@ Param Type | Name | Data Type | Required | Description
Body | RecommendationConfigDto | [**RecommendationConfigDto**](../models/recommendation-config-dto) | True |
### Return type
[**RecommendationConfigDto**](../models/recommendation-config-dto)
### Responses
@@ -152,7 +143,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
@@ -164,7 +154,9 @@ $RecommendationConfigDto = @"{
"runAutoSelectOnce" : false,
"onlyTuneThreshold" : false
}"@
# Update certification recommendation config values
try {
$Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto
Update-BetaRecommendationsConfig-BetaRecommendationConfigDto $Result
@@ -176,7 +168,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)