Admin Get User

cognitoidentityprovider_admin_get_user

R Documentation

Gets the specified user by user name in a user pool as an administrator

Description

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

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Usage

cognitoidentityprovider_admin_get_user(UserPoolId, Username)

Arguments

UserPoolId

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

Username

[required] The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Value

A list with the following syntax:

list(
  Username = "string",
  UserAttributes = list(
    list(
      Name = "string",
      Value = "string"
    )
  ),
  UserCreateDate = as.POSIXct(
    "2015-01-01"
  ),
  UserLastModifiedDate = as.POSIXct(
    "2015-01-01"
  ),
  Enabled = TRUE|FALSE,
  UserStatus = "UNCONFIRMED"|"CONFIRMED"|"ARCHIVED"|"COMPROMISED"|"UNKNOWN"|"RESET_REQUIRED"|"FORCE_CHANGE_PASSWORD"|"EXTERNAL_PROVIDER",
  MFAOptions = list(
    list(
      DeliveryMedium = "SMS"|"EMAIL",
      AttributeName = "string"
    )
  ),
  PreferredMfaSetting = "string",
  UserMFASettingList = list(
    "string"
  )
)

Request syntax

svc$admin_get_user(
  UserPoolId = "string",
  Username = "string"
)