functions/remote-password-changing/Remove-TssPasswordType.ps1
|
function Remove-TssPasswordType { <# .SYNOPSIS Delete a password type .DESCRIPTION Deletes password types. The server keeps the password type and marks it inactive (soft delete): Get-TssRpcPasswordType still returns it with Active False. The server does not block deleting built-in password types: they go inactive the same way. .PARAMETER TssSession TssSession object created by New-TssSession for authentication .PARAMETER Id ID of the password type to delete .EXAMPLE $session = New-TssSession -SecretServer https://alpha -Credential $ssCred Remove-TssPasswordType -TssSession $session -Id 79 Delete (deactivate) password type 79 .LINK https://thycotic-ps.github.io/thycotic.secretserver/commands/remote-password-changing/Remove-TssPasswordType .LINK https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/remote-password-changing/Remove-TssPasswordType.ps1 .NOTES Requires TssSession object returned by New-TssSession #> [CmdletBinding(SupportsShouldProcess)] [OutputType('Thycotic.PowerShell.Common.Delete')] param ( [Parameter(Mandatory, ValueFromPipeline, Position = 0)] [Thycotic.PowerShell.Authentication.Session] $TssSession, [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [Alias('PasswordTypeId')] [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 foreach ($currentId in $Id) { $restResponse = $null $uri = $TssSession.ApiUrl, 'remote-password-changing', 'password-types', $currentId -join '/' $invokeParams.Uri = $uri $invokeParams.Method = 'DELETE' if ($PSCmdlet.ShouldProcess("Password type: $currentId", "$($invokeParams.Method) $uri")) { Write-Verbose "Performing the operation $($invokeParams.Method) $uri" try { $apiResponse = Invoke-TssApi @invokeParams $restResponse = . $ProcessResponse $apiResponse } catch { Write-Warning 'Issue with Remove-TssPasswordType request' $err = $_ . $ErrorHandling $err } if ($restResponse) { [Thycotic.PowerShell.Common.Delete](. $FilterTssResponse $restResponse ([Thycotic.PowerShell.Common.Delete])) } } } } else { Write-Warning 'No valid session found' } } } |