Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class WebAuthnCredentialDescription

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.WebAuthnCredentialDescription

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WebAuthnCredentialDescription.Builder,WebAuthnCredentialDescription>

@Generated("software.amazon.awssdk:codegen")
public final class WebAuthnCredentialDescription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WebAuthnCredentialDescription.Builder,WebAuthnCredentialDescription>

The details of a passkey, or webauthN, biometric or security-key authentication factor for a user.

This data type is a response parameter of ListWebAuthnCredentials.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WebAuthnCredentialDescription.Builder

Method Summary

Modifier and Type	Method	Description
String	authenticatorAttachment()	The general category of the passkey authenticator.
List<String>	authenticatorTransports()	Information about the transport methods of the passkey credential, for example USB or Bluetooth Low Energy.
static WebAuthnCredentialDescription.Builder	builder()
Instant	createdAt()	The date and time when the item was created.
String	credentialId()	The unique identifier of the passkey credential.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	friendlyCredentialName()	An automatically-generated friendly name for the passkey credential.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAuthenticatorTransports()	For responses, this returns true if the service returned a value for the AuthenticatorTransports property.
int	hashCode()
String	relyingPartyId()	The relying-party ID of the provider for the passkey credential.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends WebAuthnCredentialDescription.Builder>	serializableBuilderClass()
WebAuthnCredentialDescription.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

credentialId

public final String credentialId()

The unique identifier of the passkey credential.

Returns:

The unique identifier of the passkey credential.

friendlyCredentialName

public final String friendlyCredentialName()

An automatically-generated friendly name for the passkey credential.

Returns:

An automatically-generated friendly name for the passkey credential.

relyingPartyId

public final String relyingPartyId()

The relying-party ID of the provider for the passkey credential.

Returns:

The relying-party ID of the provider for the passkey credential.

authenticatorAttachment

public final String authenticatorAttachment()

The general category of the passkey authenticator. Can be a platform, or on-device authenticator like a built-in fingerprint scanner, or a cross-platform device that's not attached to the device like a Bluetooth security key.

Returns:

The general category of the passkey authenticator. Can be a platform, or on-device authenticator like a built-in fingerprint scanner, or a cross-platform device that's not attached to the device like a Bluetooth security key.

hasAuthenticatorTransports

public final boolean hasAuthenticatorTransports()

For responses, this returns true if the service returned a value for the AuthenticatorTransports property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

authenticatorTransports

public final List<String> authenticatorTransports()

Information about the transport methods of the passkey credential, for example USB or Bluetooth Low Energy.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAuthenticatorTransports() method.

Returns:

Information about the transport methods of the passkey credential, for example USB or Bluetooth Low Energy.

createdAt

public final Instant createdAt()

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

Returns:

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

toBuilder

public WebAuthnCredentialDescription.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WebAuthnCredentialDescription.Builder,WebAuthnCredentialDescription>

builder

public static WebAuthnCredentialDescription.Builder builder()

serializableBuilderClass

public static Class<? extends WebAuthnCredentialDescription.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo