updateAuthEventFeedback method
Provides the feedback for an authentication event generated by threat protection features. The user's response indicates that you think that the event either was from a valid user or was an unwanted authentication attempt. This feedback improves the risk evaluation decision for the user pool as part of Amazon Cognito threat protection. To activate this setting, your user pool must be on the Plus tier.
This operation requires a FeedbackToken that Amazon Cognito
generates and adds to notification emails when users have potentially
suspicious authentication events. Users invoke this operation when they
select the link that corresponds to {one-click-link-valid} or
{one-click-link-invalid} in your notification template.
Because FeedbackToken is a required parameter, you can't make
requests to UpdateAuthEventFeedback without the contents of
the notification email message.
May throw InternalErrorException.
May throw InvalidParameterException.
May throw NotAuthorizedException.
May throw OperationNotEnabledException.
May throw ResourceNotFoundException.
May throw TooManyRequestsException.
May throw UserNotFoundException.
May throw UserPoolAddOnNotEnabledException.
Parameter eventId :
The ID of the authentication event that you want to submit feedback for.
Parameter feedbackToken :
The feedback token, an encrypted object generated by Amazon Cognito and
passed to your user in the notification email message from the event.
Parameter feedbackValue :
Your feedback to the authentication event. When you provide a
FeedbackValue value of valid, you tell Amazon
Cognito that you trust a user session where Amazon Cognito has evaluated
some level of risk. When you provide a FeedbackValue value of
invalid, you tell Amazon Cognito that you don't trust a user
session, or you don't believe that Amazon Cognito evaluated a high-enough
risk level.
Parameter userPoolId :
The ID of the user pool where you want to update auth event feedback.
Parameter username :
The name 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.
Implementation
Future<void> updateAuthEventFeedback({
required String eventId,
required String feedbackToken,
required FeedbackValueType feedbackValue,
required String userPoolId,
required String username,
}) async {
final headers = <String, String>{
'Content-Type': 'application/x-amz-json-1.1',
'X-Amz-Target':
'AWSCognitoIdentityProviderService.UpdateAuthEventFeedback'
};
await _protocol.send(
method: 'POST',
requestUri: '/',
exceptionFnMap: _exceptionFns,
signed: false,
// TODO queryParams
headers: headers,
payload: {
'EventId': eventId,
'FeedbackToken': feedbackToken,
'FeedbackValue': feedbackValue.value,
'UserPoolId': userPoolId,
'Username': username,
},
);
}