Functions/Authentication/Remove-PASAuthenticationMethod.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
# .ExternalHelp psPAS-help.xml
Function Remove-PASAuthenticationMethod {

    [CmdletBinding(SupportsShouldProcess)]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateLength(1, 50)]
        [string]$id
    )

    BEGIN {

        Assert-VersionRequirement -RequiredVersion 11.7

    }#begin

    PROCESS {

        #Create URL for request
        $URI = "$Script:BaseURI/api/Configuration/AuthenticationMethods/$($id | Get-EscapedString)"

        if ($PSCmdlet.ShouldProcess($id, "Delete Authentication Method")) {

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

            If ($null -ne $result) {

                $result

            }

        }

    }#process

    END { }#end

}