Remove-VPASApplicationAuthentication


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

DELETE APPLICATION ID AUTHENTICATION METHOD


Description:

USE THIS FUNCTION TO DELETE AN EXISTING APPLICATION AUTHENTICATION METHOD


Syntax:

Remove-VPASApplicationAuthentication -AppID <String> -AuthType <String> -AuthValue <String> [-WhatIf] [-HideWhatIfOutput] [-token <Hashtable>] [<CommonParameters>]

Remove-VPASApplicationAuthentication -AppID <String> -AuthID <String> [-WhatIf] [-HideWhatIfOutput] [-token <Hashtable>] [<CommonParameters>]

Remove-VPASApplicationAuthentication -InputParameters <Hashtable> [-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: named
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: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-AuthValue <String>
Value to be removed from the target AppID

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

-AuthID <String>
Unique ID that maps to the target application authentication
Supply the AuthID to skip any querying for target application authentication

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

-WhatIf [<SwitchParameter>]
Run code simulation to see what is affected by running the command as well as any possible implications
This is a code simulation flag, meaning the command will NOT actually run

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

-HideWhatIfOutput [<SwitchParameter>]
Suppress any code simulation output from the console

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

-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:

$WhatIfSimulation = Remove-VPASApplicationAuthentication -AppID {APPID VALUE} -AuthType path -AuthValue {AUTHVALUE VALUE} -WhatIf

$DeleteApplicationAuthenticationStatus = Remove-VPASApplicationAuthentication -AppID {APPID VALUE} -AuthType path -AuthValue {AUTHVALUE VALUE}

$DeleteApplicationAuthenticationStatus = Remove-VPASApplicationAuthentication -AppID {APPID VALUE} -AuthType hash -AuthValue {AUTHVALUE VALUE}

$DeleteApplicationAuthenticationStatus = Remove-VPASApplicationAuthentication -AppID {APPID VALUE} -AuthType osuser -AuthValue {AUTHVALUE VALUE}

$DeleteApplicationAuthenticationStatus = Remove-VPASApplicationAuthentication -AppID {APPID VALUE} -AuthType machineaddress -AuthValue {AUTHVALUE VALUE}

$DeleteApplicationAuthenticationStatus = Remove-VPASApplicationAuthentication -AppID {APPID VALUE} -AuthType certificateserialnumber -AuthValue {AUTHVALUE VALUE}

$InputParameters = @{
        AppID = "VpasApplicationID"
         AuthType = "path"|"hash"|"osuser"|"machineaddress"|"certificateserialnumber"
         AuthValue = "1.2.3.4"
        WhatIf = $true|$false
        HideOutput = $true|$false
}
$DeleteApplicationAuthenticationStatus = Remove-VPASApplicationAuthentication -InputParameters $InputParameters

$InputParameters = @{
        AppID = "VpasApplicationID"
         AuthID = "3"
        WhatIf = $true|$false
        HideOutput = $true|$false
}
$DeleteApplicationAuthenticationStatus = Remove-VPASApplicationAuthentication -InputParameters $InputParameters


Outputs:

$true if successful

$false if failed