Functions/LDAPDirectories/Set-PASDirectoryMapping.ps1
|
# .ExternalHelp psPAS-help.xml function Set-PASDirectoryMapping { [CmdletBinding(SupportsShouldProcess)] param( [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true )] [string]$DirectoryName, [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true )] [ValidateLength(1, 28)] [string]$MappingID, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [ValidateLength(1, 28)] [string]$MappingName, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [string]$LDAPBranch, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [string[]]$DomainGroups, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [string[]]$VaultGroups, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [string]$Location, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [string]$LDAPQuery, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $false )] [Authorizations]$MappingAuthorizations, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [ValidateRange(1, 3650)] [int]$UserActivityLogPeriod, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [int]$UsedQuota, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [AllowEmptyCollection()] [ArgumentCompleter({ #Standard ArgumentCompleter parameters. param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameters) #Avoid PSScriptAnalyzer PSReviewUnusedParameter rule on standard ArgumentCompleter parameters. $null = $parameterName, $commandAst, $fakeBoundParameters #ask the API for valid client ids try { $Module = (Get-Command $commandName -ErrorAction Stop).Module $ClientIDs = & $Module { Get-PASClientID -ErrorAction Stop } } catch { return } $ClientIDs | Where-Object { $_ -and ($_ -like "$wordToComplete*") } | ForEach-Object { [System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterValue', $_) } })] [string[]]$AuthorizedInterfaces, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [boolean]$EnableENEWhenDisconnected, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [AllowEmptyCollection()] [ValidateSet('SAML', 'PKI', 'PKIPN', 'FIDO', 'WINDOWS')] [string[]]$allowedAuthenticationMethods ) begin { Assert-VersionRequirement -SelfHosted #10.7 functionality Assert-VersionRequirement -RequiredVersion 10.7 }#begin process { #Get request parameters $boundParameters = $PSBoundParameters | Get-PASParameter -ParametersToRemove DirectoryName, MappingID, MappingAuthorizations #Ensure minimum required version is being used. switch ($PSBoundParameters.Keys) { 'MappingAuthorizations' { #Transform MappingAuthorizations $boundParameters.Add('MappingAuthorizations', [array][int]$MappingAuthorizations) continue } 'UserActivityLogPeriod' { #v10.10 Assert-VersionRequirement -RequiredVersion 10.10 continue } { $_ -match 'UsedQuota|AuthorizedInterfaces|EnableENEWhenDisconnected' } { #v14.0 Assert-VersionRequirement -RequiredVersion 14.0 continue } { $_ -match 'allowedAuthenticationMethods' } { #v14.4 Assert-VersionRequirement -RequiredVersion 14.4 continue } } #Create URL for request $URI = "$($psPASSession.BaseURI)/api/Configuration/LDAP/Directories/$DirectoryName/Mappings/$MappingID/" $DirectoryMapping = Get-PASDirectoryMapping -DirectoryName $DirectoryName -MappingID $MappingID if ($null -ne $DirectoryMapping) { Format-PutRequestObject -InputObject $DirectoryMapping -boundParameters $BoundParameters -ParametersToRemove MappingID, DirectoryMappingOrder, LogonToHour, LogonFromHour, UserExpiration, DisableUser, UserType, AuthenticationMethod } $boundParameters['DomainGroups'] = $boundParameters['DomainGroups'] -as [array] $boundParameters['AuthorizedInterfaces'] = $boundParameters['AuthorizedInterfaces'] -as [array] $boundParameters['MappingAuthorizations'] = $boundParameters['MappingAuthorizations'] -as [array] $body = $boundParameters | ConvertTo-Json if ($PSCmdlet.ShouldProcess($MappingID, 'Update Directory Mapping')) { #send request to web service $result = Invoke-PASRestMethod -Uri $URI -Method PUT -Body $Body if ($null -ne $result) { #Return Results $result | Add-ObjectDetail -typename psPAS.CyberArk.Vault.Directory.Mapping } } }#process end { }#end } |