Get-TssGroupMember

SYNOPSIS

Get all users that are members of a Group

SYNTAX

Get-TssGroupMember [-TssSession] <Session> -Id <Int32[]> [-IncludeInactive] [-UserDomainId <Int32>]
 [-SortBy <String>] [<CommonParameters>]

DESCRIPTION

Get a Group’s membership - lists all users that are members of the given Group, with optional filtering (inactive users, user domain) and sorting.

To get the details of a single, specific user within a Group, use Get-TssGroupUser instead.

EXAMPLES

EXAMPLE 1

$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Get-TssGroupMember -TssSession $session -Id 2

Get users that are members of Group 2

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

-Id

Group ID

Type: Int32[]
Parameter Sets: (All)
Aliases: GroupId

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IncludeInactive

Include inactive Users in Group

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-UserDomainId

Members that are in a specific domain

Type: Int32
Parameter Sets: (All)
Aliases:

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

-SortBy

Sort by specific property, default DisplayName

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: DisplayName
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.UserSummary

NOTES

Requires TssSession object returned by New-TssSession

This command lists all members of a Group via the groups/{id}/users endpoint. To target a single user within a Group use Get-TssGroupUser.

https://thycotic-ps.github.io/thycotic.secretserver/commands/groups/Get-TssGroupMember

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

https://thycotic-ps.github.io/thycotic.secretserver/commands/groups/Get-TssGroupUser