Package com.yubico.webauthn.data

Enum Class ResidentKeyRequirement

java.lang.Object

java.lang.Enum<ResidentKeyRequirement>

com.yubico.webauthn.data.ResidentKeyRequirement

All Implemented Interfaces:

Serializable, Comparable<ResidentKeyRequirement>, Constable

public enum ResidentKeyRequirement
extends Enum<ResidentKeyRequirement>

This enumeration's values describe the Relying Party's requirements for client-side discoverable credentials (formerly known as resident credentials or resident keys):

See Also:

• §5.4.6. Resident Key Requirement Enumeration (enum ResidentKeyRequirement)
• Client-side discoverable Credential

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	The client and authenticator will try to create a server-side credential if possible, and a discoverable credential otherwise.
PREFERRED	The client and authenticator will try to create a discoverable credential if possible, and a server-side credential otherwise.
REQUIRED	The client and authenticator will try to create a discoverable credential, and fail the registration if that is not possible.

Method Summary

Modifier and Type	Method	Description
@NonNull String	getValue()
static ResidentKeyRequirement	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ResidentKeyRequirement[]	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

DISCOURAGED

public static final ResidentKeyRequirement DISCOURAGED

The client and authenticator will try to create a server-side credential if possible, and a discoverable credential otherwise.

See Also:

• §5.4.6. Resident Key Requirement Enumeration (enum ResidentKeyRequirement)
• Client-side discoverable Credential
• Server-side Credential

PREFERRED

public static final ResidentKeyRequirement PREFERRED

The client and authenticator will try to create a discoverable credential if possible, and a server-side credential otherwise.

See Also:

• §5.4.6. Resident Key Requirement Enumeration (enum ResidentKeyRequirement)
• Client-side discoverable Credential
• Server-side Credential

REQUIRED

public static final ResidentKeyRequirement REQUIRED

The client and authenticator will try to create a discoverable credential, and fail the registration if that is not possible.

See Also:

• §5.4.6. Resident Key Requirement Enumeration (enum ResidentKeyRequirement)
• Client-side discoverable Credential
• Server-side Credential

Method Details

values

public static ResidentKeyRequirement[] 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 ResidentKeyRequirement 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

getValue

@NonNull
public @NonNull String getValue()