Search-TssDirectoryServiceGroup

SYNOPSIS

Search the Directory Service for the groups assigned

SYNTAX

Search-TssDirectoryServiceGroup [-TssSession] <Session> -DomainId <Int32> [-SearchText <String>]
 [<CommonParameters>]

DESCRIPTION

Search the Directory Service for the groups assigned

EXAMPLES

EXAMPLE 1

$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Search-TssDirectoryServiceGroup -TssSession $session -DomainId 2 -SearchText Admin*

Return list of Groups assigned to Domain ID 2 that start with Admin

EXAMPLE 2

$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Search-TssDirectoryServiceGroup -TssSession $session -DomainId 1

Return list of all Groups accessible in Domain ID 1

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

Domain ID

Type: Int32
Parameter Sets: (All)
Aliases:

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

-SearchText

Search Text, supports wildcard usage (e.g. Admin, Admin*)

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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.DirectoryServices.Group

NOTES

Requires TssSession object returned by New-TssSession

https://thycotic-ps.github.io/thycotic.secretserver/commands/directory-services/Search-TssDirectoryServiceGroup

https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/directory-services/Search-TssDirectoryServiceGroup.ps1