GetUser - Amazon Cognito Identity Provider
AWS services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with AWS services in China.


Gets the user attributes and metadata for a user.

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.


The access token returned by the server response to get information about the user.

Type: String

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

Required: Yes

Response Syntax

{ "MFAOptions": [ { "AttributeName": "string", "DeliveryMedium": "string" } ], "PreferredMfaSetting": "string", "UserAttributes": [ { "Name": "string", "Value": "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.


This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about TOTP software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

Type: Array of MFAOptionType objects


The user's preferred MFA setting.

Type: String


An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Type: Array of AttributeType objects


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

Type: Array of strings


The user name of the user you wish to retrieve from the get user request.

Type: String

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

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


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


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

HTTP Status Code: 500


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

HTTP Status Code: 400


This exception is thrown when a user is not authorized.

HTTP Status Code: 400


This exception is thrown when a password reset is required.

HTTP Status Code: 400


This exception is thrown when the Amazon Cognito service cannot find the requested resource.

HTTP Status Code: 400


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

HTTP Status Code: 400


This exception is thrown when a user is not confirmed successfully.

HTTP Status Code: 400


This exception is thrown when a user is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: