mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 04:19:42 +00:00
Update to powershell SDK docs: 13662864366
This commit is contained in:
developer-relations-sp
@@ -30,6 +30,9 @@ Method | HTTP request | Description
|
||||
|
||||
|
||||
## get-sed-batch-stats
|
||||
:::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.
|
||||
:::
|
||||
'Submit Sed Batch Stats Request.
|
||||
|
||||
Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats
|
||||
@@ -42,6 +45,7 @@ Method | HTTP request | Description
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | BatchId | **String** | True | Batch Id
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**SedBatchStats**](../models/sed-batch-stats)
|
||||
@@ -64,14 +68,15 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# Submit Sed Batch Stats Request
|
||||
|
||||
try {
|
||||
Get-V2024SedBatchStats -BatchId $BatchId
|
||||
Get-V2024SedBatchStats -BatchId $BatchId -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024SedBatchStats -BatchId $BatchId
|
||||
# Get-V2024SedBatchStats -BatchId $BatchId -XSailPointExperimental $XSailPointExperimental
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatchStats"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -80,6 +85,9 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-sed-batches
|
||||
:::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.
|
||||
:::
|
||||
List Sed Batches.
|
||||
API responses with Sed Batch Status
|
||||
|
||||
@@ -88,6 +96,7 @@ API responses with Sed Batch Status
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**SedBatchStatus**](../models/sed-batch-status)
|
||||
@@ -109,14 +118,15 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# List Sed Batch Request
|
||||
|
||||
try {
|
||||
Get-V2024SedBatches
|
||||
Get-V2024SedBatches -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024SedBatches
|
||||
# Get-V2024SedBatches -XSailPointExperimental $XSailPointExperimental
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatches"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -125,6 +135,9 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-seds
|
||||
:::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.
|
||||
:::
|
||||
List of Suggested Entitlement Descriptions (SED)
|
||||
|
||||
SED field descriptions:
|
||||
@@ -146,14 +159,14 @@ SED field descriptions:
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Query | Limit | **Int64** | (optional) | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used.
|
||||
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co*
|
||||
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status**
|
||||
Query | CountOnly | **Boolean** | (optional) (default to $false) | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array.
|
||||
Query | RequestedByAnyone | **Boolean** | (optional) (default to $false) | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested
|
||||
Query | ShowPendingStatusOnly | **Boolean** | (optional) (default to $false) | Will limit records to items that are in ""suggested"" or ""approved"" status
|
||||
Query | Count | **Boolean** | (optional) | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used.
|
||||
Query | CountOnly | **Boolean** | (optional) | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array.
|
||||
Query | RequestedByAnyone | **Boolean** | (optional) | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested
|
||||
Query | ShowPendingStatusOnly | **Boolean** | (optional) | Will limit records to items that are in ""suggested"" or ""approved"" status
|
||||
|
||||
### Return type
|
||||
[**Sed[]**](../models/sed)
|
||||
@@ -175,22 +188,22 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
||||
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
||||
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$Limit = limit=25 # Int64 | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional)
|
||||
$Filters = 'displayName co "Read and Write"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional)
|
||||
$Sorters = "sorters=displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional)
|
||||
$CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false)
|
||||
$RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to $false)
|
||||
$ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) (default to $false)
|
||||
$Count = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional)
|
||||
$CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. (optional)
|
||||
$RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional)
|
||||
$ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional)
|
||||
|
||||
# List Suggested Entitlement Descriptions
|
||||
|
||||
try {
|
||||
Get-V2024Seds
|
||||
Get-V2024Seds -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024Seds -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly
|
||||
# Get-V2024Seds -XSailPointExperimental $XSailPointExperimental -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-V2024Seds"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -199,6 +212,9 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## patch-sed
|
||||
:::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.
|
||||
:::
|
||||
Patch Suggested Entitlement Description
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-sed)
|
||||
@@ -207,6 +223,7 @@ Patch Suggested Entitlement Description
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | id is sed id
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Body | SedPatch | [**[]SedPatch**](../models/sed-patch) | True | Sed Patch Request
|
||||
|
||||
### Return type
|
||||
@@ -230,6 +247,7 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$SedPatch = @"{
|
||||
"op" : "replace",
|
||||
"path" : "status",
|
||||
@@ -241,10 +259,10 @@ $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToSedPatch -Json $SedPatch
|
||||
Update-V2024Sed -Id $Id -SedPatch $Result
|
||||
Update-V2024Sed -Id $Id -XSailPointExperimental $XSailPointExperimental -SedPatch $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Update-V2024Sed -Id $Id -SedPatch $Result
|
||||
# Update-V2024Sed -Id $Id -XSailPointExperimental $XSailPointExperimental -SedPatch $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Sed"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -253,6 +271,9 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## submit-sed-approval
|
||||
:::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.
|
||||
:::
|
||||
Submit Bulk Approval Request for SED.
|
||||
Request body takes list of SED Ids. API responses with list of SED Approval Status
|
||||
|
||||
@@ -261,6 +282,7 @@ Request body takes list of SED Ids. API responses with list of SED Approval Stat
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Body | SedApproval | [**[]SedApproval**](../models/sed-approval) | True | Sed Approval
|
||||
|
||||
### Return type
|
||||
@@ -283,6 +305,7 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$SedApproval = @"{
|
||||
"items" : "016629d1-1d25-463f-97f3-c6686846650"
|
||||
}"@ # SedApproval[] | Sed Approval
|
||||
@@ -292,10 +315,10 @@ Code | Description | Data Type
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToSedApproval -Json $SedApproval
|
||||
Submit-V2024SedApproval -SedApproval $Result
|
||||
Submit-V2024SedApproval -XSailPointExperimental $XSailPointExperimental -SedApproval $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Submit-V2024SedApproval -SedApproval $Result
|
||||
# Submit-V2024SedApproval -XSailPointExperimental $XSailPointExperimental -SedApproval $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedApproval"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -304,6 +327,9 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## submit-sed-assignment
|
||||
:::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.
|
||||
:::
|
||||
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
|
||||
|
||||
@@ -312,6 +338,7 @@ Request body has an assignee, and list of SED Ids that are assigned to that assi
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Body | SedAssignment | [**SedAssignment**](../models/sed-assignment) | True | Sed Assignment Request
|
||||
|
||||
### Return type
|
||||
@@ -334,6 +361,7 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$SedAssignment = @"{
|
||||
"assignee" : {
|
||||
"type" : "SOURCE_OWNER",
|
||||
@@ -346,10 +374,10 @@ $SedAssignment = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment
|
||||
Submit-V2024SedAssignment -SedAssignment $Result
|
||||
Submit-V2024SedAssignment -XSailPointExperimental $XSailPointExperimental -SedAssignment $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Submit-V2024SedAssignment -SedAssignment $Result
|
||||
# Submit-V2024SedAssignment -XSailPointExperimental $XSailPointExperimental -SedAssignment $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedAssignment"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -358,6 +386,9 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## submit-sed-batch-request
|
||||
:::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.
|
||||
:::
|
||||
Submit Sed Batch Request.
|
||||
Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together
|
||||
|
||||
@@ -366,6 +397,7 @@ Request body has one of the following: - a list of entitlement Ids - a list of S
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Body | SedBatchRequest | [**SedBatchRequest**](../models/sed-batch-request) | (optional) | Sed Batch Request
|
||||
|
||||
### Return type
|
||||
@@ -388,6 +420,7 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$SedBatchRequest = @"{
|
||||
"entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ],
|
||||
"seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ]
|
||||
@@ -396,10 +429,10 @@ $SedBatchRequest = @"{
|
||||
# Submit Sed Batch Request
|
||||
|
||||
try {
|
||||
Submit-V2024SedBatchRequest
|
||||
Submit-V2024SedBatchRequest -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Submit-V2024SedBatchRequest -SedBatchRequest $Result
|
||||
# Submit-V2024SedBatchRequest -XSailPointExperimental $XSailPointExperimental -SedBatchRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedBatchRequest"
|
||||
Write-Host $_.ErrorDetails
|
||||
|
||||
Reference in New Issue
Block a user