Update-VPASAuthenticationMethod


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

UPDATE AUTHENTICATION METHOD


Description:

USE THIS FUNCTION TO UPDATE AUTHENTICATION METHOD INTO CYBERARK


Syntax:

Update-VPASAuthenticationMethod [[-DisplayName] <String>] [[-Enabled] <String>] [[-MobileEnabled] <String>] [[-LogoffURL] <String>] [[-SecondFactorAuth] <String>] [[-SignInLabel] <String>] [[-UsernameFieldLabel] <String>] [[-PasswordFieldLabel] <String>] [[-AuthMethodSearch] <String>] [[-AuthMethodID] <String>] [[-token] <Hashtable>] [<CommonParameters>]


Parameters:

-DisplayName <String>
Display value of the AuthenticationMethod

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

-Enabled <String>
Specify if the AuthenticationMethod will be enabled
AuthenticationMethod will NOT appear if set to disabled
Possible values: TRUE, FALSE

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

-MobileEnabled <String>
Allow the AuthenticationMethod to be visible on mobile
Possible values: TRUE, FALSE

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

-LogoffURL <String>
Redirect link that EndUsers will funnel through on logoff

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

-SecondFactorAuth <String>
Enable a second factor authentication
Possible values: cyberark, radius, ldap

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

-SignInLabel <String>
Visual title of the AuthenticationMethod
This is what EndUsers will see

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

-UsernameFieldLabel <String>
Visual tag for the Username box
This is what EndUsers will see

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

-PasswordFieldLabel <String>
Visual tag for the Password box
This is what EndUsers will see

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

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

Required: false
Position: 9
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: 10
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: 11
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:

$UpdateAuthenticationMethodJSON = Update-VPASAuthenticationMethod -AuthMethodID {AUTH METHOD ID VALUE} -UsernameFieldLabel {NEW USERNAME FIELD LABEL VALUE}


Outputs:

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

$false if failed