Get User Auth Factors

cognitoidentityprovider_get_user_auth_factors

R Documentation

Lists the authentication options for the currently signed-in user¶

Description¶

Lists the authentication options for the currently signed-in user. Returns the following:

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

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_get_user_auth_factors(AccessToken)

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.

Value¶

A list with the following syntax:

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

Request syntax¶

svc$get_user_auth_factors(
  AccessToken = "string"
)