Get-VPASAuthenticationMethods


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GET AUTHENTICATION METHODS


Description:

USE THIS FUNCTION TO GET ALL THE AUTHENTICATION METHODS INTO CYBERARK


Syntax:

Get-VPASAuthenticationMethods [-token <Hashtable>] [<CommonParameters>]

Get-VPASAuthenticationMethods -InputParameters <Hashtable> [-token <Hashtable>] [<CommonParameters>]


Parameters:

-InputParameters <Hashtable>
HashTable of values containing the parameters required to make the API call

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-token <Hashtable>
HashTable of data containing various pieces of login information (PVWA, LoginToken, HeaderType, etc).
If -token is not passed, function will use last known hashtable generated by New-VPASToken

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug
ErrorAction, ErrorVariable, WarningAction, WarningVariable
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216)


Examples:

$AuthenticationMethodsJSON = Get-VPASAuthenticationMethods

$InputParameters = @{}
$AuthenticationMethodsJSON = Get-VPASAuthenticationMethods -InputParameters $InputParameters


Outputs:

If successful:
{
         "Methods": [
                 ...
                 {
                         "id": "cyberark",
                         "displayName": "",
                         "enabled": true,
                         "logoffUrl": "",
                         "secondFactorAuth": "cyberark",
                         "signInLabel": "",
                         "usernameFieldLabel": "",
                         "passwordFieldLabel": ""
                 },
                 {
                         "id": "radius",
                         "displayName": "",
                         "enabled": false,
                         "logoffUrl": "",
                         "secondFactorAuth": "radius",
                         "signInLabel": "",
                         "usernameFieldLabel": "",
                         "passwordFieldLabel": ""
                 },
                 {
                         "id": "ldap",
                         "displayName": "",
                         "enabled": true,
                         "logoffUrl": "",
                         "secondFactorAuth": null,
                         "signInLabel": "",
                         "usernameFieldLabel": "",
                         "passwordFieldLabel": ""
                 },
                 ...
         ]
}

$false if failed