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

Update to powershell SDK docs: 13547766863

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-26 15:43:50 +00:00
parent b9a7c90269
commit 2cdc76c52f
3 changed files with 46 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestIdentityMetricsApi.md
View File

@@ -25,9 +25,6 @@ Method | HTTP request | Description
## get-access-request-identity-metrics ## get-access-request-identity-metrics
:::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.
:::
Use this API to return information access metrics. Use this API to return information access metrics.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-identity-metrics) [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-identity-metrics)
@@ -38,7 +35,6 @@ Param Type | Name | Data Type | Required | Description
Path | IdentityId | **String** | True | Manager's identity ID. Path | IdentityId | **String** | True | Manager's identity ID.
Path | RequestedObjectId | **String** | True | Requested access item's ID. Path | RequestedObjectId | **String** | True | Requested access item's ID.
Path | Type | **String** | True | Requested access item's type. Path | Type | **String** | True | Requested access item's type.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type ### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) [**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
@@ -62,15 +58,14 @@ Code | Description | Data Type
$IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID. $IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID.
$RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID. $RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID.
$Type = "ENTITLEMENT" # String | Requested access item's type. $Type = "ENTITLEMENT" # String | Requested access item's type.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Return access request identity metrics # Return access request identity metrics
try { try {
Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type -XSailPointExperimental $XSailPointExperimental Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type -XSailPointExperimental $XSailPointExperimental # Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestIdentityMetrics" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestIdentityMetrics"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

76
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SuggestedEntitlementDescriptionApi.md
View File

@@ -30,9 +30,6 @@ Method | HTTP request | Description
## get-sed-batch-stats ## 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. 'Submit Sed Batch Stats Request.
Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats
@@ -45,7 +42,6 @@ This API is currently in an experimental state. The API is subject to change bas
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | BatchId | **String** | True | Batch Id Path | BatchId | **String** | True | Batch Id
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type ### Return type
[**SedBatchStats**](../models/sed-batch-stats) [**SedBatchStats**](../models/sed-batch-stats)
@@ -68,15 +64,14 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id $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 # Submit Sed Batch Stats Request
try { try {
Get-V2024SedBatchStats -BatchId $BatchId -XSailPointExperimental $XSailPointExperimental Get-V2024SedBatchStats -BatchId $BatchId
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024SedBatchStats -BatchId $BatchId -XSailPointExperimental $XSailPointExperimental # Get-V2024SedBatchStats -BatchId $BatchId
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatchStats" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatchStats"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -85,9 +80,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## get-sed-batches ## 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. List Sed Batches.
API responses with Sed Batch Status API responses with Sed Batch Status
@@ -96,7 +88,6 @@ API responses with Sed Batch Status
### Parameters ### Parameters
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type ### Return type
[**SedBatchStatus**](../models/sed-batch-status) [**SedBatchStatus**](../models/sed-batch-status)
@@ -118,15 +109,14 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# List Sed Batch Request # List Sed Batch Request
try { try {
Get-V2024SedBatches -XSailPointExperimental $XSailPointExperimental Get-V2024SedBatches
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024SedBatches -XSailPointExperimental $XSailPointExperimental # Get-V2024SedBatches
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatches" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatches"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -135,9 +125,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## list-seds ## 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) List of Suggested Entitlement Descriptions (SED)
SED field descriptions: SED field descriptions:
@@ -159,14 +146,14 @@ SED field descriptions:
### Parameters ### Parameters
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. 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 | 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 | 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.
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 | 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 | 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 | 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) (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 | 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) (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 | 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) (default to $false) | Will limit records to items that are in ""suggested"" or ""approved"" status
Query | ShowPendingStatusOnly | **Boolean** | (optional) | Will limit records to items that are in ""suggested"" or ""approved"" status
### Return type ### Return type
[**Sed[]**](../models/sed) [**Sed[]**](../models/sed)
@@ -188,22 +175,22 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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)
$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) $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)
$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) $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) $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)
$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 count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false)
$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) (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) $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) (default to $false)
$ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional)
# List Suggested Entitlement Descriptions # List Suggested Entitlement Descriptions
try { try {
Get-V2024Seds -XSailPointExperimental $XSailPointExperimental Get-V2024Seds
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024Seds -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Sorters $Sorters -Count $Count -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly # Get-V2024Seds -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Seds" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Seds"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -271,9 +258,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## submit-sed-approval ## 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. Submit Bulk Approval Request for SED.
Request body takes list of SED Ids. API responses with list of SED Approval Status Request body takes list of SED Ids. API responses with list of SED Approval Status
@@ -282,7 +266,6 @@ Request body takes list of SED Ids. API responses with list of SED Approval Stat
### Parameters ### Parameters
Param Type | Name | Data Type | Required | Description 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 Body | SedApproval | [**[]SedApproval**](../models/sed-approval) | True | Sed Approval
### Return type ### Return type
@@ -305,7 +288,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$SedApproval = @"{ $SedApproval = @"{
"items" : "016629d1-1d25-463f-97f3-c6686846650" "items" : "016629d1-1d25-463f-97f3-c6686846650"
}"@ # SedApproval[] | Sed Approval }"@ # SedApproval[] | Sed Approval
@@ -315,10 +297,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try { try {
$Result = ConvertFrom-JsonToSedApproval -Json $SedApproval $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval
Submit-V2024SedApproval -XSailPointExperimental $XSailPointExperimental -V2024SedApproval $Result Submit-V2024SedApproval -V2024SedApproval $Result
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Submit-V2024SedApproval -XSailPointExperimental $XSailPointExperimental -V2024SedApproval $Result # Submit-V2024SedApproval -V2024SedApproval $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedApproval" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedApproval"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -327,9 +309,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## submit-sed-assignment ## 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. 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 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
@@ -338,7 +317,6 @@ Request body has an assignee, and list of SED Ids that are assigned to that assi
### Parameters ### Parameters
Param Type | Name | Data Type | Required | Description 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 Body | SedAssignment | [**SedAssignment**](../models/sed-assignment) | True | Sed Assignment Request
### Return type ### Return type
@@ -361,7 +339,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$SedAssignment = @"{ $SedAssignment = @"{
"assignee" : { "assignee" : {
"type" : "SOURCE_OWNER", "type" : "SOURCE_OWNER",
@@ -374,10 +351,10 @@ $SedAssignment = @"{
try { try {
$Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment
Submit-V2024SedAssignment -XSailPointExperimental $XSailPointExperimental -V2024SedAssignment $Result Submit-V2024SedAssignment -V2024SedAssignment $Result
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Submit-V2024SedAssignment -XSailPointExperimental $XSailPointExperimental -V2024SedAssignment $Result # Submit-V2024SedAssignment -V2024SedAssignment $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedAssignment" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedAssignment"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -386,9 +363,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## submit-sed-batch-request ## 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. 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 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
@@ -397,7 +371,6 @@ Request body has one of the following: - a list of entitlement Ids - a list of S
### Parameters ### Parameters
Param Type | Name | Data Type | Required | Description 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 Body | SedBatchRequest | [**SedBatchRequest**](../models/sed-batch-request) | (optional) | Sed Batch Request
### Return type ### Return type
@@ -420,7 +393,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$SedBatchRequest = @"{ $SedBatchRequest = @"{
"entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ],
"seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ]
@@ -429,10 +401,10 @@ $SedBatchRequest = @"{
# Submit Sed Batch Request # Submit Sed Batch Request
try { try {
Submit-V2024SedBatchRequest -XSailPointExperimental $XSailPointExperimental Submit-V2024SedBatchRequest
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Submit-V2024SedBatchRequest -XSailPointExperimental $XSailPointExperimental -V2024SedBatchRequest $Result # Submit-V2024SedBatchRequest -V2024SedBatchRequest $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedBatchRequest" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedBatchRequest"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

46
static/code-examples/v2024/code_examples_overlay.yaml
View File

@@ -532,15 +532,14 @@
$IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID. $IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID.
$RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID. $RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID.
$Type = "ENTITLEMENT" # String | Requested access item's type. $Type = "ENTITLEMENT" # String | Requested access item's type.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Return access request identity metrics # Return access request identity metrics
try { try {
Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type -XSailPointExperimental $XSailPointExperimental Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type -XSailPointExperimental $XSailPointExperimental # Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestIdentityMetrics" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestIdentityMetrics"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -15357,15 +15356,14 @@
label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#get-sed-batch-stats label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#get-sed-batch-stats
source: | source: |
$BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id $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 # Submit Sed Batch Stats Request
try { try {
Get-V2024SedBatchStats -BatchId $BatchId -XSailPointExperimental $XSailPointExperimental Get-V2024SedBatchStats -BatchId $BatchId
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024SedBatchStats -BatchId $BatchId -XSailPointExperimental $XSailPointExperimental # Get-V2024SedBatchStats -BatchId $BatchId
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatchStats" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatchStats"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -15376,15 +15374,14 @@
- lang: PowerShell - lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#get-sed-batches label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#get-sed-batches
source: | source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# List Sed Batch Request # List Sed Batch Request
try { try {
Get-V2024SedBatches -XSailPointExperimental $XSailPointExperimental Get-V2024SedBatches
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024SedBatches -XSailPointExperimental $XSailPointExperimental # Get-V2024SedBatches
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatches" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatches"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -15395,22 +15392,22 @@
- lang: PowerShell - lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#list-seds label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#list-seds
source: | source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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)
$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) $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)
$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) $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) $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)
$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 count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false)
$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) (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) $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) (default to $false)
$ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional)
# List Suggested Entitlement Descriptions # List Suggested Entitlement Descriptions
try { try {
Get-V2024Seds -XSailPointExperimental $XSailPointExperimental Get-V2024Seds
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024Seds -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Sorters $Sorters -Count $Count -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly # Get-V2024Seds -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Seds" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Seds"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -15448,7 +15445,6 @@
- lang: PowerShell - lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-approval label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-approval
source: | source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$SedApproval = @"{ $SedApproval = @"{
"items" : "016629d1-1d25-463f-97f3-c6686846650" "items" : "016629d1-1d25-463f-97f3-c6686846650"
}"@ }"@
@@ -15458,10 +15454,10 @@
try { try {
$Result = ConvertFrom-JsonToSedApproval -Json $SedApproval $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval
Submit-V2024SedApproval -XSailPointExperimental $XSailPointExperimental -V2024SedApproval $Result Submit-V2024SedApproval -V2024SedApproval $Result
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Submit-V2024SedApproval -XSailPointExperimental $XSailPointExperimental -V2024SedApproval $Result # Submit-V2024SedApproval -V2024SedApproval $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedApproval" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedApproval"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -15472,7 +15468,6 @@
- lang: PowerShell - lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-assignment label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-assignment
source: | source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$SedAssignment = @" $SedAssignment = @"
{ {
"assignee" : { "assignee" : {
@@ -15487,10 +15482,10 @@
try { try {
$Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment
Submit-V2024SedAssignment -XSailPointExperimental $XSailPointExperimental -V2024SedAssignment $Result Submit-V2024SedAssignment -V2024SedAssignment $Result
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Submit-V2024SedAssignment -XSailPointExperimental $XSailPointExperimental -V2024SedAssignment $Result # Submit-V2024SedAssignment -V2024SedAssignment $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedAssignment" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedAssignment"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -15501,7 +15496,6 @@
- lang: PowerShell - lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-batch-request label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-batch-request
source: | source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$SedBatchRequest = @" $SedBatchRequest = @"
{ {
"entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ],
@@ -15512,10 +15506,10 @@
# Submit Sed Batch Request # Submit Sed Batch Request
try { try {
Submit-V2024SedBatchRequest -XSailPointExperimental $XSailPointExperimental Submit-V2024SedBatchRequest
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Submit-V2024SedBatchRequest -XSailPointExperimental $XSailPointExperimental -V2024SedBatchRequest $Result # Submit-V2024SedBatchRequest -V2024SedBatchRequest $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedBatchRequest" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedBatchRequest"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails