Skip to content

Admin List User Auth Events

cognitoidentityprovider_admin_list_user_auth_events R Documentation

A history of user activity and any risks detected as part of Amazon Cognito advanced security

Description

A history of user activity and any risks detected as part of Amazon Cognito advanced security.

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

Usage

cognitoidentityprovider_admin_list_user_auth_events(UserPoolId,
  Username, MaxResults, NextToken)

Arguments

UserPoolId

[required] The user pool ID.

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.

MaxResults

The maximum number of authentication events to return. Returns 60 events if you set MaxResults to 0, or if you don't include a MaxResults parameter.

NextToken

A pagination token.

Value

A list with the following syntax: 

list(
  AuthEvents = list(
    list(
      EventId = "string",
      EventType = "SignIn"|"SignUp"|"ForgotPassword"|"PasswordChange"|"ResendCode",
      CreationDate = as.POSIXct(
        "2015-01-01"
      ),
      EventResponse = "Pass"|"Fail"|"InProgress",
      EventRisk = list(
        RiskDecision = "NoRisk"|"AccountTakeover"|"Block",
        RiskLevel = "Low"|"Medium"|"High",
        CompromisedCredentialsDetected = TRUE|FALSE
      ),
      ChallengeResponses = list(
        list(
          ChallengeName = "Password"|"Mfa",
          ChallengeResponse = "Success"|"Failure"
        )
      ),
      EventContextData = list(
        IpAddress = "string",
        DeviceName = "string",
        Timezone = "string",
        City = "string",
        Country = "string"
      ),
      EventFeedback = list(
        FeedbackValue = "Valid"|"Invalid",
        Provider = "string",
        FeedbackDate = as.POSIXct(
          "2015-01-01"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$admin_list_user_auth_events(
  UserPoolId = "string",
  Username = "string",
  MaxResults = 123,
  NextToken = "string"
)