Functions/Authentication/Get-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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
Function Get-PASAuthenticationMethod {
    <#
.SYNOPSIS
List authentication methods

.DESCRIPTION
Returns a list of all existing authentication methods.
Membership of Vault admins group required

.PARAMETER ID
The ID of a specific authentication method to return details of

.EXAMPLE
Get-PASAuthenticationMethod

Returns list of all authentication methods.
#>

    [CmdletBinding()]
    param(
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateNotNullOrEmpty()]
        [ValidateLength(1, 50)]
        [string]$ID

    )

    BEGIN {

        Assert-VersionRequirement -RequiredVersion 11.5

    }#begin

    PROCESS {

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

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


        If ($null -ne $result) {

            if ($null -ne $result.Methods) {

                $result = $result | Select-Object -ExpandProperty Methods

            }

            $result

        }

    }#process

    END { }#end


}