adminGetUserAuthFactors method

Future<AdminGetUserAuthFactorsResponse> adminGetUserAuthFactors({
  1. required String userPoolId,
  2. required String username,
})

Lists the authentication options for a user in a user pool. Returns the following:

  1. The user's multi-factor authentication (MFA) preferences.
  2. The user's options for choice-based authentication with the USER_AUTH flow.

May throw InternalErrorException. May throw InvalidParameterException. May throw NotAuthorizedException. May throw OperationNotEnabledException. May throw ResourceNotFoundException. May throw TooManyRequestsException. May throw UserNotFoundException.

Parameter userPoolId : The ID of the user pool where you want to get information about the user's authentication factors.

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<AdminGetUserAuthFactorsResponse> adminGetUserAuthFactors({
  required String userPoolId,
  required String username,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target':
        'AWSCognitoIdentityProviderService.AdminGetUserAuthFactors'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'UserPoolId': userPoolId,
      'Username': username,
    },
  );

  return AdminGetUserAuthFactorsResponse.fromJson(jsonResponse.body);
}