functions/workflow-templates/Stop-TssWorkflowRequest.ps1
|
function Stop-TssWorkflowRequest { <# .SYNOPSIS Cancel the active requests of a workflow template .DESCRIPTION Workflow templates define the approval steps of secret access requests and secret erase requests. Managing them requires the Administer Workflows permission and a Secret Workflow license. Cancels every active request that runs through the workflow template and returns the server confirmation message. A template without active requests succeeds without changes. .PARAMETER TssSession TssSession object created by New-TssSession for authentication .PARAMETER Id Workflow template ID .EXAMPLE $session = New-TssSession -SecretServer https://alpha -Credential $ssCred Stop-TssWorkflowRequest -TssSession $session -Id 4 Cancel every active request of workflow template 4 .LINK https://thycotic-ps.github.io/thycotic.secretserver/commands/workflow-templates/Stop-TssWorkflowRequest .LINK https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/workflow-templates/Stop-TssWorkflowRequest.ps1 .NOTES Requires TssSession object returned by New-TssSession #> [CmdletBinding(SupportsShouldProcess)] [OutputType('System.String')] param ( [Parameter(Mandatory, ValueFromPipeline, Position = 0)] [Thycotic.PowerShell.Authentication.Session] $TssSession, [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [Alias('WorkflowTemplateId')] [int] $Id ) begin { $tssParams = $PSBoundParameters $invokeParams = . $GetInvokeApiParams $TssSession } process { Get-TssInvocation $PSCmdlet.MyInvocation if ($tssParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) { Compare-TssVersion $TssSession '10.9.000000' $PSCmdlet.MyInvocation $uri = $TssSession.ApiUrl, 'workflows', 'templates', $Id, 'cancel-requests' -join '/' $invokeParams.Uri = $uri $invokeParams.Method = 'POST' if ($PSCmdlet.ShouldProcess("Workflow template: $Id", "$($invokeParams.Method) $uri")) { Write-Verbose "Performing the operation $($invokeParams.Method) $uri" try { $apiResponse = Invoke-TssApi @invokeParams $restResponse = . $ProcessResponse $apiResponse } catch { Write-Warning 'Issue with Stop-TssWorkflowRequest request' $err = $_ . $ErrorHandling $err } if ($null -ne $restResponse) { [string]($restResponse | ConvertFrom-Json) } } } else { Write-Warning 'No valid session found' } } } |