Get-PASGroup

Get-PASGroup

SYNOPSIS

List groups from the vault

SYNTAX

groupType (Default)

Get-PASGroup [-groupType <String>] [-sort <String[]>] [-search <String>] [-includeMembers <Boolean>]
 [<CommonParameters>]

filter

Get-PASGroup [-filter <String>] [-sort <String[]>] [-search <String>] [-includeMembers <Boolean>]
 [<CommonParameters>]

DESCRIPTION

Returns a list of all existing user groups.

The user performing this task:

  • Must have Audit users permissions in the Vault.
  • Can see groups either only on the same level, or lower in the Vault hierarchy.

EXAMPLES

EXAMPLE 1

Get-PASGroup

Returns all existing groups

EXAMPLE 2

Get-PASGroup -groupType Directory

Returns all existing Directory groups

EXAMPLE 3

Get-PASGroup -groupType Vault

Returns all existing Vault groups

EXAMPLE 4

Get-PASGroup -filter 'groupType eq Directory'

Returns all existing Directory groups

EXAMPLE 5

Get-PASGroup -search "Vault Admins"

Returns all groups matching all search terms

EXAMPLE 6

Get-PASGroup -search "Vault Admins" -groupType Directory

Returns all existing Directory groups matching all search terms

EXAMPLE 7

Get-PASGroup -search Admins -includeMembers $true

Returns all existing groups matching search, includes vault group member details in result.

PARAMETERS

-groupType

Search for groups which are from a configured Directory or from the Vault.

Type: String
Parameter Sets: groupType
Aliases:

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

-filter

Filter according to REST standard.

*depreciated parameter in psPAS - filter value will automatically be set with if groupType specified.

Type: String
Parameter Sets: filter
Aliases:

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

Search will match when ALL search terms appear in the group name.

Type: String
Parameter Sets: (All)
Aliases:

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

-includeMembers

Specify $true to return vault group members

Defaults to $false due to performance considerations

Requires minimum version of 12.0

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-sort

Property or properties by which to sort returned groups, followed by asc (default) or desc to control sort direction.

Cannot sort by a property other than groupname, directory or location.

Separate multiple properties with commas, up to a maximum of three properties.

Requires minimum version of 12.2

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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

NOTES

Minimum Version 10.5

https://pspas.pspete.dev/commands/Get-PASGroup

https://docs.cyberark.com/Product-Doc/OnlineHelp/PAS/Latest/en/Content/WebServices/GetGroupsFromVault.htm