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.

See Also:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<WebAuthnCredentialDescription.Builder,WebAuthnCredentialDescription>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.