Functions/User/Remove-PASGroupMember.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
function Remove-PASGroupMember {
    <#
.SYNOPSIS
Removes a vault user from a group
 
.DESCRIPTION
Removes an existing member from an existing group in the vault
 
.PARAMETER GroupID
The ID of the group
 
.PARAMETER Member
The name of the group member
 
.EXAMPLE
Remove-PASGroupMember -GroupID X1_Y2 -Member TargetUser
 
Removes TargetUser from group
 
.INPUTS
All parameters can be piped by property name
 
.OUTPUTS
None
#>

    [CmdletBinding(SupportsShouldProcess)]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [Alias("ID")]
        [string]$GroupID,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [Alias("UserName")]
        [string]$Member
    )

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

    PROCESS {

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

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

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

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

        }

    }#process

    END {}#end

}