Class: Aws::CognitoIdentityProvider::Types::WebAuthnCredentialDescription

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::WebAuthnCredentialDescription

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

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].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListWebAuthnCredentials.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #authenticator_attachment ⇒ String

  The general category of the passkey authenticator.

• #authenticator_transports ⇒ Array<String>

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

• #created_at ⇒ Time

  The date and time when the item was created.

• #credential_id ⇒ String

  The unique identifier of the passkey credential.

• #friendly_credential_name ⇒ String

  An automatically-generated friendly name for the passkey credential.

• #relying_party_id ⇒ String

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

Instance Attribute Details

#authenticator_attachment ⇒ String

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:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 13322

class WebAuthnCredentialDescription < Struct.new(
  :credential_id,
  :friendly_credential_name,
  :relying_party_id,
  :authenticator_attachment,
  :authenticator_transports,
  :created_at)
  SENSITIVE = []
  include Aws::Structure
end

#authenticator_transports ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 13322

class WebAuthnCredentialDescription < Struct.new(
  :credential_id,
  :friendly_credential_name,
  :relying_party_id,
  :authenticator_attachment,
  :authenticator_transports,
  :created_at)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

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:

• (Time)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 13322

class WebAuthnCredentialDescription < Struct.new(
  :credential_id,
  :friendly_credential_name,
  :relying_party_id,
  :authenticator_attachment,
  :authenticator_transports,
  :created_at)
  SENSITIVE = []
  include Aws::Structure
end

#credential_id ⇒ String

The unique identifier of the passkey credential.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 13322

class WebAuthnCredentialDescription < Struct.new(
  :credential_id,
  :friendly_credential_name,
  :relying_party_id,
  :authenticator_attachment,
  :authenticator_transports,
  :created_at)
  SENSITIVE = []
  include Aws::Structure
end

#friendly_credential_name ⇒ String

An automatically-generated friendly name for the passkey credential.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 13322

class WebAuthnCredentialDescription < Struct.new(
  :credential_id,
  :friendly_credential_name,
  :relying_party_id,
  :authenticator_attachment,
  :authenticator_transports,
  :created_at)
  SENSITIVE = []
  include Aws::Structure
end

#relying_party_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 13322

class WebAuthnCredentialDescription < Struct.new(
  :credential_id,
  :friendly_credential_name,
  :relying_party_id,
  :authenticator_attachment,
  :authenticator_transports,
  :created_at)
  SENSITIVE = []
  include Aws::Structure
end