Functions/AccountGroups/Add-PASAccountGroupMember.ps1
|
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 .PARAMETER sessionToken Hashtable containing the session token returned from New-PASSession .PARAMETER WebSession WebRequestSession object returned from New-PASSession .PARAMETER BaseURI PVWA Web Address Do not include "/PasswordVault/" .PARAMETER PVWAAppName The name of the CyberArk PVWA Virtual Directory. Defaults to PasswordVault .PARAMETER ExternalVersion The External CyberArk Version, returned automatically from the New-PASSession function from version 9.7 onwards. If the minimum version requirement of this function is not satisfied, execution will be halted. Omitting a value for this parameter, or supplying a version of "0.0" will skip the version check. .EXAMPLE Add-PASAccountGroupMember -GroupID $groupID -AccountID $accID -sessionToken $ST -BaseURI $URL 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 #> [CmdletBinding()] param( [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true )] [ValidateNotNullOrEmpty()] [string]$GroupID, [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true )] [string]$AccountID, [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true )] [ValidateNotNullOrEmpty()] [hashtable]$sessionToken, [parameter( ValueFromPipelinebyPropertyName = $true )] [Microsoft.PowerShell.Commands.WebRequestSession]$WebSession, [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true )] [string]$BaseURI, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [string]$PVWAAppName = "PasswordVault", [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [System.Version]$ExternalVersion = "0.0" ) BEGIN { $MinimumVersion = [System.Version]"9.9.5" }#begin PROCESS { Assert-VersionRequirement -ExternalVersion $ExternalVersion -RequiredVersion $MinimumVersion #Create URL for Request $URI = "$baseURI/$PVWAAppName/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 -Headers $sessionToken -WebSession $WebSession }#process END {}#end } |