Add-VPASApplicationAuthentication


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

ADD APPLICATION ID AUTHENTICATION METHOD


Description:

USE THIS FUNCTION TO ADD AN AUTHENTICATION METHOD TO AN EXISTING APPLICATION ID


Syntax:

Add-VPASApplicationAuthentication [-AppID] <String> [-AuthType] <String> [-AuthValue] <String> [[-IsFolder]] [[-AllowInternalScripts]] [[-token] <Hashtable>] [<CommonParameters>]


Parameters:

-AppID <String>
Unique ApplicationID (or Application Name) that will be used by the credential provider(s) to retrieve credentials

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

-AuthType <String>
Define the type of the target authentication
Possible values: Path, Hash, OSUser, machineAddress, certificateSerialNumber

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

-AuthValue <String>
Value to be added to the target AppID

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

-IsFolder [<SwitchParameter>]
Define if the AuthValue is a folder if using an authentication type: path

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

-AllowInternalScripts [<SwitchParameter>]
Define if internal scripts have permission to pull credentials if using an authentication type: path

Required: false
Position: 5
Default value: False
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: 6
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:

$AddApplicationAuthenticationStatus = Add-VPASApplicationAuthentication -AppID {APPID VALUE} -AuthType {AUTHTYPE VALUE} -AuthValue {AUTHVALUE VALUE}


Outputs:

$true if successful

$false if failed