Functions/User/Get-PASGroup.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
function Get-PASGroup {
    <#
.SYNOPSIS
List groups from the vault

.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.

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

.PARAMETER filter
Filter according to REST standard.
*depreciated parameter in psPAS - filter value will automatically be set with if groupType specified.

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

.EXAMPLE
Get-PASGroup

Returns all existing groups

.EXAMPLE
Get-PASGroup -groupType Directory

Returns all existing Directory groups

.EXAMPLE
Get-PASGroup -groupType Vault

Returns all existing Vault groups

.EXAMPLE
Get-PASGroup -filter 'groupType eq Directory'

Returns all existing Directory groups

.EXAMPLE
Get-PASGroup -search "Vault Admins"

Returns all groups matching all search terms

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

Returns all existing Directory groups matching all search terms

.INPUTS
All parameters can be piped by property name

.OUTPUTS
psPAS.CyberArk.Vault.Group Object

.NOTES
Minimum Version 10.5

.LINK
https://pspas.pspete.dev/commands/Get-PASGroup
#>

    [CmdletBinding(DefaultParameterSetName = "groupType")]
    param(
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "groupType"
        )]
        [ValidateSet("Directory", "Vault")]
        [string]$groupType,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "filter"
        )]
        [ValidateSet("groupType eq Directory", "groupType eq Vault")]
        [string]$filter,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$search
    )

    BEGIN {
        $MinimumVersion = [System.Version]"10.5"
    }#begin

    PROCESS {

        Assert-VersionRequirement -ExternalVersion $Script:ExternalVersion -RequiredVersion $MinimumVersion

        #Create URL for request
        $URI = "$Script:BaseURI/API/UserGroups"

        #Get Parameters to include in request
        $boundParameters = $PSBoundParameters | Get-PASParameter -ParametersToRemove groupType

        If ($groupType) {

            $boundParameters["filter"] = "groupType eq $($groupType)"

        }

        #Create Query String, escaped for inclusion in request URL
        $queryString = $boundParameters | ConvertTo-QueryString

        if ($queryString) {

            #Build URL from base URL
            $URI = "$URI`?$queryString"

        }

        #send request to web service
        $result = Invoke-PASRestMethod -Uri $URI -Method GET -WebSession $Script:WebSession

        if ($result) {

            $result.value | Add-ObjectDetail -typename psPAS.CyberArk.Vault.Group

        }

    }#process

    END { }#end

}