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: 13525029562

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-25 15:38:40 +00:00
parent 1d5ca26ab9
commit 0dbc48429c
3 changed files with 202 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -22,9 +22,11 @@ Method | HTTP request | Description
[**Add-V2024AccessRequestRecommendationsViewedItem**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Notification of Viewed Access Request Recommendations
[**Add-V2024AccessRequestRecommendationsViewedItems**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Notification of Viewed Access Request Recommendations in Bulk
[**Get-V2024AccessRequestRecommendations**](#get-access-request-recommendations) | **GET** `/ai-access-request-recommendations` | Identity Access Request Recommendations
[**Get-V2024AccessRequestRecommendationsConfig**](#get-access-request-recommendations-config) | **GET** `/ai-access-request-recommendations/config` | Get Access Request Recommendations config
[**Get-V2024AccessRequestRecommendationsIgnoredItems**](#get-access-request-recommendations-ignored-items) | **GET** `/ai-access-request-recommendations/ignored-items` | List of Ignored Access Request Recommendations
[**Get-V2024AccessRequestRecommendationsRequestedItems**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List of Requested Access Request Recommendations
[**Get-V2024AccessRequestRecommendationsViewedItems**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List of Viewed Access Request Recommendations
[**Set-V2024AccessRequestRecommendationsConfig**](#set-access-request-recommendations-config) | **PUT** `/ai-access-request-recommendations/config` | Update Access Request Recommendations config
## add-access-request-recommendations-ignored-item
@@ -318,6 +320,54 @@ try {
```
[[Back to top]](#)
## get-access-request-recommendations-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 configurations for Access Request Recommender for the tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Configurations for Access Request Recommender for the tenant. | AccessRequestRecommendationConfigDto
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
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
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get Access Request Recommendations config
try {
Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-access-request-recommendations-ignored-items
:::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.
@@ -491,3 +541,61 @@ try {
}
```
[[Back to top]](#)
## set-access-request-recommendations-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 updates the configurations for Access Request Recommender for the tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-access-request-recommendations-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | AccessRequestRecommendationConfigDto | [**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto) | True | The desired configurations for Access Request Recommender for the tenant.
### Return type
[**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Successfully updated configurations for Access Request Recommender for the tenant. | AccessRequestRecommendationConfigDto
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
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**: application/json
- **Accept**: application/json
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$AccessRequestRecommendationConfigDto = @"{
"scoreThreshold" : 0.5,
"startDateAttribute" : "startDate",
"restrictionAttribute" : "location",
"moverAttribute" : "isMover",
"joinerAttribute" : "isJoiner",
"useRestrictionAttribute" : true
}"@
# Update Access Request Recommendations config
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationConfigDto -Json $AccessRequestRecommendationConfigDto
Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationConfigDto $Result
# Below is a request that includes all optional parameters
# Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationConfigDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestRecommendationsConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

45
docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestRecommendationConfigDto.md Normal file
View File

@@ -0,0 +1,45 @@
---
id: v2024-access-request-recommendation-config-dto
title: AccessRequestRecommendationConfigDto
pagination_label: AccessRequestRecommendationConfigDto
sidebar_label: AccessRequestRecommendationConfigDto
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationConfigDto', 'V2024AccessRequestRecommendationConfigDto']
slug: /tools/sdk/powershell/v2024/models/access-request-recommendation-config-dto
tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationConfigDto', 'V2024AccessRequestRecommendationConfigDto']
---
# AccessRequestRecommendationConfigDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ScoreThreshold** | **Double** | The value that internal calculations need to exceed for recommendations to be made. | [required]
**StartDateAttribute** | **String** | Use to map an attribute name for determining identities' start date. | [optional]
**RestrictionAttribute** | **String** | Use to only give recommendations based on this attribute. | [optional]
**MoverAttribute** | **String** | Use to map an attribute name for determining whether identities are movers. | [optional]
**JoinerAttribute** | **String** | Use to map an attribute name for determining whether identities are joiners. | [optional]
**UseRestrictionAttribute** | **Boolean** | Use only the attribute named in restrictionAttribute to make recommendations. | [optional] [default to $false]
## Examples
- Prepare the resource
```powershell
$AccessRequestRecommendationConfigDto = Initialize-PSSailpoint.V2024AccessRequestRecommendationConfigDto -ScoreThreshold 0.5 `
-StartDateAttribute startDate `
-RestrictionAttribute location `
-MoverAttribute isMover `
-JoinerAttribute isJoiner `
-UseRestrictionAttribute true
```
- Convert the resource to JSON
```powershell
$AccessRequestRecommendationConfigDto | ConvertTo-JSON
```
[[Back to top]](#)