Skip to content

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:

  1. The user's multi-factor authentication (MFA) preferences.

  2. The user's options in the USER_AUTH flow that they can select in a SELECT_CHALLENGE response or request in a PREFERRED_CHALLENGErequest.

Usage

cognitoidentityprovider_get_user_auth_factors(AccessToken)

Arguments

AccessToken

[required] A valid access token that Amazon Cognito issued to the user whose authentication factors you want to view.

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"
)