Amazon Cognito Identity Provider
  1. Root
Amazon Cognito Identity Provider
  • Root
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
  1. Root

/

POST
/
Gets the specified user by user name in a user pool as an administrator. Works on any user.
Calling this action requires developer credentials.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "UserPoolId": "string",
    "Username": "string"
}'
Response Response Example
200 - Example 1
{
    "Username": "string",
    "UserAttributes": [],
    "UserCreateDate": "string",
    "UserLastModifiedDate": "string",
    "Enabled": true,
    "UserStatus": "UNCONFIRMED",
    "MFAOptions": [],
    "PreferredMfaSetting": "string",
    "UserMFASettingList": []
}

Request

Header Params
X-Amz-Target
string 
required
Body Params application/json
Represents the request to get the specified user as an administrator.
UserPoolId
string 
required
The user pool ID for the user pool where you want to get information about the user.
>= 1 characters<= 55 characters
Match pattern:
[\w-]+_[0-9a-zA-Z]+
Username
string <password>
required
The user name of the user you want to retrieve.
>= 1 characters<= 128 characters
Match pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+
Examples

Responses

🟢200Success
application/json
Body
Represents the response from the server from the request to get the specified user as an administrator.
Username
string <password>
required
The user name of the user about whom you're receiving information.
>= 1 characters<= 128 characters
Match pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+
UserAttributes
array[object (AttributeType) {2}] 
optional
An array of name-value pairs representing user attributes.
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
UserCreateDate
string <date-time>
optional
The date the user was created.
UserLastModifiedDate
string <date-time>
optional
The date the user was last modified.
Enabled
boolean 
optional
Indicates that the status is enabled.
UserStatus
enum<string> 
optional
The user status. Can be one of the following:
  • UNCONFIRMED - User has been created but not confirmed.
  • CONFIRMED - User has been confirmed.
  • ARCHIVED - User is no longer active.
  • UNKNOWN - User status isn't known.
  • RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
  • 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.
Allowed values:
UNCONFIRMEDCONFIRMEDARCHIVEDCOMPROMISEDUNKNOWNRESET_REQUIREDFORCE_CHANGE_PASSWORD
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
🟠482TooManyRequestsException
🟠483NotAuthorizedException
🟠484UserNotFoundException
🟠485InternalErrorException
Modified at 2023-08-15 07:11:06
Previous
/
Next
/
Built with