SecondaryAuthenticationFactorAuthentication.StartAuthenticationAsync Method

Definition

Namespace:

Windows.Security.Authentication.Identity.Provider

Start an authentication with a companion device.

Note

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft to use the secondaryAuthenticationFactor capability, calls to this API will fail. To apply for approval, contact cdfonboard@microsoft.com. For more information on capabilities, see App capability declarations. For an overview of the Companion Device Framework, see the Windows Unlock with companion (IoT) devices overview.

public:
 static IAsyncOperation<SecondaryAuthenticationFactorAuthenticationResult ^> ^ StartAuthenticationAsync(Platform::String ^ deviceId, IBuffer ^ serviceAuthenticationNonce);

/// [Windows.Foundation.Metadata.RemoteAsync]
/// [Windows.Foundation.Metadata.Deprecated("SecondaryAuthenticationFactorAuthentication is deprecated and might not work on all platforms. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 655360, "Windows.Foundation.UniversalApiContract")]
 static IAsyncOperation<SecondaryAuthenticationFactorAuthenticationResult> StartAuthenticationAsync(winrt::hstring const& deviceId, IBuffer const& serviceAuthenticationNonce);

[Windows.Foundation.Metadata.RemoteAsync]
[Windows.Foundation.Metadata.Deprecated("SecondaryAuthenticationFactorAuthentication is deprecated and might not work on all platforms. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 655360, "Windows.Foundation.UniversalApiContract")]
public static IAsyncOperation<SecondaryAuthenticationFactorAuthenticationResult> StartAuthenticationAsync(string deviceId, IBuffer serviceAuthenticationNonce);

function startAuthenticationAsync(deviceId, serviceAuthenticationNonce)

Public Shared Function StartAuthenticationAsync (deviceId As String, serviceAuthenticationNonce As IBuffer) As IAsyncOperation(Of SecondaryAuthenticationFactorAuthenticationResult)

Parameters

deviceId

String

Platform::String

winrt::hstring

The Id of the device to authenticate with.

serviceAuthenticationNonce

IBuffer

The service authentication nonce.

Returns

IAsyncOperation<SecondaryAuthenticationFactorAuthenticationResult>

When this method completes, it returns the results of the authentication.

Attributes

RemoteAsyncAttribute DeprecatedAttribute

See also

• Windows Unlock with companion (IoT) devices