/ - Amazon Cognito Identity Provider

Gets the user attributes and metadata for a user.

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

Represents the request to get information about the user.

AccessToken

string <password>

required

A non-expired access token for the user whose information you want to query.

Match pattern:

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

Examples

Responses

🟢200Success

application/json

Body

Represents the response from the server from the request to get information about the user.

Username

string <password>

required

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

>= 1 characters<= 128 characters

Match pattern:

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

UserAttributes

array[object (AttributeType) {2}]

required

An array of name-value pairs representing user attributes.

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

Name

string

required

The name of the attribute.

>= 1 characters<= 32 characters

Match pattern:

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

Value

string <password>

optional

The value of the attribute.

<= 2048 characters

MFAOptions

array[object (MFAOptionType) {2}]

optional

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

DeliveryMedium

enum<string>

optional

The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

Allowed values:

SMSEMAIL

AttributeName

string

optional

The attribute name of the MFA option type. The only valid value is phone_number.

>= 1 characters<= 32 characters

Match pattern:

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

PreferredMfaSetting

string

optional

The user's preferred MFA setting.

UserMFASettingList

array[string]

optional

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

🟠480ResourceNotFoundException

🟠481InvalidParameterException

🟠482NotAuthorizedException

🟠483TooManyRequestsException

🟠484PasswordResetRequiredException

🟠485UserNotFoundException

🟠486UserNotConfirmedException

🟠487InternalErrorException

🟠488ForbiddenException