# GetUser Gets user attributes and and MFA settings for the currently signed-in user. 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](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html). ## Request Syntax ``` { "AccessToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AccessToken](#API_GetUser_RequestSyntax) ** 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 ``` { "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. ** [MFAOptions](#API_GetUser_ResponseSyntax) ** *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. Type: Array of [MFAOptionType](API_MFAOptionType.md) objects ** [PreferredMfaSetting](#API_GetUser_ResponseSyntax) ** The user's preferred MFA. Users can prefer SMS message, email message, or TOTP MFA. Type: String Length Constraints: Minimum length of 0. Maximum length of 131072. ** [UserAttributes](#API_GetUser_ResponseSyntax) ** An array of name-value pairs representing user attributes. Custom attributes are prepended with the `custom:` prefix. Type: Array of [AttributeType](API_AttributeType.md) objects ** [UserMFASettingList](#API_GetUser_ResponseSyntax) ** The MFA options that are activated for the user. The possible values in this list are `SMS_MFA`, `EMAIL_OTP`, and `SOFTWARE_TOKEN_MFA`. Type: Array of strings Length Constraints: Minimum length of 0. Maximum length of 131072. ** [Username](#API_GetUser_ResponseSyntax) ** The name of the user that you requested. 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 Error Types](CommonErrors.md). ** 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. ** message ** The message returned 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. ** message ** The message returned when Amazon Cognito throws an internal error exception. HTTP Status Code: 500 ** InvalidParameterException ** This exception is thrown when the Amazon Cognito service encounters an invalid parameter. ** message ** The message returned when the Amazon Cognito service throws an invalid parameter exception. ** reasonCode ** The reason code of the exception. HTTP Status Code: 400 ** NotAuthorizedException ** This exception is thrown when a user isn't authorized. ** message ** The message returned when the Amazon Cognito service returns a not authorized exception. HTTP Status Code: 400 ** PasswordResetRequiredException ** This exception is thrown when a password reset is required. ** message ** The message returned 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. ** message ** The message returned when the Amazon Cognito service returns a resource not found exception. HTTP Status Code: 400 ** TooManyRequestsException ** This exception is thrown when the user has made too many requests for a given operation. ** message ** The message returned when the Amazon Cognito service returns a too many requests exception. HTTP Status Code: 400 ** UserNotConfirmedException ** This exception is thrown when a user isn't confirmed successfully. ** message ** The message returned when a user isn't confirmed successfully. HTTP Status Code: 400 ** UserNotFoundException ** This exception is thrown when a user isn't found. ** message ** The message returned when a user isn't found. HTTP Status Code: 400 ## Examples ### Example The following example request returns the details of the current user. #### 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.GetUser User-Agent: Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature= Content-Length: { "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: x-amzn-requestid: a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111 Connection: keep-alive { "UserAttributes": [ { "Name": "sub", "Value": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, { "Name": "identities", "Value": "[{\"userId\":\"a1b2c3d4-5678-90ab-cdef-EXAMPLE22222\",\"providerName\":\"SignInWithApple\",\"providerType\":\"SignInWithApple\",\"issuer\":null,\"primary\":false,\"dateCreated\":1701125599632}]" }, { "Name": "email_verified", "Value": "true" }, { "Name": "custom:state", "Value": "Maine" }, { "Name": "name", "Value": "John Doe" }, { "Name": "phone_number_verified", "Value": "true" }, { "Name": "phone_number", "Value": "+12065551212" }, { "Name": "preferred_username", "Value": "jamesdoe" }, { "Name": "locale", "Value": "EMEA" }, { "Name": "email", "Value": "jamesdoe@example.com" } ], "Username": "johndoe" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cognito-idp-2016-04-18/GetUser) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cognito-idp-2016-04-18/GetUser) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cognito-idp-2016-04-18/GetUser) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cognito-idp-2016-04-18/GetUser) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-idp-2016-04-18/GetUser) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cognito-idp-2016-04-18/GetUser) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cognito-idp-2016-04-18/GetUser) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cognito-idp-2016-04-18/GetUser) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cognito-idp-2016-04-18/GetUser) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cognito-idp-2016-04-18/GetUser)