public/Get-VPASDirectoryMappingDetails.ps1
|
<#
.Synopsis GET DIRECTORY MAPPING DETAILS CREATED BY: Vadim Melamed, EMAIL: vpasmodule@gmail.com .DESCRIPTION USE THIS FUNCTION TO GET DIRECTORY MAPPING DETAILS .LINK https://vpasmodule.com/commands/Get-VPASDirectoryMappingDetails .PARAMETER token HashTable of data containing various pieces of login information (PVWA, LoginToken, HeaderType, etc). If -token is not passed, function will use last known hashtable generated by New-VPASToken .PARAMETER DomainName Target domain to query through .PARAMETER DirectoryMappingName Search query to locate target DomainMapping .PARAMETER DirectoryMappingID Unique ID that maps to the target Domain Mapping Supply DirectoryMappingID to skip any querying to find target DirectoryMapping .PARAMETER InputParameters HashTable of values containing the parameters required to make the API call .EXAMPLE $DirectoryMappingJSON = Get-VPASDirectoryMappingDetails -DirectoryMethodId {DIRECTORY MAPPING ID VALUE} .EXAMPLE $InputParameters = @{ DomainName = "vman.com" DirectoryMappingName = "Vault Admins" } $DirectoryMappingJSON = Get-VPASDirectoryMappingDetails -InputParameters $InputParameters .EXAMPLE $InputParameters = @{ DomainName = "vman.com" DirectoryMappingID = "36" } $DirectoryMappingJSON = Get-VPASDirectoryMappingDetails -InputParameters $InputParameters .OUTPUTS If successful: { "LDAPBranch": "DC=vman,DC=com", "MappingAuthorizations": [ "AddUpdateUsers", "AddSafes", "AddNetworkAreas", "ManageServerFileCategories", "AuditUsers", "ResetUsersPasswords", "ActivateUsers" ], "Location": "\\", "AuthenticationMethod": [ "AuthTypeLDAP" ], "UserType": "EPVUser", "DisableUser": false, "UserActivityLogPeriod": 7, "UserExpiration": 0, "LogonFromHour": 0, "LogonToHour": 24, "UsedQuota": -1, "AuthorizedInterfaces": [ ], "EnableENEWhenDisconnected": false, "MappingID": 36, "DirectoryMappingOrder": 1000, "MappingName": "Vault admins__vman.com", "LDAPQuery": "", "DomainGroups": [ "CAVaultAdmins" ] } --- $false if failed #> function Get-VPASDirectoryMappingDetails{ [OutputType('System.Object',[bool])] [CmdletBinding(DefaultParameterSetName='Set1')] Param( [Parameter(Mandatory=$true,ParameterSetName='Set1',ValueFromPipelineByPropertyName=$true,HelpMessage="Unique name of the target domain (for example: vman.com)")] [Parameter(Mandatory=$true,ParameterSetName='Set2',ValueFromPipelineByPropertyName=$true,HelpMessage="Unique name of the target domain (for example: vman.com)")] [String]$DomainName, [Parameter(Mandatory=$true,ParameterSetName='Set1',ValueFromPipelineByPropertyName=$true,HelpMessage="Unique name of the target directory mapping (for example: `"Vault Admins`")")] [String]$DirectoryMappingName, [Parameter(Mandatory=$true,ParameterSetName='Set2',ValueFromPipelineByPropertyName=$true,HelpMessage="Unique ID of the target directory mapping (for example: 36)")] [String]$DirectoryMappingID, [Parameter(Mandatory=$true,ParameterSetName='InputParameters',ValueFromPipelineByPropertyName=$true,HelpMessage="Hashtable of parameters required to make API call, refer to get-help -examples for valid inputs")] [hashtable]$InputParameters, [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true)] [hashtable]$token ) Begin{ $tokenval,$sessionval,$PVWA,$Header,$ISPSS,$IdentityURL,$EnableTextRecorder,$AuditTimeStamp,$NoSSL,$VaultVersion,$HideWarnings,$AuthenticatedAs,$SubDomain,$EnableTroubleshooting = Get-VPASSession -token $token $CommandName = $MyInvocation.MyCommand.Name $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType COMMAND } Process{ try{ if($PSCmdlet.ParameterSetName -eq "InputParameters"){ $KeyHash = @{ set1 = @{ AcceptableKeys = @("DomainName","DirectoryMappingName") MandatoryKeys = @("DomainName","DirectoryMappingName") } set2 = @{ AcceptableKeys = @("DomainName","DirectoryMappingID") MandatoryKeys = @("DomainName","DirectoryMappingID") } } $CheckSet = Test-VPASHashtableKeysHelper -InputHash $InputParameters -KeyHash $KeyHash if(!$CheckSet){ $log = Write-VPASTextRecorder -inputval "FAILED TO FIND TARGET PARAMETER SET" -token $token -LogType MISC Write-Verbose "FAILED TO FIND TARGET PARAMETER SET" Write-VPASOutput -str "FAILED TO FIND TARGET PARAMETER SET...VIEW EXAMPLES BELOW:" -type E $examples = Write-VPASExampleHelper -CommandName $CommandName return $false } else{ foreach($key in $InputParameters.Keys){ Set-Variable -Name $key -Value $InputParameters.$key } } } }catch{ $log = Write-VPASTextRecorder -inputval $_ -token $token -LogType ERROR $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC Write-Verbose "FAILED TO RETRIEVE DIRECTORY MAPPINGS" Write-VPASOutput -str $_ -type E return $false } try{ if([String]::IsNullOrEmpty($DirectoryMappingID)){ Write-Verbose "NO DIRECTORY MAPPING ID PROVIDED...INVOKING HELPER FUNCTION TO RETRIEVE UNIQUE DIRECTORY MAPPING ID BASED ON SPECIFIED PARAMETERS" $DirectoryMappingID = Get-VPASDirectoryMappingIDHelper -token $token -DomainName $DomainName -DirectoryMappingSearch $DirectoryMappingName Write-Verbose "RETURNING DIRECTORY MAPPING ID" } else{ Write-Verbose "DIRECTORY MAPPING ID SUPPLIED, SKIPPING HELPER FUNCTION" } if($NoSSL){ Write-Verbose "NO SSL ENABLED, USING HTTP INSTEAD OF HTTPS" $uri = "http://$PVWA/PasswordVault/API/Configuration/LDAP/Directories/$DomainName/Mappings/$DirectoryMappingID" } else{ Write-Verbose "SSL ENABLED BY DEFAULT, USING HTTPS" $uri = "https://$PVWA/PasswordVault/API/Configuration/LDAP/Directories/$DomainName/Mappings/$DirectoryMappingID" } $log = Write-VPASTextRecorder -inputval $uri -token $token -LogType URI $log = Write-VPASTextRecorder -inputval "GET" -token $token -LogType METHOD write-verbose "MAKING API CALL TO CYBERARK" if($sessionval){ $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method GET -ContentType "application/json" -WebSession $sessionval } else{ $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method GET -ContentType "application/json" } $outputlog = $response $log = Write-VPASTextRecorder -inputval $outputlog -token $token -LogType RETURN Write-Verbose "RECEIVED JSON OBJECT" Write-Verbose "RETURNING DIRECTORY MAPPING DETAILS" return $response }catch{ $log = Write-VPASTextRecorder -inputval $_ -token $token -LogType ERROR $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC Write-Verbose "UNABLE TO GET DIRECTORY MAPPING DETAILS" Write-VPASOutput -str $_ -type E return $false } } End{ $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType DIVIDER } } |