Functions/Accounts/Get-PASAccountSSHKey.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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
Function Get-PASAccountSSHKey {
    <#
.SYNOPSIS
Retrieves a private SSH key

.DESCRIPTION
Get the private SSH key value from an existing account

.PARAMETER AccountID
The ID of the account whose SSH Key will be retrieved.

.PARAMETER Reason
The reason for retrieving the private SSH key.

.PARAMETER TicketingSystem
The name of the ticketing system.

.PARAMETER TicketId
The ticket ID defined in the ticketing system.

.PARAMETER Version
The version number of the required SSH key.
If the value is left empty or the value passed does not exist,
then the current SSH key version is returned.

.PARAMETER ActionType
The action this SSH key is used for

.PARAMETER isUse
Internal parameter (for use of PSMP only)

.PARAMETER Machine
The address of the remote machine

.EXAMPLE
Get-PASAccountSSHKey -AccountId 12_3 -Reason "Some Reason"

Returns Private SSH Key associated with account 12_3

#>

    [CmdletBinding()]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [Alias("id")]
        [string]$AccountID,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$Reason,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$TicketingSystem,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$TicketId,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [int]$Version,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateSet("retrieve")]
        [string]$ActionType,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [boolean]$isUse,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [switch]$Machine
    )

    BEGIN {
        Assert-VersionRequirement -RequiredVersion 11.5
    }

    PROCESS {

        #Create URL for request
        $URI = "$Script:BaseURI/api/Accounts/$($AccountID | Get-EscapedString)/Secret/Retrieve"

        #Create request body
        $body = $PSBoundParameters | Get-PASParameter -ParametersToRemove AccountID | ConvertTo-Json

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

        If ($null -ne $result) {

            $result

        }
    }

    END { }

}