List Web Authn Credentials

cognitoidentityprovider_list_web_authn_credentials

R Documentation

Generates a list of the currently signed-in user's registered passkey, or WebAuthn, credentials¶

Description¶

Generates a list of the currently signed-in user's registered passkey, or WebAuthn, credentials.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

Usage¶

cognitoidentityprovider_list_web_authn_credentials(AccessToken,
  NextToken, MaxResults)

Arguments¶

AccessToken

[required] A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for aws.cognito.signin.user.admin.

NextToken

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

MaxResults

The maximum number of the user's passkey credentials that you want to return.

Value¶

A list with the following syntax:

list(
  Credentials = list(
    list(
      CredentialId = "string",
      FriendlyCredentialName = "string",
      RelyingPartyId = "string",
      AuthenticatorAttachment = "string",
      AuthenticatorTransports = list(
        "string"
      ),
      CreatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_web_authn_credentials(
  AccessToken = "string",
  NextToken = "string",
  MaxResults = 123
)