Functions/OnboardingRules/Get-PASOnboardingRule.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
# .ExternalHelp psPAS-help.xml
function Get-PASOnboardingRule {
    [CmdletBinding()]
    param(
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "Names"
        )]
        [ValidateNotNullOrEmpty()]
        [string]$Names
    )

    BEGIN {

    }#begin

    PROCESS {

        #Create URL for request
        $URI = "$Script:BaseURI/api/AutomaticOnboardingRules"

        If ($PSBoundParameters.ContainsKey("Names")) {

            Assert-VersionRequirement -RequiredVersion 10.2

            #Get Parameters to include in request
            $boundParameters = $PSBoundParameters | Get-PASParameter

            #Create Query String, escaped for inclusion in request URL
            #!This must be unescaped - send a comma separated string for the value of `Names`
            $queryString = $boundParameters | ConvertTo-QueryString -NoEscape

            if ($null -ne $queryString) {

                #Build URL from base URL
                $URI = "$URI`?$queryString"

            }

        }

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

        If ($null -ne $result) {

            $result.AutomaticOnboardingRules | Add-ObjectDetail -typename psPAS.CyberArk.Vault.OnboardingRule

        }

    }#process

    END { }#end

}