Functions/AccountGroups/Add-PASAccountGroupMember.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
function Add-PASAccountGroupMember {
    <#
.SYNOPSIS
Adds an account as a member of an account group.
 
.DESCRIPTION
Adds an account as a member of an account group.
The account can contain either password or SSH key.
The account must be stored in the same safe as the account group.
The following permissions are required on the safe where the account group will be created:
 - Add Accounts
 - Update Account Content
 - Update Account Properties
 
.PARAMETER GroupID
The unique ID of the account group
 
.PARAMETER AccountID
The ID of the account to add as a member
 
.EXAMPLE
Add-PASAccountGroupMember -GroupID $groupID -AccountID $accID
 
Adds account with ID held in $accID to group with ID held in $groupID
 
.INPUTS
All parameters can be piped by property name
 
.OUTPUTS
None
 
.NOTES
Minimum version 9.9.5
 
.LINK
https://pspas.pspete.dev/commands/Add-PASAccountGroupMember
#>

    [CmdletBinding()]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateNotNullOrEmpty()]
        [string]$GroupID,

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

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

    PROCESS {

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

        #Create URL for Request
        $URI = "$Script:BaseURI/API/AccountGroups/$($GroupID |
 
            Get-EscapedString)/Members"


        #Create body of request
        $body = $PSBoundParameters |

        Get-PASParameter -ParametersToRemove GroupID | ConvertTo-Json

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

    }#process

    END { }#end

}