functions/secrets/Get-TssSecretPasswordStatus.ps1
|
function Get-TssSecretPasswordStatus { <# .SYNOPSIS Get status of password change .DESCRIPTION Get status of password change .EXAMPLE $session = New-TssSession -SecretServer https://alpha -Credential $ssCred Get-TssSecretPasswordStatus -TssSession $session -Id 26 Get password change status of Secret ID 26 .LINK https://thycotic-ps.github.io/thycotic.secretserver/commands/secrets/Get-TssSecretPasswordStatus .LINK https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/secrets/Get-TssSecretPasswordStatus.ps1 .NOTES Requires TssSession object returned by New-TssSession #> [CmdletBinding()] [OutputType('Thycotic.PowerShell.Secrets.PasswordStatus')] param ( # TssSession object created by New-TssSession for authentication [Parameter(Mandatory, ValueFromPipeline, Position = 0)] [Thycotic.PowerShell.Authentication.Session] $TssSession, # Secret ID [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [Alias('SecretId')] [int[]] $Id ) begin { $tssParams = $PSBoundParameters $invokeParams = . $GetInvokeApiParams $TssSession } process { . $InternalEndpointUsed $PSCmdlet.MyInvocation Write-Verbose "Provided command parameters: $(. $GetInvocation $PSCmdlet.MyInvocation)" if ($tssParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) { . $CheckVersion $TssSession '10.9.000000' $PSCmdlet.MyInvocation foreach ($secret in $Id) { $restResponse = $null $uri = $TssSession.ApiUrl.Replace('api/v1', 'internals'), 'secret-detail', $secret, 'password-status' -join '/' $invokeParams.Uri = $uri $invokeParams.Method = 'GET' Write-Verbose "Performing the operation $($invokeParams.Method) $uri" try { $apiResponse = Invoke-TssApi @invokeParams $restResponse = . $ProcessResponse @apiResponse } catch { Write-Warning "Issue getting password status on Secret [$secret]" $err = $_ . $ErrorHandling $err } if ($restResponse.status -ne 'None') { [Thycotic.PowerShell.Secrets.PasswordStatus]$restResponse } else { Write-Host "No active password change found on Secret [$secret]" } } } else { Write-Warning 'No valid session found' } } } |