Get-PASAccountGroup

Get-PASAccountGroup

SYNOPSIS

Returns all the account groups in a specific Safe.

SYNTAX

Gen2 (Default)

Get-PASAccountGroup -Safe <String> [<CommonParameters>]

Gen1

Get-PASAccountGroup -Safe <String> [-UseGen1API] [<CommonParameters>]

DESCRIPTION

Returns all the account groups in a specific Safe.

The following permissions are required on the safe where the account group will be created:

  • Add Accounts
  • Update Account Content
  • Update Account Properties -Create Folders

EXAMPLES

EXAMPLE 1

Get-PASAccountGroup -Safe SafeName

List all account groups in SafeName

PARAMETERS

-Safe

The Safe where the account groups are.

Type: String
Parameter Sets: (All)
Aliases:

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

-UseGen1API

Specify to force usage the Gen1 API endpoint.

This is based on the Get Account Groups By Safe API, introduced in PAS 10.5, deprecated in 12.6

Type: SwitchParameter
Parameter Sets: Gen1
Aliases: UseClassicAPI

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

NOTES

Minimum CyberArk version 9.10

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

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

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