ResidentKeyRequirement

public final enum ResidentKeyRequirement extends Enum<ResidentKeyRequirement>
implements Parcelable

An enum that describes the Resident Key (Discoverable Credential) requirements.

According to WebAuthn, this structure describes the Relying Party's requirements for client-side discoverable credentials (formerly known as resident credentials or resident keys):

If the resident key requirement is set to "required", then the Relying Party requires a client-side discoverable credential and is prepared to receive an error if it can't be created. If the resident key requirement is set to "preferred", the Relying party strongly prefers a client-side discoverable credential but will accept a server-side credential. If the resident key requirement is set to "discouraged" then a server-side credential is preferable, but will accept a client-side discoverable credential.

See Resident Key Requirement Enumeration

Nested Class Summary

class

ResidentKeyRequirement.UnsupportedResidentKeyRequirementException

Exception thrown when an unsupported or unrecognized resident key requirement is encountered.

Inherited Constant Summary

From interface android.os.Parcelable

int	CONTENTS_FILE_DESCRIPTOR
int	PARCELABLE_WRITE_RETURN_VALUE

Inherited Method Summary

From class java.lang.Enum

final Object	clone()
final int	compareTo(ResidentKeyRequirement arg0)
int	compareTo(Object arg0)
final Optional<EnumDesc<ResidentKeyRequirement>>	describeConstable()
final boolean	equals(Object arg0)
final void	finalize()
final Class<ResidentKeyRequirement>	getDeclaringClass()
final int	hashCode()
final String	name()
final int	ordinal()
String	toString()
static <T extends Enum<T>> T	valueOf(Class<T> arg0, String arg1)

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

From interface java.lang.constant.Constable

abstract Optional<? extends ConstantDesc>

describeConstable()

From interface java.lang.Comparable

abstract int

compareTo(ResidentKeyRequirement arg0)

From interface android.os.Parcelable

abstract int	describeContents()
abstract void	writeToParcel(Parcel arg0, int arg1)

Enum Values

public static final ResidentKeyRequirement RESIDENT_KEY_DISCOURAGED

public static final ResidentKeyRequirement RESIDENT_KEY_PREFERRED

public static final ResidentKeyRequirement RESIDENT_KEY_REQUIRED