Functions/Authentication/Get-PASPublicSSHKey.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
function Get-PASPublicSSHKey {
    <#
.SYNOPSIS
Retrieves a user's SSH Keys.

.DESCRIPTION
Retrieves all public SSH keys that are authorized for a specific user.
The "Reset User Passwords" Vault permission is required to query public SSH Keys.
The authenticated user who runs the function must be in the same Vault
Location or higher as the user whose public SSH keys are retrieved.
A user cannot manage their own public SSH keys.

.PARAMETER UserName
The username of the Vault user whose public SSH keys will be added
A username cannot contain te follwing characters: "%", "&", "+" or ".".

.EXAMPLE
Get-PASPublicSSHKey -UserName user1

Lists all SSH Keys for vault user - user1:

UserName KeyID PublicSSHKey
-------- ----- ------------
user1 415161FE8F2B408BB76BC244258C3697 ACABB3NzaC1kc3MAAACBAJ3hA...............
user1 B6DCA4D54B2E93380F42DDCDB23EE52A AgreatNzaC1kc3MAAACBAJ3hB...............
user1 D6374740D11A5F45992D80D80E97387A PHil0soPh3rkc3MAAACBAJ3hC...............

#>

    [CmdletBinding()]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateScript( {$_ -notmatch ".*(%|\&|\+|\.).*"})]
        [string]$UserName

    )

    BEGIN {}#begin

    PROCESS {

        #Create URL for request
        $URI = "$Script:BaseURI/WebServices/PIMServices.svc/Users/$($UserName |

            Get-EscapedString)/AuthenticationMethods/SSHKeyAuthentication/AuthorizedKeys"


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

        if($result) {

            $result.GetUserAuthorizedKeysResult |

            Add-ObjectDetail -typename psPAS.CyberArk.Vault.PublicSSHKey -PropertyToAdd @{

                "UserName"     = $UserName

            }

        }

    }#process

    END {}#end

}