functions/users/Get-TssUser.ps1
|
function Get-TssUser { <# .SYNOPSIS Get a Secret Server User .DESCRIPTION Get a Secret Server User .EXAMPLE PS> $session = New-TssSession -SecretServer https://alpha -Credential $ssCred PS> Get-TssUser -TssSession $session -Id 2 Get the User ID 2 .LINK https://thycotic-ps.github.io/thycotic.secretserver/commands/users/Get-TssUser .LINK https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/users/Get-TssUser.ps1 .NOTES Requires TssSession object returned by New-TssSession #> [CmdletBinding()] [OutputType('Thycotic.PowerShell.Users.User')] param ( # TssSession object created by New-TssSession for authentication [Parameter(Mandatory, ValueFromPipeline, Position = 0)] [Thycotic.PowerShell.Authentication.Session] $TssSession, # User ID [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [Alias('UserId')] [int[]] $Id, # Include inactive users in results [switch] $IncludeInactive ) begin { $tssParams = $PSBoundParameters $invokeParams = . $GetInvokeApiParams $TssSession } process { Write-Verbose "Provided command parameters: $(. $GetInvocation $PSCmdlet.MyInvocation)" if ($tssParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) { . $CheckVersion $TssSession '10.9.000000' $PSCmdlet.MyInvocation foreach ($user in $Id) { $restResponse = $null $uri = $TssSession.ApiUrl, 'users', $user -join '/' $invokeParams.Uri = $uri $invokeParams.Method = 'GET' Write-Verbose "Performing the operation $($invokeParams.Method) $($invokeParams.Uri)" try { $apiResponse = Invoke-TssApi @invokeParams $restResponse = . $ProcessResponse $apiResponse } catch { Write-Warning "Issue getting user [$user]" $err = $_ . $ErrorHandling $err } if ($restResponse) { [Thycotic.PowerShell.Users.User]$restResponse } } } else { Write-Warning 'No valid session found' } } } |