Update PowerShell SDK docs: 16633294545

This commit is contained in:
developer-relations-sp
2025-07-30 20:42:10 +00:00
parent cdd71d1f37
commit 5d76be1d9d
35 changed files with 1335 additions and 495 deletions

View File

@@ -1790,6 +1790,35 @@
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ManualDiscoverApplicationsCsvTemplate"
Write-Host $_.ErrorDetails
}
- path: /generic-approvals/{id}/approve
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2025/methods/approvals#approve-approval
source: |
$Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | Approval ID that correlates to an existing approval request that a user wants to approve
$ApprovalApproveRequest = @"
{
"comment" : "comment",
"additionalAttributes" : {
"additionalProp1" : "string",
"additionalProp2" : "string",
"additionalProp3" : "string"
}
}
"@
# Post Approvals Approve
try {
Approve-V2025Approval -Id $Id
# Below is a request that includes all optional parameters
# Approve-V2025Approval -Id $Id -ApprovalApproveRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025Approval"
Write-Host $_.ErrorDetails
}
- path: /generic-approvals/{id}
method: GET
xCodeSample:
@@ -1816,22 +1845,138 @@
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2025/methods/approvals#get-approvals
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Mine = $true # Boolean | Returns the list of approvals for the current caller (optional)
$RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID (optional)
$Filters = "filters=status eq PENDING" # 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: **status**: *eq* **referenceType**: *eq* (optional)
$Mine = $true # Boolean | Returns the list of approvals for the current caller. (optional) (default to $false)
$RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID. Must match the calling user's identity ID unless they are an admin. (optional)
$RequesteeId = "27e6334g757e481569df76323169db9sc" # String | Returns the list of approvals for a given requesteeId ID. Must match the calling user's identity ID unless they are an admin. (optional)
$ApproverId = "37e6334g557e481569df7g2d3169db9sb" # String | Returns the list of approvals for a given approverId ID. Must match the calling user's identity ID unless they are an admin. (optional)
$Count = $true # Boolean | Adds X-Total-Count to the header to give the amount of total approvals returned from the query. (optional) (default to $false)
$CountOnly = $true # Boolean | Adds X-Total-Count to the header to give the amount of total approvals returned from the query. Only returns the count and no approval objects. (optional) (default to $false)
$IncludeComments = $true # Boolean | If set to true in the query, the approval requests returned will include comments. (optional) (default to $false)
$IncludeApprovers = $true # Boolean | If set to true in the query, the approval requests returned will include approvers. (optional) (default to $false)
$IncludeBatchInfo = $true # Boolean | If set to true in the query, the approval requests returned will include batch information. (optional) (default to $false)
$IncludeBatchInfo2 = $true # Boolean | If set to true in the query, the approval requests returned will include batch information. (optional) (default to $false)
$Filters = "filters=status eq PENDING" # 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: **status**: *eq* **referenceType**: *eq* **name**: *eq* **priority**: *eq* **type**: *eq* **medium**: *eq* **description**: *eq* **batchId**: *eq* **approvalId**: *eq* **tenantId**: *eq* **createdDate**: *eq* **dueDate**: *eq* **completedDate**: *eq* **search**: *eq* **referenceId**: *eq* **referenceName**: *eq* **requestedTargetType**: *eq* **requestedTargetRequestType**: *eq* **requestedTargetId**: *eq* **modifiedDate**: *eq* **requesterId**: *eq* **requesteeId**: *eq* **approverId**: *eq* (optional)
$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)
# Get approvals
try {
Get-V2025Approvals -XSailPointExperimental $XSailPointExperimental
Get-V2025Approvals
# Below is a request that includes all optional parameters
# Get-V2025Approvals -XSailPointExperimental $XSailPointExperimental -Mine $Mine -RequesterId $RequesterId -Filters $Filters
# Get-V2025Approvals -Mine $Mine -RequesterId $RequesterId -RequesteeId $RequesteeId -ApproverId $ApproverId -Count $Count -CountOnly $CountOnly -IncludeComments $IncludeComments -IncludeApprovers $IncludeApprovers -IncludeBatchInfo $IncludeBatchInfo -IncludeBatchInfo2 $IncludeBatchInfo2 -Filters $Filters -Limit $Limit -Offset $Offset
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Approvals"
Write-Host $_.ErrorDetails
}
- path: /generic-approvals/{id}/reject
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2025/methods/approvals#reject-approval
source: |
$Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | Approval ID that correlates to an existing approval request that a user wants to reject.
$ApprovalRejectRequest = @"
{
"comment" : "string"
}
"@
# Post Approvals Reject
try {
Deny-V2025Approval -Id $Id
# Below is a request that includes all optional parameters
# Deny-V2025Approval -Id $Id -ApprovalRejectRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2025Approval"
Write-Host $_.ErrorDetails
}
- path: /generic-approvals/{id}/attributes
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2025/methods/approvals#update-approvals-attributes
source: |
$Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | Approval ID that correlates to an existing approval request that a user wants to change the attributes of.
$ApprovalAttributesRequest = @"
{
"removeAttributeKeys" : [ "string" ],
"comment" : "comment",
"additionalAttributes" : {
"additionalProp1" : "string",
"additionalProp2" : "string",
"additionalProp3" : "string"
}
}
"@
# Post Approvals Attributes
try {
$Result = ConvertFrom-JsonToApprovalAttributesRequest -Json $ApprovalAttributesRequest
Update-V2025ApprovalsAttributes -Id $Id -ApprovalAttributesRequest $Result
# Below is a request that includes all optional parameters
# Update-V2025ApprovalsAttributes -Id $Id -ApprovalAttributesRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ApprovalsAttributes"
Write-Host $_.ErrorDetails
}
- path: /generic-approvals/{id}/comments
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2025/methods/approvals#update-approvals-comments
source: |
$Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | Approval ID that correlates to an existing approval request that a user wants to add a comment to.
$ApprovalCommentsRequest = @"
{
"comment" : "Approval comment."
}
"@
# Post Approvals Comments
try {
$Result = ConvertFrom-JsonToApprovalCommentsRequest -Json $ApprovalCommentsRequest
Update-V2025ApprovalsComments -Id $Id -ApprovalCommentsRequest $Result
# Below is a request that includes all optional parameters
# Update-V2025ApprovalsComments -Id $Id -ApprovalCommentsRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ApprovalsComments"
Write-Host $_.ErrorDetails
}
- path: /generic-approvals/{id}/reassign
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2025/methods/approvals#update-approvals-reassign
source: |
$Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | Approval ID that correlates to an existing approval request that a user wants to reassign.
$ApprovalReassignRequest = @"
{
"reassignTo" : "152354832eb6f8f539fd738592e19ec5",
"comment" : "comment",
"reassignFrom" : "384532516be25f8fdf935ce19e295837"
}
"@
# Post Approvals Reassign
try {
$Result = ConvertFrom-JsonToApprovalReassignRequest -Json $ApprovalReassignRequest
Update-V2025ApprovalsReassign -Id $Id -ApprovalReassignRequest $Result
# Below is a request that includes all optional parameters
# Update-V2025ApprovalsReassign -Id $Id -ApprovalReassignRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ApprovalsReassign"
Write-Host $_.ErrorDetails
}
- path: /source-apps
method: POST
xCodeSample: