functions/groups/Search-Group.ps1
|
function Search-Group { <# .SYNOPSIS Search for user management groups .DESCRIPTION Search for user management groups .EXAMPLE $session = New-TssSession -SecretServer https://alpha -Credential $ssCred Search-TssGroup -TssSession $session Return list of all groups found in Secret Server that account has access to manage .LINK https://thycotic-ps.github.io/thycotic.secretserver/commands/groups/Search-TssGroup .LINK https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/groups/Search-Group.ps1 .NOTES Requires TssSession object returned by New-TssSession #> [CmdletBinding()] [OutputType('TssGroupSummary')] param ( # TssSession object created by New-TssSession for authentication [Parameter(Mandatory, ValueFromPipeline, Position = 0)] [Thycotic.PowerShell.Authentication.Session] $TssSession, # Active Directory Domain Id [int] $DomainId, # Include inactive groups in results [switch] $IncludeInactive, # Text to search for group name [string] $SearchText, # Sort by specific property, default Name [string] $SortBy = 'Name' ) begin { $tssParams = $PSBoundParameters $invokeParams = . $GetInvokeTssParams $TssSession } process { Write-Verbose "Provided command parameters: $(. $GetInvocation $PSCmdlet.MyInvocation)" if ($tssParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) { . $CheckVersion $TssSession '10.9.000000' $PSCmdlet.MyInvocation $uri = $TssSession.ApiUrl, 'groups' -join '/' $uri = $uri, "sortBy[0].direction=asc&sortBy[0].name=$SortBy&take=$($TssSession.Take)" -join '?' $filters = @() if ($tssParams.ContainsKey('DomainId')) { $filters += "filter.domainId=$DomainId" } if ($tssParams.ContainsKey('IncludeInactive')) { $filters += "filter.includeInactive=$IncludeInactive" } if ($tssParams.ContainsKey('SearchText')) { $filters += "filter.searchText=$SearchText" } if ($filters) { $uriFilter = $filters -join '&' Write-Verbose "Filters: $uriFilter" $uri = $uri, $uriFilter -join '&' } $invokeParams.Uri = $uri $invokeParams.Method = 'GET' Write-Verbose "$($invokeParams.Method) $uri" try { $restResponse = . $InvokeApi @invokeParams } catch { Write-Warning 'Issue on search request' $err = $_ . $ErrorHandling $err } if ($restResponse.records.Count -le 0 -and $restResponse.records.Length -eq 0) { Write-Warning 'No groups found' } if ($restResponse.records) { [TssGroupSummary[]]$restResponse.records } } else { Write-Warning 'No valid session found' } } } |