Lists the authentication options for a user in a user pool¶

Description¶

Lists the authentication options for a user in a user pool. Returns the following:

1. The user's multi-factor authentication (MFA) preferences.
2. The user's options for choice-based authentication with the USER_AUTH flow.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests
• Using the Amazon Cognito user pools API and user pool endpoints

Usage¶

cognitoidentityprovider_admin_get_user_auth_factors(UserPoolId,
  Username)

Arguments¶

• UserPoolId

[required] The ID of the user pool where you want to get information about the user's authentication factors.

• Username

[required] The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Value¶

A list with the following syntax:

list(
  Username = "string",
  PreferredMfaSetting = "string",
  UserMFASettingList = list(
    "string"
  ),
  ConfiguredUserAuthFactors = list(
    "PASSWORD"|"EMAIL_OTP"|"SMS_OTP"|"WEB_AUTHN"|"SOFTWARE_TOKEN"
  )
)

Request syntax¶

svc$admin_get_user_auth_factors(
  UserPoolId = "string",
  Username = "string"
)