respondToAuthChallenge method

Future<RespondToAuthChallengeResponse> respondToAuthChallenge({ required ChallengeNameType challengeName, required String clientId, AnalyticsMetadataType? analyticsMetadata, Map<String, String>? challengeResponses, Map<String, String>? clientMetadata, String? session, UserContextDataType? userContextData, })

Responds to the authentication challenge.

May throw ResourceNotFoundException. May throw InvalidParameterException. May throw NotAuthorizedException. May throw CodeMismatchException. May throw ExpiredCodeException. May throw UnexpectedLambdaException. May throw UserLambdaValidationException. May throw InvalidPasswordException. May throw InvalidLambdaResponseException. May throw TooManyRequestsException. May throw InvalidUserPoolConfigurationException. May throw MFAMethodNotFoundException. May throw PasswordResetRequiredException. May throw UserNotFoundException. May throw UserNotConfirmedException. May throw InvalidSmsRoleAccessPolicyException. May throw InvalidSmsRoleTrustRelationshipException. May throw AliasExistsException. May throw InternalErrorException. May throw SoftwareTokenMFANotFoundException.

Parameter challengeName : The challenge name. For more information, see InitiateAuth.

ADMIN_NO_SRP_AUTH is not a valid value.

Parameter clientId : The app client ID.

Parameter analyticsMetadata : The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.

Parameter challengeResponses : The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

• SMS_MFA: SMS_MFA_CODE, USERNAME.
• PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.
• NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME.
• SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.
• DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).
• DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires plus DEVICE_KEY.

Parameter clientMetadata : A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

• Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
• Amazon Cognito does not validate the ClientMetadata value.
• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

Parameter session : The session which should be passed both ways in challenge-response calls to the service. If InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

Parameter userContextData : Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Implementation

Future<RespondToAuthChallengeResponse> respondToAuthChallenge({
  required ChallengeNameType challengeName,
  required String clientId,
  AnalyticsMetadataType? analyticsMetadata,
  Map<String, String>? challengeResponses,
  Map<String, String>? clientMetadata,
  String? session,
  UserContextDataType? userContextData,
}) async {
  ArgumentError.checkNotNull(challengeName, 'challengeName');
  ArgumentError.checkNotNull(clientId, 'clientId');
  _s.validateStringLength(
    'clientId',
    clientId,
    1,
    128,
    isRequired: true,
  );
  _s.validateStringLength(
    'session',
    session,
    20,
    2048,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSCognitoIdentityProviderService.RespondToAuthChallenge'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    signed: false,
    // TODO queryParams
    headers: headers,
    payload: {
      'ChallengeName': challengeName.toValue(),
      'ClientId': clientId,
      if (analyticsMetadata != null) 'AnalyticsMetadata': analyticsMetadata,
      if (challengeResponses != null)
        'ChallengeResponses': challengeResponses,
      if (clientMetadata != null) 'ClientMetadata': clientMetadata,
      if (session != null) 'Session': session,
      if (userContextData != null) 'UserContextData': userContextData,
    },
  );

  return RespondToAuthChallengeResponse.fromJson(jsonResponse.body);
}