Functions/Authentication/Remove-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
function Remove-PASPublicSSHKey {
    <#
.SYNOPSIS
Deletes a specific Public SSH Key from a specific vault user.

.DESCRIPTION
Deletes an authorized public SSH key for a specific user in the
Vault, preventing them from authenticating to the Vault through PSMP
using a corresponding private SSH key.
"Reset Users Passwords" Vault permission is required.
The authenticated user who runs this function must be in the same Vault
Location or higher as the user whose public SSH keys are deleted.
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 ".".

.PARAMETER KeyID
The ID of the public SSH key to delete.

.EXAMPLE
Remove-PASPublicSSHKey -UserName Splitter -KeyID 415161FE8F2B408BB76BC244258C3697

Deletes specified ssh key from vault user "Splitter"

.LINK
https://pspas.pspete.dev/commands/Remove-PASPublicSSHKey
#>

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

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

    )

    BEGIN { }#begin

    PROCESS {

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

            Get-EscapedString)/AuthenticationMethods/SSHKeyAuthentication/AuthorizedKeys/$KeyID"


        if ($PSCmdlet.ShouldProcess($KeyID, "Delete Public SSH Key")) {

            #Send Request to web service
            Invoke-PASRestMethod -Uri $URI -Method DELETE -WebSession $Script:WebSession

        }

    }#process

    END { }#end
}