functions/inbox/Get-TssInboxMessage.ps1
|
function Get-TssInboxMessage { <# .SYNOPSIS Get an inbox message .DESCRIPTION Get an inbox message of the current user by ID, with its message type, details, data and recipients. Secret Server 12.3 returns IsRead False from this route even for a read message; Search-TssInboxMessage reports the read status. .PARAMETER TssSession TssSession object created by New-TssSession for authentication .PARAMETER Id Inbox message ID .EXAMPLE $session = New-TssSession -SecretServer https://alpha -Credential $ssCred Get-TssInboxMessage -TssSession $session -Id 112 Return inbox message 112 .LINK https://thycotic-ps.github.io/thycotic.secretserver/commands/inbox/Get-TssInboxMessage .LINK https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/inbox/Get-TssInboxMessage.ps1 .NOTES Requires TssSession object returned by New-TssSession #> [CmdletBinding()] [OutputType('Thycotic.PowerShell.Inbox.Message')] param ( [Parameter(Mandatory, ValueFromPipeline, Position = 0)] [Thycotic.PowerShell.Authentication.Session] $TssSession, [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [Alias('MessageId')] [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, 'inbox', 'message', $currentId -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 with Get-TssInboxMessage request' $err = $_ . $ErrorHandling $err } if ($restResponse) { [Thycotic.PowerShell.Inbox.Message](. $FilterTssResponse $restResponse ([Thycotic.PowerShell.Inbox.Message])) } } } else { Write-Warning 'No valid session found' } } } |