Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

GetUserAuthFactors

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.

The list of options in the response to this query are eligible RespondToAuthChallenge:ChallengeName selections for PREFERRED_CHALLENGE and are returned in InitiateAuth:AvailableChallenges when you don't request a PREFERRED_CHALLENGE. The InitiateAuth:AuthParameters and RespondToAuthChallenge:ChallengeResponses are specific to each challenge.

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

Note

Amazon Cognito doesn't evaluate AWS 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.

Request Syntax


{
   "AccessToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AccessToken

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.

Type: String

Pattern: [A-Za-z0-9-_=.]+

Required: Yes

Response Syntax


{
   "ConfiguredUserAuthFactors": [ "string" ],
   "PreferredMfaSetting": "string",
   "UserMFASettingList": [ "string" ],
   "Username": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ConfiguredUserAuthFactors

The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 8 items.

Valid Values: PASSWORD | EMAIL_OTP | SMS_OTP | WEB_AUTHN

PreferredMfaSetting

The challenge method that Amazon Cognito returns to the user in response to sign-in requests. Users can prefer SMS message, email message, or TOTP MFA.

Change preferred MFA methods for a user with SetUserMFAPreference or AdminSetUserMFAPreference.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 131072.

UserMFASettingList

The MFA options that are activated for the user. The possible values in this list are SMS_MFA, EMAIL_OTP, and SOFTWARE_TOKEN_MFA.

SMS and email message MFA are always available to users when your user pool is configured with CreateUserPool:SmsConfiguration or CreateUserPool:EmailConfiguration in DEVELOPER mode, respectively. Whether Amazon Cognito presents an MFA challenge and the format of the challenge are set by the PreferredMfa boolean of SetUserMFAPreference.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 131072.

Username

The name of the user who is eligible for the authentication factors in the response.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Errors

For information about the errors that are common to all actions, see Common Errors.

ForbiddenException

This exception is thrown when AWS WAF doesn't allow your request based on a web ACL that's associated with your user pool.

HTTP Status Code: 400

InternalErrorException

This exception is thrown when Amazon Cognito encounters an internal error.

HTTP Status Code: 500

InvalidParameterException

This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

HTTP Status Code: 400

NotAuthorizedException

This exception is thrown when a user isn't authorized.

HTTP Status Code: 400

PasswordResetRequiredException

This exception is thrown when a password reset is required.

HTTP Status Code: 400

ResourceNotFoundException

This exception is thrown when the Amazon Cognito service can't find the requested resource.

HTTP Status Code: 400

TooManyRequestsException

This exception is thrown when the user has made too many requests for a given operation.

HTTP Status Code: 400

UserNotConfirmedException

This exception is thrown when a user isn't confirmed successfully.

HTTP Status Code: 400

UserNotFoundException

This exception is thrown when a user isn't found.

HTTP Status Code: 400

Examples

Example

The following example request returns the sign-in factors for the current user. They don't have MFA set up.

Sample Request


POST HTTP/1.1
Host: cognito-idp.us-west-2.amazonaws.com
X-Amz-Date: 20230613T200059Z
Accept-Encoding: gzip, deflate, br
X-Amz-Target: AWSCognitoIdentityProviderService.GetUserAuthFactors
User-Agent: <UserAgentString>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
Content-Length: <PayloadSizeBytes>
{
   "AccessToken": "eyJra456defEXAMPLE"
}

Sample Response


HTTP/1.1 200 OK
Date: Tue, 13 Jun 2023 20:00:59 GMT
Content-Type: application/x-amz-json-1.0
Content-Length: <PayloadSizeBytes>
x-amzn-requestid: a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111
Connection: keep-alive
{
    "ConfiguredUserAuthFactors": [
        "PASSWORD",
        "EMAIL_OTP",
        "SMS_OTP",
        "WEB_AUTHN"
    ],
    "Username": "testuser"
}