adminRespondToAuthChallenge method

Future<AdminRespondToAuthChallengeResponse> adminRespondToAuthChallenge({
  1. required ChallengeNameType challengeName,
  2. required String clientId,
  3. required String userPoolId,
  4. AnalyticsMetadataType? analyticsMetadata,
  5. Map<String, String>? challengeResponses,
  6. Map<String, String>? clientMetadata,
  7. ContextDataType? contextData,
  8. String? session,
})

Responds to an authentication challenge, as an administrator.

Calling this action requires developer credentials.

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

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

Parameter clientId : The app client ID.

Parameter userPoolId : The ID of the Amazon Cognito user pool.

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

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

  • SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret).
  • PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret).
  • ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).
  • NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME, SECRET_HASH (if app client is configured with client secret).
The value of the USERNAME attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in your call to AdminInitiateAuth.

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 AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, post authentication, user migration, pre token generation, define auth challenge, create auth challenge, and verify auth challenge response. 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 AdminRespondToAuthChallenge 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 contextData : 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.

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.

Implementation

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

  return AdminRespondToAuthChallengeResponse.fromJson(jsonResponse.body);
}