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. To activate this setting, your user pool must be in the Essentials tier or higher.
Contents
- AuthenticatorTransports
-
Information about the transport methods of the passkey credential, for example USB or Bluetooth Low Energy.
Type: Array of strings
Required: Yes
- 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.Type: Timestamp
Required: Yes
- CredentialId
-
The unique identifier of the passkey credential.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 131072.
Required: Yes
- FriendlyCredentialName
-
An automatically-generated friendly name for the passkey credential.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 131072.
Required: Yes
- RelyingPartyId
-
The relying-party ID of the provider for the passkey credential.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 131072.
Required: Yes
- 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.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: