Functions/Platforms/Get-PASPlatformSafe.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
function Get-PASPlatformSafe {
    <#
    .SYNOPSIS
    Get safes by platform id
     
    .DESCRIPTION
    Returns all safes for a given platform ID
 
    .PARAMETER PlatformID
    The unique ID/Name of the platform.
 
    .EXAMPLE
    Get-PASPlatformSafe -PlatformID WINDOMAIN
 
    .NOTES
    Minimum CyberArk version 11.1
    #>


    [CmdletBinding()]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$PlatformID
    )

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

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

        #Create request URL
        $URI = "$Script:BaseURI/API/Platforms/$($PlatformID | Get-EscapedString)/Safes"
            
        #Send request to web service
        $result = Invoke-PASRestMethod -Uri $URI -Method GET -WebSession $Script:WebSession

        If ($result.count -gt 0) {

            #Return Results
            $result.value | ForEach-Object { [pscustomobject]@{"SafeName" = $PSItem } }

        }

    }#process

    END { }#end

}