psPAS

5.5.110

Functions/User/Set-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
 # .ExternalHelp psPAS-help.xml
Function Set-PASGroup {
    [CmdletBinding(SupportsShouldProcess)]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [int]$GroupID,

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

    BEGIN {

        Assert-VersionRequirement -RequiredVersion 12.0

    }#begin

    Process {

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

        #Get request parameters
        $boundParameters = $PSBoundParameters | Get-PASParameter -ParametersToRemove GroupID

        #Construct Request Body
        $Body = $boundParameters | ConvertTo-Json

        if ($PSCmdlet.ShouldProcess($GroupID, 'Update Group')) {

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

        }

        if ($null -ne $result) {

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

        }

    }

    End { }

}