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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
function Get-PASOnboardingRule {
    <#
.SYNOPSIS
Gets all automatic on-boarding rules
 
.DESCRIPTION
Returns information on defined on-boarding rules.
Vault Admin membership required.
 
.PARAMETER Names
A filter that specifies the rule name.
Separate a list of rules with commas.
If not specified, all rules will be returned.
For version 10.2 onwards (not a supported parameter on earlier versions)
 
.EXAMPLE
Get-PASOnboardingRule
 
List information on all On-boarding rules
 
.EXAMPLE
Get-PASOnboardingRule -Names Rule1,Rule2
 
List information on On-boarding rules "Rule1" & "Rule2"
 
.INPUTS
All parameters can be piped by property name
 
.OUTPUTS
Outputs Object of Custom Type psPAS.CyberArk.Vault.OnboardingRule
Output format is defined via psPAS.Format.ps1xml.
To force all output to be shown, pipe to Select-Object *
 
.LINK
https://pspas.pspete.dev/commands/Get-PASOnboardingRule
#>

    [CmdletBinding()]
    param(
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "10_2"
        )]
        [ValidateNotNullOrEmpty()]
        [string]$Names
    )

    BEGIN {
        $MinimumVersion = [System.Version]"10.2"
    }#begin

    PROCESS {

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

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

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

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

            #Create Query String, escaped for inclusion in request URL
            $queryString = ($boundParameters.keys | ForEach-Object {

                    "$_=$($boundParameters[$_])"

                })

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

        }

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

        if ($result) {

            $result.AutomaticOnboardingRules |

            Add-ObjectDetail -typename psPAS.CyberArk.Vault.OnboardingRule

        }

    }#process

    END { }#end

}