LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 04:19:37 +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

47
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSuggestedEntitlementDescriptionApi.md
View File

@@ -28,6 +28,7 @@ Method | HTTP request | Description
[**Submit-BetaSedAssignment**](#submit-sed-assignment) | **POST** `/suggested-entitlement-description-assignments` | Submit Sed Assignment Request
[**Submit-BetaSedBatchRequest**](#submit-sed-batch-request) | **POST** `/suggested-entitlement-description-batches` | Submit Sed Batch Request
## get-sed-batch-stats
Submit Sed Batch Stats Request.
@@ -35,6 +36,8 @@ Submits batchId in the path param `(e.g. {batchId}/stats)`.
API responses with stats of the batchId.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sed-batch-stats)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -65,20 +68,23 @@ $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id
# Submit Sed Batch Stats Request
try {
Get-BetaSedBatchStats -BetaBatchId $BatchId
Get-BetaSedBatchStats -BatchId $BatchId
# Below is a request that includes all optional parameters
# Get-BetaSedBatchStats -BetaBatchId $BatchId
# Get-BetaSedBatchStats -BatchId $BatchId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatchStats"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-sed-batches
List Sed Batches.
API responses with Sed Batch Status
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sed-batches)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -107,7 +113,7 @@ Code | Description | Data Type
# List Sed Batch Request
try {
Get-BetaSedBatches
Get-BetaSedBatches
# Below is a request that includes all optional parameters
# Get-BetaSedBatches
@@ -117,6 +123,7 @@ try {
}
```
[[Back to top]](#)
## list-seds
List of Suggested Entitlement Descriptions (SED)
@@ -134,6 +141,8 @@ SED field descriptions:
**fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-seds)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -176,19 +185,22 @@ $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are
# List Suggested Entitlement Descriptions
try {
Get-BetaSeds
Get-BetaSeds
# Below is a request that includes all optional parameters
# Get-BetaSeds -BetaLimit $Limit -BetaFilters $Filters -BetaSorters $Sorters -BetaCount $Count -BetaCountOnly $CountOnly -BetaRequestedByAnyone $RequestedByAnyone -BetaShowPendingStatusOnly $ShowPendingStatusOnly
# Get-BetaSeds -Limit $Limit -Filters $Filters -Sorters $Sorters -Count $Count -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSeds"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-sed
Patch Suggested Entitlement Description
[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-sed)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -227,20 +239,23 @@ $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id
try {
$Result = ConvertFrom-JsonToSedPatch -Json $SedPatch
Update-BetaSed -BetaId $Id -BetaSedPatch $Result
Update-BetaSed -Id $Id -BetaSedPatch $Result
# Below is a request that includes all optional parameters
# Update-BetaSed -BetaId $Id -BetaSedPatch $SedPatch
# Update-BetaSed -Id $Id -BetaSedPatch $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSed"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## submit-sed-approval
Submit Bulk Approval Request for SED.
Request body takes list of SED Ids. API responses with list of SED Approval Status
[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-sed-approval)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -275,20 +290,23 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToSedApproval -Json $SedApproval
Submit-BetaSedApproval -BetaSedApproval $Result
Submit-BetaSedApproval -BetaSedApproval $Result
# Below is a request that includes all optional parameters
# Submit-BetaSedApproval -BetaSedApproval $SedApproval
# Submit-BetaSedApproval -BetaSedApproval $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedApproval"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## submit-sed-assignment
Submit Assignment Request.
Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together
[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-sed-assignment)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -326,16 +344,17 @@ $SedAssignment = @"{
try {
$Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment
Submit-BetaSedAssignment -BetaSedAssignment $Result
Submit-BetaSedAssignment -BetaSedAssignment $Result
# Below is a request that includes all optional parameters
# Submit-BetaSedAssignment -BetaSedAssignment $SedAssignment
# Submit-BetaSedAssignment -BetaSedAssignment $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedAssignment"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## submit-sed-batch-request
Submit Sed Batch Request.
Request body has one of the following:
@@ -343,6 +362,8 @@ Request body has one of the following:
- a list of SED Ids
that user wants to have description generated by LLM. API responses with batchId that groups Ids together
[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-sed-batch-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -376,10 +397,10 @@ $SedBatchRequest = @"{
# Submit Sed Batch Request
try {
Submit-BetaSedBatchRequest
Submit-BetaSedBatchRequest
# Below is a request that includes all optional parameters
# Submit-BetaSedBatchRequest -BetaSedBatchRequest $SedBatchRequest
# Submit-BetaSedBatchRequest -BetaSedBatchRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedBatchRequest"
Write-Host $_.ErrorDetails