/ - Amazon Cognito Identity Provider

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

curl --location --request POST '/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "UserPoolId": "string", "Username": "string", "MaxResults": 0, "NextToken": "string" }'

Request

Query Params

MaxResults

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

UserPoolId

string

required

The user pool ID.

>= 1 characters<= 55 characters

Match pattern:

[\w-]+_[0-9a-zA-Z]+

Username

string <password>

required

The user pool username or an alias.

>= 1 characters<= 128 characters

Match pattern:

[\p{L}\p{M}\p{S}\p{N}\p{P}]+

MaxResults

integer

optional

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.

>= 0<= 60

NextToken

string

optional

A pagination token.

>= 1 characters

Match pattern:

[\S]+

Examples

Responses

🟢200Success

application/json

Body

AuthEvents

array[object (AuthEventType) {8}]

optional

The response object. It includes the EventID, EventType, CreationDate, EventRisk, and EventResponse.

EventId

string

optional

The event ID.

EventType

enum<string>

optional

The event type.

Allowed values:

SignInSignUpForgotPasswordPasswordChangeResendCode

CreationDate

string <date-time>

optional

The creation date

EventResponse

enum<string>

optional

The event response.

Allowed values:

PassFailInProgress

EventRisk

object

optional

The event risk.

ChallengeResponses

array[object (ChallengeResponseType) {2}]

optional

The challenge responses.

EventContextData

object

optional

The user context data captured at the time of an event request. This value provides additional information about the client from which event the request is received.

EventFeedback

object

optional

A flag specifying the user feedback captured at the time of an event request is good or bad.

NextToken

string

optional

A pagination token.

>= 1 characters

Match pattern:

[\S]+

🟠480InvalidParameterException

🟠481ResourceNotFoundException

🟠482TooManyRequestsException

🟠483NotAuthorizedException

🟠484UserNotFoundException

🟠485UserPoolAddOnNotEnabledException

🟠486InternalErrorException