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

Inherited Method Summary

Enum Values

public static final ResidentKeyRequirement RESIDENT_KEY_DISCOURAGED

public static final ResidentKeyRequirement RESIDENT_KEY_PREFERRED

public static final ResidentKeyRequirement RESIDENT_KEY_REQUIRED