Find-TssGroup

SYNOPSIS

Find for a Secret Server Group

SYNTAX

Find-TssGroup [-TssSession] <Session> [-DomainId <Int32>] [-ViewableGroups] [-SearchText <String>]
 [-IncludeInactive] [-SortBy <String>] [<CommonParameters>]
  

DESCRIPTION

Find for a Secret Server Group (domain or local)

EXAMPLES

EXAMPLE 1

$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Find-TssGroup -TssSession $session -DomainId 1
  

Return list of Groups found in Secret Server for Domain Directory 1

EXAMPLE 2

$session = New-TssSession -SecretServer https://alpha/SecretServer -Credential $ssCred
Find-TssGroup -TssSession $session -SearchText 'IT'
  

Return list of Groups found in Secret Server matching the characters IT

PARAMETERS

-TssSession

TssSession object created by New-TssSession for authentication

Type: Session
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
  

-DomainId

Director Services Domain Id

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
  

-ViewableGroups

Limit to groups the current user can view details

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
  

-SearchText

Search text

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
  

-IncludeInactive

Include inactive Groups

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
  

-SortBy

Sort by specific property, default Name

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Name
Accept pipeline input: False
Accept wildcard characters: False
  

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

Thycotic.PowerShell.Groups.Lookup

NOTES

Requires TssSession object returned by New-TssSession

https://thycotic-ps.github.io/thycotic.secretserver/commands/groups/Find-TssGroup

https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/groups/Find-TssGroup.ps1