Get-VPASSpecificAuthenticationMethod


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GET SPECIFIC AUTHENTICATION METHOD


Description:

USE THIS FUNCTION TO GET SPECIFIC AUTHENTICATION METHOD INTO CYBERARK


Syntax:

Get-VPASSpecificAuthenticationMethod [[-AuthMethodSearch] <String>] [[-AuthMethodID] <String>] [[-token] <Hashtable>] [<CommonParameters>]


Parameters:

-AuthMethodSearch <String>
Search string to find the target AuthenticationMethod

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

-AuthMethodID <String>
Unique ID that maps to the target AuthenticationMethod
Supply AuthMethodID to skip any querying for target AuthenticationMethod

Required: false
Position: 2
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: 3
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:

$AuthenticationMethodJSON = Get-VPASSpecificAuthenticationMethod -AuthMethodSearch {SEARCH QUERY VALUE}

$AuthenticationMethodJSON = Get-VPASSpecificAuthenticationMethod -AuthMethodID {AUTH METHOD ID VALUE}


Outputs:

If successful:
{
         "id": "radius",
         "displayName": "vpasradius",
         "enabled": false,
         "logoffUrl": "",
         "secondFactorAuth": null,
         "signInLabel": "",
         "usernameFieldLabel": "NewUserbox",
         "passwordFieldLabel": "NewPassbox"
}

$false if failed