Windows.Security.Authentication.Identity.Provider Windows.Security.Authentication.Identity.Provider Windows.Security.Authentication.Identity.Provider Windows.Security.Authentication.Identity.Provider Namespace

Supports unlocking Windows 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.

Classes

SecondaryAuthenticationFactorAuthentication SecondaryAuthenticationFactorAuthentication SecondaryAuthenticationFactorAuthentication SecondaryAuthenticationFactorAuthentication

Contains core methods for authenticating 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.

SecondaryAuthenticationFactorAuthenticationResult SecondaryAuthenticationFactorAuthenticationResult SecondaryAuthenticationFactorAuthenticationResult SecondaryAuthenticationFactorAuthenticationResult

Represents the results of 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.

SecondaryAuthenticationFactorAuthenticationStageChangedEventArgs SecondaryAuthenticationFactorAuthenticationStageChangedEventArgs SecondaryAuthenticationFactorAuthenticationStageChangedEventArgs SecondaryAuthenticationFactorAuthenticationStageChangedEventArgs

Provides information about the SecondaryAuthenticationFactorAuthenticationStageChanged event.

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.

SecondaryAuthenticationFactorAuthenticationStageInfo SecondaryAuthenticationFactorAuthenticationStageInfo SecondaryAuthenticationFactorAuthenticationStageInfo SecondaryAuthenticationFactorAuthenticationStageInfo

Provides information about the stage of a companion device authentication.

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.

SecondaryAuthenticationFactorInfo SecondaryAuthenticationFactorInfo SecondaryAuthenticationFactorInfo SecondaryAuthenticationFactorInfo

Contains properties that provide information about 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.

SecondaryAuthenticationFactorRegistration SecondaryAuthenticationFactorRegistration SecondaryAuthenticationFactorRegistration SecondaryAuthenticationFactorRegistration

Contains methods for registering companion devices.

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.

SecondaryAuthenticationFactorRegistrationResult SecondaryAuthenticationFactorRegistrationResult SecondaryAuthenticationFactorRegistrationResult SecondaryAuthenticationFactorRegistrationResult

Provides information about the result of a companion device registration.

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.

Enums

SecondaryAuthenticationFactorAuthenticationMessage SecondaryAuthenticationFactorAuthenticationMessage SecondaryAuthenticationFactorAuthenticationMessage SecondaryAuthenticationFactorAuthenticationMessage

Represents standard error messages.

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.

SecondaryAuthenticationFactorAuthenticationScenario SecondaryAuthenticationFactorAuthenticationScenario SecondaryAuthenticationFactorAuthenticationScenario SecondaryAuthenticationFactorAuthenticationScenario

Represents the authentication scenario.

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.

SecondaryAuthenticationFactorAuthenticationStage SecondaryAuthenticationFactorAuthenticationStage SecondaryAuthenticationFactorAuthenticationStage SecondaryAuthenticationFactorAuthenticationStage

Gets the stage of the companion device authentication.

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.

SecondaryAuthenticationFactorAuthenticationStatus SecondaryAuthenticationFactorAuthenticationStatus SecondaryAuthenticationFactorAuthenticationStatus SecondaryAuthenticationFactorAuthenticationStatus

Represents the status of an authentication operation using 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.

SecondaryAuthenticationFactorDeviceCapabilities SecondaryAuthenticationFactorDeviceCapabilities SecondaryAuthenticationFactorDeviceCapabilities SecondaryAuthenticationFactorDeviceCapabilities

Represents the capabilities of the 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.

SecondaryAuthenticationFactorDeviceFindScope SecondaryAuthenticationFactorDeviceFindScope SecondaryAuthenticationFactorDeviceFindScope SecondaryAuthenticationFactorDeviceFindScope

Represents the search scope when finding companion devices.

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.

SecondaryAuthenticationFactorDevicePresence SecondaryAuthenticationFactorDevicePresence SecondaryAuthenticationFactorDevicePresence SecondaryAuthenticationFactorDevicePresence

Contains values that describe the presence of a companion device (such as a wearable 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.

SecondaryAuthenticationFactorDevicePresenceMonitoringMode SecondaryAuthenticationFactorDevicePresenceMonitoringMode SecondaryAuthenticationFactorDevicePresenceMonitoringMode SecondaryAuthenticationFactorDevicePresenceMonitoringMode

Contains values that describe the type of connection that the system uses to monitor the presence of a companion device (such as a wearable 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.

SecondaryAuthenticationFactorDevicePresenceMonitoringRegistrationStatus SecondaryAuthenticationFactorDevicePresenceMonitoringRegistrationStatus SecondaryAuthenticationFactorDevicePresenceMonitoringRegistrationStatus SecondaryAuthenticationFactorDevicePresenceMonitoringRegistrationStatus

Contains values that describe the status of the registration of a companion device for presence monitoring.

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.

SecondaryAuthenticationFactorFinishAuthenticationStatus SecondaryAuthenticationFactorFinishAuthenticationStatus SecondaryAuthenticationFactorFinishAuthenticationStatus SecondaryAuthenticationFactorFinishAuthenticationStatus

Represents the status of finishing 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.

SecondaryAuthenticationFactorRegistrationStatus SecondaryAuthenticationFactorRegistrationStatus SecondaryAuthenticationFactorRegistrationStatus SecondaryAuthenticationFactorRegistrationStatus

Represents the status of a companion device registration.

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.

Remarks

A companion device is a device that cannot act as a standalone authenticator but can function as a companion to an authenticator for better user experience. The companion device must have a corresponding UWP app that can receive authentication information from the device (such as biometric info) and pass it on to the main device through the APIs in this namespace.