public/Get-VPASDirectoryDetails.ps1
|
<#
.Synopsis GET DIRCECTORY DETAILS CREATED BY: Vadim Melamed, EMAIL: vpasmodule@gmail.com .DESCRIPTION USE THIS FUNCTION TO GET DIRECTORY DETAILS .LINK https://vpasmodule.com/commands/Get-VPASDirectoryDetails .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 DirectoryID Unique DirectoryID that maps to the target Directory to retrieve details .PARAMETER InputParameters HashTable of values containing the parameters required to make the API call .EXAMPLE $DirectoryDetailsJSON = Get-VPASDirectoryDetails -DirectoryID {DIRECTORYID VALUE} .EXAMPLE $InputParameters = @{ DirectoryID = "vman.com" } $DirectoryDetailsJSON = Get-VPASDirectoryDetails -InputParameters $InputParameters .OUTPUTS If successful: { "DirectoryType": "MicrosoftADProfile.ini", "BindUsername": "bindacct@vman.com", "BindPassword": "", "SSLConnect": false, "LDAPDirectoryName": "vman.com", "LDAPDirectoryQueryOrder": 1, "LDAPDirectoryDescription": "", "VaultObjectNamesPrefix": "", "PasswordObjectPath": "root\\vman.com.pass", "LDAPDirectoryGroupBaseContext": "DC=vman,DC=com", "ReferralsChasingHopLimit": -1, "AppendFriendlyDomainNameToGroup": false, "RequireReferredDirectoryDefinition": false, "ReferralsDNSLookup": false, "DisableUserEnumeration": false, "AdditionalQueryFilterOptimize": true, "ClientBrowsing": true, "ExternalObjectCreation": true, "Authentication": true, "UseLDAPCertificatesOnly": false, "DisablePaging": false, "ProvisionDisabledUsers": false, "LDAPDirectoryUsage": [ "ExternalObjectCreation", "ClientBrowsing", "Authentication" ], "DCList": [ { "Name": "192.168.111.111", "Port": 389, "SSLConnect": false } ], "DomainName": "vman.com", "DomainBaseContext": "DC=vman,DC=com" } --- $false if failed #> function Get-VPASDirectoryDetails{ [OutputType('System.Object',[bool])] [CmdletBinding(DefaultParameterSetName='Set1')] Param( [Parameter(Mandatory=$true,ParameterSetName='Set1',ValueFromPipelineByPropertyName=$true,HelpMessage="Enter target DirectoryID to query details")] [String]$DirectoryID, [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 = @("DirectoryID") MandatoryKeys = @("DirectoryID") } } $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 DETAILS" Write-VPASOutput -str $_ -type E return $false } try{ if($NoSSL){ Write-Verbose "NO SSL ENABLED, USING HTTP INSTEAD OF HTTPS" $uri = "http://$PVWA/PasswordVault/API/Configuration/LDAP/Directories/$DirectoryID/" } else{ Write-Verbose "SSL ENABLED BY DEFAULT, USING HTTPS" $uri = "https://$PVWA/PasswordVault/API/Configuration/LDAP/Directories/$DirectoryID/" } $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 "SUCCESSFULLY RETRIEVED DETAILS FOR $DirectoryID" Write-Verbose "RETURNING JSON OBJECT" 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 RETRIEVE DETAILS FOR $DirectoryID" Write-VPASOutput -str $_ -type E return $false } } End{ $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType DIVIDER } } |