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

Update to powershell SDK docs: 13207859154

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-07 20:53:08 +00:00
parent fea17715f4
commit 09ed592191
244 changed files with 12907 additions and 6931 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -21,9 +21,12 @@ 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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-recommendations)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -72,19 +75,22 @@ $RecommendationRequestDto = @"{
try {
$Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto
Get-BetaRecommendations -BetaRecommendationRequestDto $Result
Get-BetaRecommendations -BetaRecommendationRequestDto $Result
# Below is a request that includes all optional parameters
# Get-BetaRecommendations -BetaRecommendationRequestDto $RecommendationRequestDto
# Get-BetaRecommendations -BetaRecommendationRequestDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRecommendations"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-recommendations-config
Retrieves configuration attributes used by certification recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-recommendations-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -111,7 +117,7 @@ Code | Description | Data Type
# Get certification recommendation config values
try {
Get-BetaRecommendationsConfig
Get-BetaRecommendationsConfig
# Below is a request that includes all optional parameters
# Get-BetaRecommendationsConfig
@@ -121,9 +127,12 @@ try {
}
```
[[Back to top]](#)
## update-recommendations-config
Updates configuration attributes used by certification recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/beta/update-recommendations-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -158,10 +167,10 @@ $RecommendationConfigDto = @"{
try {
$Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto
Update-BetaRecommendationsConfig -BetaRecommendationConfigDto $Result
Update-BetaRecommendationsConfig -BetaRecommendationConfigDto $Result
# Below is a request that includes all optional parameters
# Update-BetaRecommendationsConfig -BetaRecommendationConfigDto $RecommendationConfigDto
# Update-BetaRecommendationsConfig -BetaRecommendationConfigDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRecommendationsConfig"
Write-Host $_.ErrorDetails