paws.security.identity (version 0.1.11)

cognitoidentityprovider_admin_get_user: 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.

Calling this action requires developer credentials.

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 user name of the user you wish to retrieve.

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",
  MFAOptions = list(
    list(
      DeliveryMedium = "SMS"|"EMAIL",
      AttributeName = "string"
    )
  ),
  PreferredMfaSetting = "string",
  UserMFASettingList = list(
    "string"
  )
)

Request syntax

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