Package com.yubico.webauthn.data

Enum AuthenticatorAttachment

java.lang.Object

java.lang.Enum<AuthenticatorAttachment>

com.yubico.webauthn.data.AuthenticatorAttachment

All Implemented Interfaces:

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

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

This enumeration’s values describe authenticators' attachment modalities. Relying Parties use this for two purposes:

• to express a preferred authenticator attachment modality when calling navigator.credentials.create() to create a credential, and
• to inform the client of the Relying Party's best belief about how to locate the managing authenticators of the credentials listed in PublicKeyCredentialRequestOptions.getAllowCredentials() when calling navigator.credentials.get().

See Also:

§5.4.5. Authenticator Attachment Enumeration (enum AuthenticatorAttachment)

Enum Constant Summary

Enum Constants

Enum Constant	Description
CROSS_PLATFORM	Indicates cross-platform attachment.
PLATFORM	Indicates platform attachment.

Method Summary

Modifier and Type	Method	Description
java.lang.String	toJsonString()
static AuthenticatorAttachment	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static AuthenticatorAttachment[]	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

CROSS_PLATFORM

public static final AuthenticatorAttachment CROSS_PLATFORM

Indicates cross-platform attachment.

Authenticators of this class are removable from, and can "roam" among, client platforms.

PLATFORM

public static final AuthenticatorAttachment PLATFORM

Indicates platform attachment.

Usually, authenticators of this class are not removable from the platform.

Method Detail

values

public static AuthenticatorAttachment[] 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 (AuthenticatorAttachment c : AuthenticatorAttachment.values())
    System.out.println(c);

Returns:

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

valueOf

public static AuthenticatorAttachment 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