Functions/User/Remove-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
Function Remove-PASGroup {
    <#
.SYNOPSIS
Deletes a user group

.DESCRIPTION
Deletes a user group.

To delete a user group, the following authorizations are required:

- Add/Update Users

.PARAMETER GroupID
The unique ID of the group to delete.

.EXAMPLE
Delete-PASGroup -GroupID 3

Deletes Group with ID of 3

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

    [CmdletBinding(SupportsShouldProcess)]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [int]$GroupID
    )

    BEGIN {

        Assert-VersionRequirement -RequiredVersion 11.5

    }#begin

    Process {

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

        if ($PSCmdlet.ShouldProcess($GroupID, "Delete Group")) {

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

        }

    }

    End { }

}