Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14101465558.4 KB

Gets the specified user by user name in a user pool as an administrator. Works on any user.

Calling this action requires developer credentials.

post/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminGetUser

Headers

X-Amz-Target'AWSCognitoIdentityProviderService.AdminGetUser' required

Request body

UserPoolIdstring required

The user pool ID for the user pool where you want to get information about the user.

Usernamestring password required

The user name of the user you want to retrieve.

Response

Success

Usernamestring password required

The user name of the user about whom you're receiving information.

UserCreateDatestring date-time

The date the user was created.

UserLastModifiedDatestring date-time

The date the user was last modified.

Enabledboolean

Indicates that the status is <code>enabled</code>.

UserStatus'UNCONFIRMED' | 'CONFIRMED' | 'ARCHIVED' | 'COMPROMISED' | 'UNKNOWN' | 'RESET_REQUIRED' | 'FORCE_CHANGE_PASSWORD'
<p>The user status. Can be one of the following:</p> <ul> <li> <p>UNCONFIRMED - User has been created but not confirmed.</p> </li> <li> <p>CONFIRMED - User has been confirmed.</p> </li> <li> <p>ARCHIVED - User is no longer active.</p> </li> <li> <p>UNKNOWN - User status isn't known.</p> </li> <li> <p>RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.</p> </li> <li> <p>FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else. </p> </li> </ul>
PreferredMfaSettingstring

The user's preferred MFA setting.

UserMFASettingListStringType[]

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