Functions/LDAPDirectories/Get-PASDirectory.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
function Get-PASDirectory {
    <#
.SYNOPSIS
Get LDAP directories configured in the Vault
 
.DESCRIPTION
Returns a list of existing directories in the Vault.
Each directory will be returned with its own data.
Membership of the Vault Admins group required.
 
.PARAMETER id
The ID or Name of the directory to return information on.
Requires CyberArk version 10.5+
 
.EXAMPLE
Get-PASDirectory
 
Returns LDAP directories configured in the Vault
 
.INPUTS
WebSession & BaseURI can be piped to the function by propertyname
 
.OUTPUTS
LDAP Directory Details
 
.LINK
https://pspas.pspete.dev/commands/Get-PASDirectory
#>

    [CmdletBinding()]
    param(
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "v10_5"
        )]
        [Alias("DomainName")]
        [string]$id

    )

    BEGIN {
        $MinimumVersion = [System.Version]"10.4"
        $RequiredVersion = [System.Version]"10.5"
    }#begin

    PROCESS {

        Assert-VersionRequirement -ExternalVersion $Script:ExternalVersion -RequiredVersion $MinimumVersion

        #Create URL for request
        $URI = "$Script:BaseURI/api/Configuration/LDAP/Directories"

        if ($PSCmdlet.ParameterSetName -eq "v10_5") {

            Assert-VersionRequirement -ExternalVersion $Script:ExternalVersion -RequiredVersion $RequiredVersion

            #Update URL for request
            $URI = "$URI/$id/"

            $type = "psPAS.CyberArk.Vault.Directory.Extended"

        }
        Else { $type = "psPAS.CyberArk.Vault.Directory" }

        #send request to web service
        $result = Invoke-PASRestMethod -Uri $URI -Method GET -WebSession $Script:WebSession

        If ($result) {

            #Return Results
            $result |

            Add-ObjectDetail -typename $type

        }

    }#process

    END { }#end
}