Functions/Accounts/Set-PASAccount.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 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 |
# .ExternalHelp psPAS-help.xml function Set-PASAccount { [CmdletBinding(SupportsShouldProcess, DefaultParameterSetName = 'Gen2SingleOp')] param( [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true )] [ValidateNotNullOrEmpty()] [Alias('id')] [string]$AccountID, [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Gen2SingleOp' )] [ValidateSet('add', 'replace', 'remove')] [Alias('Operation')] [string]$op, [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Gen2SingleOp' )] [string]$path, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Gen2SingleOp' )] [string]$value, [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Gen2MultiOp' )] [hashtable[]]$operations, [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Gen1' )] [string]$Folder, [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Gen1' )] [Alias('Name')] [string]$AccountName, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Gen1' )] [string]$DeviceType, [Alias('PolicyID')] [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Gen1' )] [string]$PlatformID, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Gen1' )] [string]$Address, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Gen1' )] [string]$UserName, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Gen1' )] [string]$GroupName, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'Gen1' )] [string]$GroupPlatformID, [parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $false, ParameterSetName = 'Gen1' )] [hashtable]$Properties = @{ }, [parameter( Mandatory = $false, ValueFromPipeline = $false, ParameterSetName = 'Gen2SingleOp' )] [parameter( Mandatory = $false, ValueFromPipeline = $false, ParameterSetName = 'Gen2MultiOp' )] [parameter( Mandatory = $false, ValueFromPipeline = $true, ParameterSetName = 'Gen1' )] [PSObject]$InputObject ) BEGIN { }#begin PROCESS { #Get all parameters that will be sent in the request $boundParameters = $PSBoundParameters | Get-PASParameter -ParametersToRemove InputObject, AccountID switch ($PSCmdlet.ParameterSetName) { { $PSItem -match 'Gen2' } { Assert-VersionRequirement -RequiredVersion 10.4 #Create URL for Request $URI = "$Script:BaseURI/api/Accounts/$AccountID" #Define method for request $Method = 'PATCH' #Define type of output object $Type = 'psPAS.CyberArk.Vault.Account.V10' if ($PSCmdlet.ParameterSetName -match 'Gen2MultiOp') { $boundParameters = $boundParameters['operations'] } #Do Not Pipe into ConvertTo-JSON. #Correct JSON Format is only achieved when the array is not sent along the pipe $body = ConvertTo-Json @($boundParameters) } 'Gen1' { #Create URL for Request $URI = "$Script:BaseURI/WebServices/PIMServices.svc/Accounts/$AccountID" #Define method for request $Method = 'PUT' #Define type of output object $Type = 'psPAS.CyberArk.Vault.Account' if ($PSBoundParameters.ContainsKey('Properties')) { #Format "Properties" parameter value. #Array of key=value pairs required for JSON convertion $boundParameters['Properties'] = [Collections.Generic.List[Object]]@($boundParameters['Properties'].getenumerator() | ForEach-Object { $_ }) } If (($InputObject) -and (($InputObject | Get-Member).TypeName -eq 'psPAS.CyberArk.Vault.Account')) { #If InputObject is psPAS.CyberArk.Vault.Account #*i.e. receiving pipeline from Get-PASAccount #Get all existing properties as defined by input object: #Process Pipeline input object properties $InputObject | #exclude properties output by get-pasaccount not applicable to set-pasaccount request Select-Object -Property * -ExcludeProperty Name, PolicyID, Safe | #get all remaining noteproperties Get-Member -MemberType 'NoteProperty' | #For each property ForEach-Object { #Initialise hashtable $ExistingProperty = @{ } #if property is not bound to function parameter by name, if (!(($PSBoundParameters.ContainsKey($($_.Name))) -or ( #if not being explicitly updated. $($Properties).ContainsKey($($_.Name))))) { [hashtable]$ExistingProperty.Add($($_.Name), $($InputObject.$($_.Name))) #Add to Properties node of request data [array]$boundParameters['Properties'] += $ExistingProperty.GetEnumerator() | ForEach-Object { $_ } #*any existing properties of an account not sent in a "set" request will be cleared on the account. #*This ensures correctly formatted request with all existing account properties included #*when function is sent data via the pipeline. } } } #Create body of request $body = @{ 'Accounts' = $boundParameters #ensure nodes at all required depths are included in the JSON object } | ConvertTo-Json -Depth 3 break } } if ($PSCmdlet.ShouldProcess($AccountID, 'Update Account Properties')) { #send request to PAS web service $Result = Invoke-PASRestMethod -Uri $URI -Method $Method -Body $Body -WebSession $Script:WebSession If ($null -ne $result) { switch ($PSCmdlet.ParameterSetName) { 'Gen1' { $Return = $Result.UpdateAccountResult ; break } default { $Return = $Result } } $Return | Add-ObjectDetail -typename $Type -PropertyToAdd @{ 'AccountID' = $AccountID } } } }#process END { }#end } |