UserConsentVerificationResult enumeration

Applies to Windows only

Describes the result of a biometric (fingerprint) verification operation.

Syntax


var value = Windows.Security.Credentials.UI.UserConsentVerificationResult.verified;

Attributes

[Version(0x06030000)]

Members

The UserConsentVerificationResult enumeration has these members.

MemberValueDescription
Verified | verified0

The fingerprint was verified.

DeviceNotPresent | deviceNotPresent1

There is no biometric verifier device available.

NotConfiguredForUser | notConfiguredForUser2

A biometric verifier device is not configured for this user.

DisabledByPolicy | disabledByPolicy3

Group policy has disabled the biometric verifier device.

DeviceBusy | deviceBusy4

The biometric verifier device is performing an operation and is unavailable.

RetriesExhausted | retriesExhausted5

After 10 attempts, the original verification request and all subsequent attempts at the same verification were not verified.

Canceled | canceled6

The verification operation was canceled.

Remarks

The following example shows a method that requests fingerprint verification and returns a message that describes the result based on the UserConsentVerificationResult value.


function requestConsent(userMessage) {
    if (!userMessage) {
        userMessage = "Please provide fingerprint verification.";
    }

    try {
        // Request the logged on user's consent via fingerprint swipe.
        Windows.Security.Credentials.UI.UserConsentVerifier.requestVerificationAsync(userMessage) 
        .then(
            function (consentResult) { 
                switch (consentResult) {
                    case Windows.Security.Credentials.UI.UserConsentVerificationResult.verified:
                        outputDiv.innerHTML = "<br/>Fingerprint verified.";
                        break;
                    case Windows.Security.Credentials.UI.UserConsentVerificationResult.deviceBusy:
                        outputDiv.innerHTML = "<br/>Biometric device is busy.";
                        break;
                    case Windows.Security.Credentials.UI.UserConsentVerificationResult.deviceNotPresent:
                        outputDiv.innerHTML = "<br/>No biometric device found.";
                        break;
                    case Windows.Security.Credentials.UI.UserConsentVerificationResult.disabledByPolicy:
                        outputDiv.innerHTML = "<br/>Biometric verification is disabled by policy.";
                        break;
                    case Windows.Security.Credentials.UI.UserConsentVerificationResult.notConfiguredForUser:
                        outputDiv.innerHTML = "<br/>The user has no fingerprints registered. Please add a fingerprint to the " +
                                        "fingerprint database and try again.";
                        break;
                    case Windows.Security.Credentials.UI.UserConsentVerificationResult.retriesExhausted:
                        outputDiv.innerHTML = "<br/>There have been too many failed attempts. Fingerprint authentication canceled.";
                        break;
                    case Windows.Security.Credentials.UI.UserConsentVerificationResult.canceled:
                        outputDiv.innerHTML = "<br/>Fingerprint authentication canceled.";
                        break;
                    default:
                        outputDiv.innerHTML = "<br/>Fingerprint authentication is currently unavailable.";
                        break;
                }
            });
    }
    catch (ex) {
        outputDiv.innerHTML = "<br/>Fingerprint authentication failed: " + ex.toString();
    }
}


Requirements

Minimum supported client

Windows 8.1

Minimum supported server

Windows Server 2012 R2

Minimum supported phone

None supported

Namespace

Windows.Security.Credentials.UI
Windows::Security::Credentials::UI [C++]

Metadata

Windows.winmd

See also

Fingerprint (biometric) authentication
UserConsentVerifier sample
RequestVerificationAsync
UserConsentVerifier
Windows.Security.Credentials.UI
Authentication and User Identity

 

 

Show:
© 2014 Microsoft