Skip to content

Commit 0dbc484

Browse files
developer-relations-spdeveloper-relations-sp
committed
Update to powershell SDK docs: 13525029562
1 parent 1d5ca26 commit 0dbc484

File tree

3 files changed

+202
-0
lines changed

3 files changed

+202
-0
lines changed

‎docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIAccessRequestRecommendationsApi.md

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,11 @@ Method | HTTP request | Description
2222
[**Add-V2024AccessRequestRecommendationsViewedItem**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Notification of Viewed Access Request Recommendations
2323
[**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
2424
[**Get-V2024AccessRequestRecommendations**](#get-access-request-recommendations) | **GET** `/ai-access-request-recommendations` | Identity Access Request Recommendations
25+
[**Get-V2024AccessRequestRecommendationsConfig**](#get-access-request-recommendations-config) | **GET** `/ai-access-request-recommendations/config` | Get Access Request Recommendations config
2526
[**Get-V2024AccessRequestRecommendationsIgnoredItems**](#get-access-request-recommendations-ignored-items) | **GET** `/ai-access-request-recommendations/ignored-items` | List of Ignored Access Request Recommendations
2627
[**Get-V2024AccessRequestRecommendationsRequestedItems**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List of Requested Access Request Recommendations
2728
[**Get-V2024AccessRequestRecommendationsViewedItems**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List of Viewed Access Request Recommendations
29+
[**Set-V2024AccessRequestRecommendationsConfig**](#set-access-request-recommendations-config) | **PUT** `/ai-access-request-recommendations/config` | Update Access Request Recommendations config
2830

2931

3032
## add-access-request-recommendations-ignored-item
@@ -318,6 +320,54 @@ try {
318320
```
319321
[[Back to top]](#)
320322

323+
## get-access-request-recommendations-config
324+
:::warning experimental
325+
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.
326+
:::
327+
This API returns the configurations for Access Request Recommender for the tenant.
328+
329+
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-config)
330+
331+
### Parameters
332+
Param Type | Name | Data Type | Required | Description
333+
------------- | ------------- | ------------- | ------------- | -------------
334+
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
335+
336+
### Return type
337+
[**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto)
338+
339+
### Responses
340+
Code | Description | Data Type
341+
------------- | ------------- | -------------
342+
200 | Configurations for Access Request Recommender for the tenant. | AccessRequestRecommendationConfigDto
343+
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
344+
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
345+
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
346+
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
347+
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
348+
349+
### HTTP request headers
350+
- **Content-Type**: Not defined
351+
- **Accept**: application/json
352+
353+
### Example
354+
```powershell
355+
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
356+
357+
# Get Access Request Recommendations config
358+
359+
try {
360+
Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental
361+
362+
# Below is a request that includes all optional parameters
363+
# Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental
364+
} catch {
365+
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsConfig"
366+
Write-Host $_.ErrorDetails
367+
}
368+
```
369+
[[Back to top]](#)
370+
321371
## get-access-request-recommendations-ignored-items
322372
:::warning experimental
323373
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 {
491541
}
492542
```
493543
[[Back to top]](#)
544+
545+
## set-access-request-recommendations-config
546+
:::warning experimental
547+
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.
548+
:::
549+
This API updates the configurations for Access Request Recommender for the tenant.
550+
551+
[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-access-request-recommendations-config)
552+
553+
### Parameters
554+
Param Type | Name | Data Type | Required | Description
555+
------------- | ------------- | ------------- | ------------- | -------------
556+
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
557+
Body | AccessRequestRecommendationConfigDto | [**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto) | True | The desired configurations for Access Request Recommender for the tenant.
558+
559+
### Return type
560+
[**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto)
561+
562+
### Responses
563+
Code | Description | Data Type
564+
------------- | ------------- | -------------
565+
200 | Successfully updated configurations for Access Request Recommender for the tenant. | AccessRequestRecommendationConfigDto
566+
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
567+
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
568+
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
569+
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
570+
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
571+
572+
### HTTP request headers
573+
- **Content-Type**: application/json
574+
- **Accept**: application/json
575+
576+
### Example
577+
```powershell
578+
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
579+
$AccessRequestRecommendationConfigDto = @"{
580+
"scoreThreshold" : 0.5,
581+
"startDateAttribute" : "startDate",
582+
"restrictionAttribute" : "location",
583+
"moverAttribute" : "isMover",
584+
"joinerAttribute" : "isJoiner",
585+
"useRestrictionAttribute" : true
586+
}"@
587+
588+
# Update Access Request Recommendations config
589+
590+
try {
591+
$Result = ConvertFrom-JsonToAccessRequestRecommendationConfigDto -Json $AccessRequestRecommendationConfigDto
592+
Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationConfigDto $Result
593+
594+
# Below is a request that includes all optional parameters
595+
# Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationConfigDto $Result
596+
} catch {
597+
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestRecommendationsConfig"
598+
Write-Host $_.ErrorDetails
599+
}
600+
```
601+
[[Back to top]](#)

‎docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestRecommendationConfigDto.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
id: v2024-access-request-recommendation-config-dto
3+
title: AccessRequestRecommendationConfigDto
4+
pagination_label: AccessRequestRecommendationConfigDto
5+
sidebar_label: AccessRequestRecommendationConfigDto
6+
sidebar_class_name: powershellsdk
7+
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationConfigDto', 'V2024AccessRequestRecommendationConfigDto']
8+
slug: /tools/sdk/powershell/v2024/models/access-request-recommendation-config-dto
9+
tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationConfigDto', 'V2024AccessRequestRecommendationConfigDto']
10+
---
11+
12+
13+
# AccessRequestRecommendationConfigDto
14+
15+
## Properties
16+
17+
Name | Type | Description | Notes
18+
------------ | ------------- | ------------- | -------------
19+
**ScoreThreshold** | **Double** | The value that internal calculations need to exceed for recommendations to be made. | [required]
20+
**StartDateAttribute** | **String** | Use to map an attribute name for determining identities' start date. | [optional]
21+
**RestrictionAttribute** | **String** | Use to only give recommendations based on this attribute. | [optional]
22+
**MoverAttribute** | **String** | Use to map an attribute name for determining whether identities are movers. | [optional]
23+
**JoinerAttribute** | **String** | Use to map an attribute name for determining whether identities are joiners. | [optional]
24+
**UseRestrictionAttribute** | **Boolean** | Use only the attribute named in restrictionAttribute to make recommendations. | [optional] [default to $false]
25+
26+
## Examples
27+
28+
- Prepare the resource
29+
```powershell
30+
$AccessRequestRecommendationConfigDto = Initialize-PSSailpoint.V2024AccessRequestRecommendationConfigDto -ScoreThreshold 0.5 `
31+
-StartDateAttribute startDate `
32+
-RestrictionAttribute location `
33+
-MoverAttribute isMover `
34+
-JoinerAttribute isJoiner `
35+
-UseRestrictionAttribute true
36+
```
37+
38+
- Convert the resource to JSON
39+
```powershell
40+
$AccessRequestRecommendationConfigDto | ConvertTo-JSON
41+
```
42+
43+
44+
[[Back to top]](#)
45+

‎static/code-examples/v2024/code_examples_overlay.yaml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5851,6 +5851,25 @@
58515851
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendations"
58525852
Write-Host $_.ErrorDetails
58535853
}
5854+
- path: /ai-access-request-recommendations/config
5855+
method: GET
5856+
xCodeSample:
5857+
- lang: PowerShell
5858+
label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-config
5859+
source: |
5860+
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
5861+
5862+
# Get Access Request Recommendations config
5863+
5864+
try {
5865+
Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental
5866+
5867+
# Below is a request that includes all optional parameters
5868+
# Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental
5869+
} catch {
5870+
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsConfig"
5871+
Write-Host $_.ErrorDetails
5872+
}
58545873
- path: /ai-access-request-recommendations/ignored-items
58555874
method: GET
58565875
xCodeSample:
@@ -5923,6 +5942,36 @@
59235942
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsViewedItems"
59245943
Write-Host $_.ErrorDetails
59255944
}
5945+
- path: /ai-access-request-recommendations/config
5946+
method: PUT
5947+
xCodeSample:
5948+
- lang: PowerShell
5949+
label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#set-access-request-recommendations-config
5950+
source: |
5951+
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
5952+
$AccessRequestRecommendationConfigDto = @"
5953+
{
5954+
"scoreThreshold" : 0.5,
5955+
"startDateAttribute" : "startDate",
5956+
"restrictionAttribute" : "location",
5957+
"moverAttribute" : "isMover",
5958+
"joinerAttribute" : "isJoiner",
5959+
"useRestrictionAttribute" : true
5960+
}
5961+
"@
5962+
5963+
# Update Access Request Recommendations config
5964+
5965+
try {
5966+
$Result = ConvertFrom-JsonToAccessRequestRecommendationConfigDto -Json $AccessRequestRecommendationConfigDto
5967+
Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationConfigDto $Result
5968+
5969+
# Below is a request that includes all optional parameters
5970+
# Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationConfigDto $Result
5971+
} catch {
5972+
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestRecommendationsConfig"
5973+
Write-Host $_.ErrorDetails
5974+
}
59265975
- path: /common-access
59275976
method: POST
59285977
xCodeSample:

0 commit comments

Comments
 (0)