Package io.hanko.sdk.webauthn.protocol

Enum Class UserVerificationRequirement

java.lang.Object

java.lang.Enum<UserVerificationRequirement>

io.hanko.sdk.webauthn.protocol.UserVerificationRequirement

All Implemented Interfaces:

Serializable, Comparable<UserVerificationRequirement>, Constable

public enum UserVerificationRequirement
extends Enum<UserVerificationRequirement>

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:

Web Authentication Level 1 - 5.10.6. User Verification Requirement Enumeration

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	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 UV flag set.
REQUIRED	This value indicates that the Relying Party requires user verification for the operation and will fail the operation if the response does not have the UV flag set.

Method Summary

Modifier and Type	Method	Description
static UserVerificationRequirement	fromValue(String value)	Construct a UserVerificationRequirement from a String value.
String	getUserVerification()	Return the userVerification value of the constant.
static UserVerificationRequirement	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UserVerificationRequirement[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REQUIRED

public static final UserVerificationRequirement REQUIRED

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

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 UV flag set.

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).

Method Details

values

public static UserVerificationRequirement[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static UserVerificationRequirement valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

fromValue

public static UserVerificationRequirement fromValue(String value)

Construct a UserVerificationRequirement from a String value. Used for JSON deserialization.

Parameters:

value - the String value

Returns:

the UserVerificationRequirement

getUserVerification

public String getUserVerification()

Return the userVerification value of the constant.

Returns:

the userVerification value