CognitoIdentityProvider / Client / list_web_authn_credentials

list_web_authn_credentials#

CognitoIdentityProvider.Client.list_web_authn_credentials(**kwargs)#

Generates a list of the current user’s registered passkey, or webauthN, credentials.

See also: AWS API Documentation

Request Syntax

response = client.list_web_authn_credentials(
    AccessToken='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • AccessToken (string) –

    [REQUIRED]

    A valid access token that Amazon Cognito issued to the user whose registered passkeys you want to list.

  • NextToken (string) – An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

  • MaxResults (integer) – The maximum number of the user’s passkey credentials that you want to return.

Return type:

dict

Returns:

Response Syntax

{
    'Credentials': [
        {
            'CredentialId': 'string',
            'FriendlyCredentialName': 'string',
            'RelyingPartyId': 'string',
            'AuthenticatorAttachment': 'string',
            'AuthenticatorTransports': [
                'string',
            ],
            'CreatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Credentials (list) –

      A list of registered passkeys for a user.

      • (dict) –

        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.

        • CredentialId (string) –

          The unique identifier of the passkey credential.

        • FriendlyCredentialName (string) –

          An automatically-generated friendly name for the passkey credential.

        • RelyingPartyId (string) –

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

        • AuthenticatorAttachment (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.

        • AuthenticatorTransports (list) –

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

          • (string) –

        • CreatedAt (datetime) –

          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.

    • NextToken (string) –

      An identifier that you can use in a later request to return the next set of items in the list.

Exceptions