Get User

cognitoidentityprovider_get_user

R Documentation

Gets the user attributes and metadata for a user

Description

Gets the user attributes and metadata for a user.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Amazon Cognito doesn't evaluate 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.

Usage

cognitoidentityprovider_get_user(AccessToken)

Arguments

AccessToken

[required] A non-expired access token for the user whose information you want to query.

Value

A list with the following syntax:

list(
  Username = "string",
  UserAttributes = list(
    list(
      Name = "string",
      Value = "string"
    )
  ),
  MFAOptions = list(
    list(
      DeliveryMedium = "SMS"|"EMAIL",
      AttributeName = "string"
    )
  ),
  PreferredMfaSetting = "string",
  UserMFASettingList = list(
    "string"
  )
)

Request syntax

svc$get_user(
  AccessToken = "string"
)