com.yubico.webauthn.data

Enum UserVerificationRequirement

java.lang.Object

java.lang.Enum<UserVerificationRequirement>

com.yubico.webauthn.data.UserVerificationRequirement

All Implemented Interfaces:

com.yubico.internal.util.json.JsonStringSerializable, java.io.Serializable, java.lang.Comparable<UserVerificationRequirement>

public enum UserVerificationRequirement
extends java.lang.Enum<UserVerificationRequirement>
implements com.yubico.internal.util.json.JsonStringSerializable

A WebAuthn Relying Party may require user verification for some of its operations but not for others, and may use this type to express its needs.

See Also:

§5.10.6. User Verification Requirement Enumeration (enum UserVerificationRequirement)

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISCOURAGED This value indicates that the Relying Party does not want user verification employed during the operation (e.g., in the interest of minimizing disruption to the user interaction flow).
PREFERRED This value indicates that the Relying Party prefers user verification for the operation if possible, but will not fail the operation if the response does not have the AuthenticatorDataFlags.UV flag set.
REQUIRED Indicates that the Relying Party requires user verification for the operation and will fail the operation if the response does not have the AuthenticatorDataFlags.UV flag set.

Method Summary

Modifier and Type	Method and Description
java.lang.String	toJsonString()
static UserVerificationRequirement	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static UserVerificationRequirement[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DISCOURAGED

public static final UserVerificationRequirement DISCOURAGED

This value indicates that the Relying Party does not want user verification employed during the operation (e.g., in the interest of minimizing disruption to the user interaction flow).

PREFERRED

public static final UserVerificationRequirement PREFERRED

This value indicates that the Relying Party prefers user verification for the operation if possible, but will not fail the operation if the response does not have the AuthenticatorDataFlags.UV flag set.

REQUIRED

public static final UserVerificationRequirement REQUIRED

Indicates that the Relying Party requires user verification for the operation and will fail the operation if the response does not have the AuthenticatorDataFlags.UV flag set.

Method Detail

values

public static UserVerificationRequirement[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (UserVerificationRequirement c : UserVerificationRequirement.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static UserVerificationRequirement valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toJsonString

public java.lang.String toJsonString()

Specified by:

toJsonString in interface com.yubico.internal.util.json.JsonStringSerializable