@aws-amplify/auth 5.6.1 → 5.6.2-unstable.c3ec8a5.0

package/lib-esm/internals/InternalAuth.js

@@ -2,14 +2,15 @@
 // SPDX-License-Identifier: Apache-2.0
 import { __assign, __awaiter, __generator, __read } from "tslib";
 import { isUsernamePasswordOpts, isCognitoHostedOpts, isFederatedSignInOptions, isFederatedSignInOptionsCustom, hasCustomState, } from '../types';
-import { Amplify, ConsoleLogger as Logger, Credentials, Hub, StorageHelper, Platform, browserOrNode, parseAWSExports, UniversalStorage, urlSafeDecode, } from '@aws-amplify/core';
-import { CookieStorage, CognitoUserPool, AuthenticationDetails, CognitoUser, CognitoUserSession, CognitoUserAttribute, CognitoIdToken, CognitoRefreshToken, CognitoAccessToken, } from 'amazon-cognito-identity-js';
-import { addAuthCategoryToCognitoUserAgent, addFrameworkToCognitoUserAgent, } from 'amazon-cognito-identity-js/internals';
+import { Amplify, AuthAction, ConsoleLogger as Logger, Credentials, getAmplifyUserAgent, Hub, StorageHelper, Platform, browserOrNode, parseAWSExports, UniversalStorage, urlSafeDecode, } from '@aws-amplify/core';
+import { CookieStorage, AuthenticationDetails, CognitoUserSession, CognitoUserAttribute, CognitoIdToken, CognitoRefreshToken, CognitoAccessToken, } from 'amazon-cognito-identity-js';
+import { addAuthCategoryToCognitoUserAgent, addFrameworkToCognitoUserAgent, InternalCognitoUser, InternalCognitoUserPool, } from 'amazon-cognito-identity-js/internals';
 import { parse } from 'url';
 import OAuth from '../OAuth/OAuth';
 import { default as urlListener } from '../urlListener';
 import { AuthError, NoUserPoolError } from '../Errors';
 import { AuthErrorTypes, CognitoHostedUIIdentityProvider, } from '../types/Auth';
+import { getAuthUserAgentDetails, getAuthUserAgentValue } from '../utils';
 var logger = new Logger('AuthClass');
 var USER_ADMIN_SCOPE = 'aws.cognito.signin.user.admin';
 // 10 sec, following this guide https://www.nngroup.com/articles/response-times-3-important-limits/
@@ -118,7 +119,7 @@ var InternalAuthClass = /** @class */ (function () {
                 endpoint: endpoint,
             };
             userPoolData.Storage = this._storage;
-            this.userPool = new CognitoUserPool(userPoolData, this.wrapRefreshSessionCallback);
+            this.userPool = new InternalCognitoUserPool(userPoolData, this.wrapRefreshSessionCallback);
         }
         this.Credentials.configure({
             mandatorySignIn: mandatorySignIn,
@@ -250,6 +251,7 @@ var InternalAuthClass = /** @class */ (function () {
         logger.debug('signUp attrs:', attributes);
         logger.debug('signUp validation data:', validationData);
         return new Promise(function (resolve, reject) {
+            var userAgentDetails = getAuthUserAgentDetails(AuthAction.SignUp, customUserAgentDetails);
             _this.userPool.signUp(username, password, attributes, validationData, function (err, data) {
                 if (err) {
                     dispatchAuthEvent('signUp_failure', err, username + " failed to signup");
@@ -258,14 +260,14 @@ var InternalAuthClass = /** @class */ (function () {
                 else {
                     dispatchAuthEvent('signUp', data, username + " has signed up successfully");
                     if (autoSignIn.enabled) {
-                        _this.handleAutoSignIn(username, password, autoSignInValidationData, autoSignInClientMetaData, data);
+                        _this.handleAutoSignIn(username, password, autoSignInValidationData, autoSignInClientMetaData, data, userAgentDetails);
                     }
                     resolve(data);
                 }
-            }, clientMetadata);
+            }, clientMetadata, getAmplifyUserAgent(userAgentDetails));
         });
     };
-    InternalAuthClass.prototype.handleAutoSignIn = function (username, password, validationData, clientMetadata, data) {
+    InternalAuthClass.prototype.handleAutoSignIn = function (username, password, validationData, clientMetadata, data, customUserAgentDetails) {
         this.autoSignInInitiated = true;
         var authDetails = new AuthenticationDetails({
             Username: username,
@@ -274,26 +276,26 @@ var InternalAuthClass = /** @class */ (function () {
             ClientMetadata: clientMetadata,
         });
         if (data.userConfirmed) {
-            this.signInAfterUserConfirmed(authDetails);
+            this.signInAfterUserConfirmed(authDetails, customUserAgentDetails);
         }
         else if (this._config.signUpVerificationMethod === 'link') {
-            this.handleLinkAutoSignIn(authDetails);
+            this.handleLinkAutoSignIn(authDetails, customUserAgentDetails);
         }
         else {
-            this.handleCodeAutoSignIn(authDetails);
+            this.handleCodeAutoSignIn(authDetails, customUserAgentDetails);
         }
     };
-    InternalAuthClass.prototype.handleCodeAutoSignIn = function (authDetails) {
+    InternalAuthClass.prototype.handleCodeAutoSignIn = function (authDetails, customUserAgentDetails) {
         var _this = this;
         var listenEvent = function (_a) {
             var payload = _a.payload;
             if (payload.event === 'confirmSignUp') {
-                _this.signInAfterUserConfirmed(authDetails, listenEvent);
+                _this.signInAfterUserConfirmed(authDetails, customUserAgentDetails, listenEvent);
             }
         };
         Hub.listen('auth', listenEvent);
     };
-    InternalAuthClass.prototype.handleLinkAutoSignIn = function (authDetails) {
+    InternalAuthClass.prototype.handleLinkAutoSignIn = function (authDetails, customUserAgentDetails) {
         var _this = this;
         this._storage.setItem('amplify-polling-started', 'true');
         var start = Date.now();
@@ -304,11 +306,11 @@ var InternalAuthClass = /** @class */ (function () {
                 _this._storage.removeItem('amplify-auto-sign-in');
             }
             else {
-                _this.signInAfterUserConfirmed(authDetails, null, autoSignInPollingIntervalId);
+                _this.signInAfterUserConfirmed(authDetails, customUserAgentDetails, undefined, autoSignInPollingIntervalId);
             }
         }, 5000);
     };
-    InternalAuthClass.prototype.signInAfterUserConfirmed = function (authDetails, listenEvent, autoSignInPollingIntervalId) {
+    InternalAuthClass.prototype.signInAfterUserConfirmed = function (authDetails, customUserAgentDetails, listenEvent, autoSignInPollingIntervalId) {
         return __awaiter(this, void 0, void 0, function () {
             var user, error_1;
             var _this = this;
@@ -332,7 +334,7 @@ var InternalAuthClass = /** @class */ (function () {
                             }, function (error) {
                                 logger.error(error);
                                 _this._storage.removeItem('amplify-auto-sign-in');
-                            }))];
+                            }, customUserAgentDetails), getAmplifyUserAgent(customUserAgentDetails))];
                     case 2:
                         _a.sent();
                         return [3 /*break*/, 4];
@@ -389,7 +391,7 @@ var InternalAuthClass = /** @class */ (function () {
                     }
                     resolve(data);
                 }
-            }, clientMetadata);
+            }, clientMetadata, getAuthUserAgentValue(AuthAction.ConfirmSignUp, customUserAgentDetails));
         });
     };
     InternalAuthClass.prototype.isTrueStorageValue = function (value) {
@@ -420,7 +422,7 @@ var InternalAuthClass = /** @class */ (function () {
                 else {
                     resolve(data);
                 }
-            }, clientMetadata);
+            }, clientMetadata, getAuthUserAgentValue(AuthAction.ResendSignUp, customUserAgentDetails));
         });
     };
     /**
@@ -463,21 +465,22 @@ var InternalAuthClass = /** @class */ (function () {
             ValidationData: validationData,
             ClientMetadata: clientMetadata,
         });
+        var userAgentDetails = getAuthUserAgentDetails(AuthAction.SignIn, customUserAgentDetails);
         if (password) {
-            return this.signInWithPassword(authDetails);
+            return this.signInWithPassword(authDetails, userAgentDetails);
         }
         else {
-            return this.signInWithoutPassword(authDetails);
+            return this.signInWithoutPassword(authDetails, userAgentDetails);
         }
     };
     /**
      * Return an object with the authentication callbacks
-     * @param {CognitoUser} user - the cognito user object
+     * @param {InternalCognitoUser} user - the cognito user object
      * @param {} resolve - function called when resolving the current step
      * @param {} reject - function called when rejecting the current step
      * @return - an object with the callback methods for user authentication
      */
-    InternalAuthClass.prototype.authCallbacks = function (user, resolve, reject) {
+    InternalAuthClass.prototype.authCallbacks = function (user, resolve, reject, customUserAgentDetails) {
         var _this = this;
         var that = this;
         return {
@@ -506,7 +509,7 @@ var InternalAuthClass = /** @class */ (function () {
                             return [3 /*break*/, 9];
                         case 5:
                             _a.trys.push([5, 7, , 8]);
-                            return [4 /*yield*/, this.currentUserPoolUser()];
+                            return [4 /*yield*/, this._currentUserPoolUser(undefined, customUserAgentDetails)];
                         case 6:
                             currentUser = _a.sent();
                             that.user = currentUser;
@@ -573,9 +576,10 @@ var InternalAuthClass = /** @class */ (function () {
      * Sign in with a password
      * @private
      * @param {AuthenticationDetails} authDetails - the user sign in data
+     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
      * @return - A promise resolves the CognitoUser object if success or mfa required
      */
-    InternalAuthClass.prototype.signInWithPassword = function (authDetails) {
+    InternalAuthClass.prototype.signInWithPassword = function (authDetails, customUserAgentDetails) {
         var _this = this;
         if (this.pendingSignIn) {
             throw new Error('Pending sign-in attempt already in progress');
@@ -588,7 +592,7 @@ var InternalAuthClass = /** @class */ (function () {
             }, function (error) {
                 _this.pendingSignIn = null;
                 reject(error);
-            }));
+            }, customUserAgentDetails), getAmplifyUserAgent(customUserAgentDetails));
         });
         return this.pendingSignIn;
     };
@@ -596,14 +600,15 @@ var InternalAuthClass = /** @class */ (function () {
      * Sign in without a password
      * @private
      * @param {AuthenticationDetails} authDetails - the user sign in data
-     * @return - A promise resolves the CognitoUser object if success or mfa required
+     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
+     * @return - A promise resolves the InternalCognitoUser object if success or mfa required
      */
-    InternalAuthClass.prototype.signInWithoutPassword = function (authDetails) {
+    InternalAuthClass.prototype.signInWithoutPassword = function (authDetails, customUserAgentDetails) {
         var _this = this;
         var user = this.createCognitoUser(authDetails.getUsername());
         user.setAuthenticationFlowType('CUSTOM_AUTH');
         return new Promise(function (resolve, reject) {
-            user.initiateAuth(authDetails, _this.authCallbacks(user, resolve, reject));
+            user.initiateAuth(authDetails, _this.authCallbacks(user, resolve, reject, customUserAgentDetails), getAmplifyUserAgent(customUserAgentDetails));
         });
     };
     /**
@@ -616,8 +621,9 @@ var InternalAuthClass = /** @class */ (function () {
      * @return - A promise resolves the current preferred mfa option if success
      */
     InternalAuthClass.prototype.getMFAOptions = function (user, customUserAgentDetails) {
+        var internalUser = user;
         return new Promise(function (res, rej) {
-            user.getMFAOptions(function (err, mfaOptions) {
+            internalUser.getMFAOptions(function (err, mfaOptions) {
                 if (err) {
                     logger.debug('get MFA Options failed', err);
                     rej(err);
@@ -626,7 +632,7 @@ var InternalAuthClass = /** @class */ (function () {
                 logger.debug('get MFA options success', mfaOptions);
                 res(mfaOptions);
                 return;
-            });
+            }, getAuthUserAgentValue(AuthAction.GetMFAOptions, customUserAgentDetails));
         });
     };
     /**
@@ -637,11 +643,13 @@ var InternalAuthClass = /** @class */ (function () {
      */
     InternalAuthClass.prototype.getPreferredMFA = function (user, params, customUserAgentDetails) {
         var _this = this;
+        var internalUser = user;
         var that = this;
         return new Promise(function (res, rej) {
             var clientMetadata = _this._config.clientMetadata; // TODO: verify behavior if this is override during signIn
             var bypassCache = params ? params.bypassCache : false;
-            user.getUserData(function (err, data) { return __awaiter(_this, void 0, void 0, function () {
+            var userAgentValue = getAuthUserAgentValue(AuthAction.GetPreferredMFA, customUserAgentDetails);
+            internalUser.getUserData(function (err, data) { return __awaiter(_this, void 0, void 0, function () {
                 var cleanUpError_1, mfaType;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
@@ -652,7 +660,7 @@ var InternalAuthClass = /** @class */ (function () {
                             _a.label = 1;
                         case 1:
                             _a.trys.push([1, 3, , 4]);
-                            return [4 /*yield*/, this.cleanUpInvalidSession(user)];
+                            return [4 /*yield*/, this.cleanUpInvalidSession(user, userAgentValue)];
                         case 2:
                             _a.sent();
                             return [3 /*break*/, 4];
@@ -676,7 +684,7 @@ var InternalAuthClass = /** @class */ (function () {
                             return [2 /*return*/];
                     }
                 });
-            }); }, { bypassCache: bypassCache, clientMetadata: clientMetadata });
+            }); }, { bypassCache: bypassCache, clientMetadata: clientMetadata }, userAgentValue);
         });
     };
     InternalAuthClass.prototype._getMfaTypeFromUserData = function (data) {
@@ -712,7 +720,7 @@ var InternalAuthClass = /** @class */ (function () {
         }
         return ret;
     };
-    InternalAuthClass.prototype._getUserData = function (user, params) {
+    InternalAuthClass.prototype._getUserData = function (user, params, userAgentValue) {
         var _this = this;
         return new Promise(function (res, rej) {
             user.getUserData(function (err, data) { return __awaiter(_this, void 0, void 0, function () {
@@ -726,7 +734,7 @@ var InternalAuthClass = /** @class */ (function () {
                             _a.label = 1;
                         case 1:
                             _a.trys.push([1, 3, , 4]);
-                            return [4 /*yield*/, this.cleanUpInvalidSession(user)];
+                            return [4 /*yield*/, this.cleanUpInvalidSession(user, userAgentValue)];
                         case 2:
                             _a.sent();
                             return [3 /*break*/, 4];
@@ -743,7 +751,7 @@ var InternalAuthClass = /** @class */ (function () {
                         case 6: return [2 /*return*/];
                     }
                 });
-            }); }, params);
+            }); }, params, userAgentValue);
         });
     };
     /**
@@ -755,16 +763,18 @@ var InternalAuthClass = /** @class */ (function () {
      */
     InternalAuthClass.prototype.setPreferredMFA = function (user, mfaMethod, customUserAgentDetails) {
         return __awaiter(this, void 0, void 0, function () {
-            var clientMetadata, userData, smsMfaSettings, totpMfaSettings, _a, mfaList, currentMFAType, that;
+            var internalUser, userAgentValue, clientMetadata, userData, smsMfaSettings, totpMfaSettings, _a, mfaList, currentMFAType, that;
             var _this = this;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
+                        internalUser = user;
+                        userAgentValue = getAuthUserAgentValue(AuthAction.SetPreferredMFA, customUserAgentDetails);
                         clientMetadata = this._config.clientMetadata;
                         return [4 /*yield*/, this._getUserData(user, {
                                 bypassCache: true,
                                 clientMetadata: clientMetadata,
-                            })];
+                            }, userAgentValue)];
                     case 1:
                         userData = _b.sent();
                         smsMfaSettings = null;
@@ -839,7 +849,7 @@ var InternalAuthClass = /** @class */ (function () {
                     case 7:
                         that = this;
                         return [2 /*return*/, new Promise(function (res, rej) {
-                                user.setUserMfaPreference(smsMfaSettings, totpMfaSettings, function (err, result) {
+                                internalUser.setUserMfaPreference(smsMfaSettings, totpMfaSettings, function (err, result) {
                                     if (err) {
                                         logger.debug('Set user mfa preference error', err);
                                         return rej(err);
@@ -847,7 +857,7 @@ var InternalAuthClass = /** @class */ (function () {
                                     logger.debug('Set user mfa success', result);
                                     logger.debug('Caching the latest user data into local');
                                     // cache the latest result into user data
-                                    user.getUserData(function (err, data) { return __awaiter(_this, void 0, void 0, function () {
+                                    internalUser.getUserData(function (err, data) { return __awaiter(_this, void 0, void 0, function () {
                                         var cleanUpError_3;
                                         return __generator(this, function (_a) {
                                             switch (_a.label) {
@@ -858,7 +868,7 @@ var InternalAuthClass = /** @class */ (function () {
                                                     _a.label = 1;
                                                 case 1:
                                                     _a.trys.push([1, 3, , 4]);
-                                                    return [4 /*yield*/, this.cleanUpInvalidSession(user)];
+                                                    return [4 /*yield*/, this.cleanUpInvalidSession(user, userAgentValue)];
                                                 case 2:
                                                     _a.sent();
                                                     return [3 /*break*/, 4];
@@ -873,8 +883,8 @@ var InternalAuthClass = /** @class */ (function () {
                                     }); }, {
                                         bypassCache: true,
                                         clientMetadata: clientMetadata,
-                                    });
-                                });
+                                    }, userAgentValue);
+                                }, userAgentValue);
                             })];
                 }
             });
@@ -888,8 +898,9 @@ var InternalAuthClass = /** @class */ (function () {
      * @return - A promise resolves is success
      */
     InternalAuthClass.prototype.disableSMS = function (user, customUserAgentDetails) {
+        var internalUser = user;
         return new Promise(function (res, rej) {
-            user.disableMFA(function (err, data) {
+            internalUser.disableMFA(function (err, data) {
                 if (err) {
                     logger.debug('disable mfa failed', err);
                     rej(err);
@@ -898,7 +909,7 @@ var InternalAuthClass = /** @class */ (function () {
                 logger.debug('disable mfa succeed', data);
                 res(data);
                 return;
-            });
+            }, getAuthUserAgentValue(AuthAction.DisableSMS, customUserAgentDetails));
         });
     };
     /**
@@ -909,8 +920,9 @@ var InternalAuthClass = /** @class */ (function () {
      * @return - A promise resolves is success
      */
     InternalAuthClass.prototype.enableSMS = function (user, customUserAgentDetails) {
+        var internalUser = user;
         return new Promise(function (res, rej) {
-            user.enableMFA(function (err, data) {
+            internalUser.enableMFA(function (err, data) {
                 if (err) {
                     logger.debug('enable mfa failed', err);
                     rej(err);
@@ -919,7 +931,7 @@ var InternalAuthClass = /** @class */ (function () {
                 logger.debug('enable mfa succeed', data);
                 res(data);
                 return;
-            });
+            }, getAuthUserAgentValue(AuthAction.EnableSMS, customUserAgentDetails));
         });
     };
     /**
@@ -929,8 +941,9 @@ var InternalAuthClass = /** @class */ (function () {
      * @return - A promise resolves with the secret code if success
      */
     InternalAuthClass.prototype.setupTOTP = function (user, customUserAgentDetails) {
+        var internalUser = user;
         return new Promise(function (res, rej) {
-            user.associateSoftwareToken({
+            internalUser.associateSoftwareToken({
                 onFailure: function (err) {
                     logger.debug('associateSoftwareToken failed', err);
                     rej(err);
@@ -941,7 +954,7 @@ var InternalAuthClass = /** @class */ (function () {
                     res(secretCode);
                     return;
                 },
-            });
+            }, getAuthUserAgentValue(AuthAction.SetupTOTP, customUserAgentDetails));
         });
     };
     /**
@@ -953,13 +966,15 @@ var InternalAuthClass = /** @class */ (function () {
      */
     InternalAuthClass.prototype.verifyTotpToken = function (user, challengeAnswer, customUserAgentDetails) {
         logger.debug('verification totp token', user, challengeAnswer);
+        var internalUser = user;
         var signInUserSession;
-        if (user && typeof user.getSignInUserSession === 'function') {
+        if (internalUser &&
+            typeof internalUser.getSignInUserSession === 'function') {
             signInUserSession = user.getSignInUserSession();
         }
         var isLoggedIn = signInUserSession === null || signInUserSession === void 0 ? void 0 : signInUserSession.isValid();
         return new Promise(function (res, rej) {
-            user.verifySoftwareToken(challengeAnswer, 'My TOTP device', {
+            internalUser.verifySoftwareToken(challengeAnswer, 'My TOTP device', {
                 onFailure: function (err) {
                     logger.debug('verifyTotpToken failed', err);
                     rej(err);
@@ -967,14 +982,14 @@ var InternalAuthClass = /** @class */ (function () {
                 },
                 onSuccess: function (data) {
                     if (!isLoggedIn) {
-                        dispatchAuthEvent('signIn', user, "A user " + user.getUsername() + " has been signed in");
+                        dispatchAuthEvent('signIn', internalUser, "A user " + internalUser.getUsername() + " has been signed in");
                     }
-                    dispatchAuthEvent('verify', user, "A user " + user.getUsername() + " has been verified");
+                    dispatchAuthEvent('verify', internalUser, "A user " + internalUser.getUsername() + " has been verified");
                     logger.debug('verifyTotpToken success', data);
                     res(data);
                     return;
                 },
-            });
+            }, getAuthUserAgentValue(AuthAction.VerifyTotpToken, customUserAgentDetails));
         });
     };
     /**
@@ -988,12 +1003,14 @@ var InternalAuthClass = /** @class */ (function () {
     InternalAuthClass.prototype.confirmSignIn = function (user, code, mfaType, clientMetadata, customUserAgentDetails) {
         var _this = this;
         if (clientMetadata === void 0) { clientMetadata = this._config.clientMetadata; }
+        var internalUser = user;
         if (!code) {
             return this.rejectAuthError(AuthErrorTypes.EmptyCode);
         }
         var that = this;
+        var userAgentDetails = getAuthUserAgentDetails(AuthAction.ConfirmSignIn, customUserAgentDetails);
         return new Promise(function (resolve, reject) {
-            user.sendMFACode(code, {
+            internalUser.sendMFACode(code, {
                 onSuccess: function (session) { return __awaiter(_this, void 0, void 0, function () {
                     var cred, e_3, currentUser, e_4;
                     return __generator(this, function (_a) {
@@ -1016,22 +1033,24 @@ var InternalAuthClass = /** @class */ (function () {
                                 logger.debug('cannot get cognito credentials', e_3);
                                 return [3 /*break*/, 10];
                             case 5:
-                                that.user = user;
+                                that.user = internalUser;
                                 _a.label = 6;
                             case 6:
                                 _a.trys.push([6, 8, , 9]);
-                                return [4 /*yield*/, this.currentUserPoolUser()];
+                                return [4 /*yield*/, this._currentUserPoolUser(undefined, userAgentDetails)];
                             case 7:
                                 currentUser = _a.sent();
-                                user.attributes = currentUser.attributes;
+                                Object.assign(internalUser, {
+                                    attributes: currentUser.attributes,
+                                });
                                 return [3 /*break*/, 9];
                             case 8:
                                 e_4 = _a.sent();
                                 logger.debug('cannot get updated Cognito User', e_4);
                                 return [3 /*break*/, 9];
                             case 9:
-                                dispatchAuthEvent('signIn', user, "A user " + user.getUsername() + " has been signed in");
-                                resolve(user);
+                                dispatchAuthEvent('signIn', internalUser, "A user " + internalUser.getUsername() + " has been signed in");
+                                resolve(internalUser);
                                 return [7 /*endfinally*/];
                             case 10: return [2 /*return*/];
                         }
@@ -1041,19 +1060,20 @@ var InternalAuthClass = /** @class */ (function () {
                     logger.debug('confirm signIn failure', err);
                     reject(err);
                 },
-            }, mfaType, clientMetadata);
+            }, mfaType, clientMetadata, getAmplifyUserAgent(userAgentDetails));
         });
     };
     InternalAuthClass.prototype.completeNewPassword = function (user, password, requiredAttributes, clientMetadata, customUserAgentDetails) {
         var _this = this;
         if (requiredAttributes === void 0) { requiredAttributes = {}; }
         if (clientMetadata === void 0) { clientMetadata = this._config.clientMetadata; }
+        var internalUser = user;
         if (!password) {
             return this.rejectAuthError(AuthErrorTypes.EmptyPassword);
         }
         var that = this;
         return new Promise(function (resolve, reject) {
-            user.completeNewPasswordChallenge(password, requiredAttributes, {
+            internalUser.completeNewPasswordChallenge(password, requiredAttributes, {
                 onSuccess: function (session) { return __awaiter(_this, void 0, void 0, function () {
                     var cred, e_5;
                     return __generator(this, function (_a) {
@@ -1076,9 +1096,9 @@ var InternalAuthClass = /** @class */ (function () {
                                 logger.debug('cannot get cognito credentials', e_5);
                                 return [3 /*break*/, 6];
                             case 5:
-                                that.user = user;
-                                dispatchAuthEvent('signIn', user, "A user " + user.getUsername() + " has been signed in");
-                                resolve(user);
+                                that.user = internalUser;
+                                dispatchAuthEvent('signIn', internalUser, "A user " + internalUser.getUsername() + " has been signed in");
+                                resolve(internalUser);
                                 return [7 /*endfinally*/];
                             case 6: return [2 /*return*/];
                         }
@@ -1091,23 +1111,23 @@ var InternalAuthClass = /** @class */ (function () {
                 },
                 mfaRequired: function (challengeName, challengeParam) {
                     logger.debug('signIn MFA required');
-                    user['challengeName'] = challengeName;
-                    user['challengeParam'] = challengeParam;
-                    resolve(user);
+                    internalUser['challengeName'] = challengeName;
+                    internalUser['challengeParam'] = challengeParam;
+                    resolve(internalUser);
                 },
                 mfaSetup: function (challengeName, challengeParam) {
                     logger.debug('signIn mfa setup', challengeName);
-                    user['challengeName'] = challengeName;
-                    user['challengeParam'] = challengeParam;
-                    resolve(user);
+                    internalUser['challengeName'] = challengeName;
+                    internalUser['challengeParam'] = challengeParam;
+                    resolve(internalUser);
                 },
                 totpRequired: function (challengeName, challengeParam) {
                     logger.debug('signIn mfa setup', challengeName);
-                    user['challengeName'] = challengeName;
-                    user['challengeParam'] = challengeParam;
-                    resolve(user);
+                    internalUser['challengeName'] = challengeName;
+                    internalUser['challengeParam'] = challengeParam;
+                    resolve(internalUser);
                 },
-            }, clientMetadata);
+            }, clientMetadata, getAuthUserAgentValue(AuthAction.CompleteNewPassword, customUserAgentDetails));
         });
     };
     /**
@@ -1116,10 +1136,12 @@ var InternalAuthClass = /** @class */ (function () {
      * @param {String} challengeResponses - The confirmation code
      * @param {ClientMetaData} clientMetadata - optional client metadata defaults to config
      * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
+     *
      */
     InternalAuthClass.prototype.sendCustomChallengeAnswer = function (user, challengeResponses, clientMetadata, customUserAgentDetails) {
         var _this = this;
         if (clientMetadata === void 0) { clientMetadata = this._config.clientMetadata; }
+        var internalUser = user;
         if (!this.userPool) {
             return this.rejectNoUserPool();
         }
@@ -1127,8 +1149,9 @@ var InternalAuthClass = /** @class */ (function () {
             return this.rejectAuthError(AuthErrorTypes.EmptyChallengeResponse);
         }
         var that = this;
+        var userAgentDetails = getAuthUserAgentDetails(AuthAction.SendCustomChallengeAnswer, customUserAgentDetails);
         return new Promise(function (resolve, reject) {
-            user.sendCustomChallengeAnswer(challengeResponses, _this.authCallbacks(user, resolve, reject), clientMetadata);
+            internalUser.sendCustomChallengeAnswer(challengeResponses, _this.authCallbacks(internalUser, resolve, reject, userAgentDetails), clientMetadata, getAmplifyUserAgent(userAgentDetails));
         });
     };
     /**
@@ -1139,17 +1162,19 @@ var InternalAuthClass = /** @class */ (function () {
      * @return {Promise}
      **/
     InternalAuthClass.prototype.deleteUserAttributes = function (user, attributeNames, customUserAgentDetails) {
+        var internalUser = user;
         var that = this;
+        var userAgentValue = getAuthUserAgentValue(AuthAction.DeleteUserAttributes, customUserAgentDetails);
         return new Promise(function (resolve, reject) {
-            that.userSession(user).then(function (session) {
-                user.deleteAttributes(attributeNames, function (err, result) {
+            that._userSession(userAgentValue, internalUser).then(function (session) {
+                internalUser.deleteAttributes(attributeNames, function (err, result) {
                     if (err) {
                         return reject(err);
                     }
                     else {
                         return resolve(result);
                     }
-                });
+                }, userAgentValue);
             });
         });
     };
@@ -1179,17 +1204,18 @@ var InternalAuthClass = /** @class */ (function () {
                         isSignedInHostedUI = this._oAuthHandler &&
                             this._storage.getItem('amplify-signin-with-hostedUI') === 'true';
                         return [2 /*return*/, new Promise(function (res, rej) { return __awaiter(_this, void 0, void 0, function () {
-                                var user_1;
+                                var internalUser_1, userAgentValue_1;
                                 var _this = this;
                                 return __generator(this, function (_a) {
                                     if (this.userPool) {
-                                        user_1 = this.userPool.getCurrentUser();
-                                        if (!user_1) {
+                                        internalUser_1 = this.userPool.getCurrentUser();
+                                        if (!internalUser_1) {
                                             logger.debug('Failed to get user from user pool');
                                             return [2 /*return*/, rej(new Error('No current user.'))];
                                         }
                                         else {
-                                            user_1.getSession(function (err, session) { return __awaiter(_this, void 0, void 0, function () {
+                                            userAgentValue_1 = getAuthUserAgentValue(AuthAction.DeleteUser, customUserAgentDetails);
+                                            internalUser_1.getSession(function (err, session) { return __awaiter(_this, void 0, void 0, function () {
                                                 var cleanUpError_4;
                                                 var _this = this;
                                                 return __generator(this, function (_a) {
@@ -1201,7 +1227,7 @@ var InternalAuthClass = /** @class */ (function () {
                                                             _a.label = 1;
                                                         case 1:
                                                             _a.trys.push([1, 3, , 4]);
-                                                            return [4 /*yield*/, this.cleanUpInvalidSession(user_1)];
+                                                            return [4 /*yield*/, this.cleanUpInvalidSession(internalUser_1, userAgentValue_1)];
                                                         case 2:
                                                             _a.sent();
                                                             return [3 /*break*/, 4];
@@ -1211,13 +1237,13 @@ var InternalAuthClass = /** @class */ (function () {
                                                             return [2 /*return*/];
                                                         case 4: return [2 /*return*/, rej(err)];
                                                         case 5:
-                                                            user_1.deleteUser(function (err, result) {
+                                                            internalUser_1.deleteUser(function (err, result) {
                                                                 if (err) {
                                                                     rej(err);
                                                                 }
                                                                 else {
                                                                     dispatchAuthEvent('userDeleted', result, 'The authenticated user has been deleted.');
-                                                                    user_1.signOut();
+                                                                    internalUser_1.signOut(undefined, userAgentValue_1);
                                                                     _this.user = null;
                                                                     try {
                                                                         _this.cleanCachedItems(); // clean aws credentials
@@ -1234,7 +1260,7 @@ var InternalAuthClass = /** @class */ (function () {
                                                                         res(result);
                                                                     }
                                                                 }
-                                                            });
+                                                            }, undefined, userAgentValue_1);
                                                             _a.label = 6;
                                                         case 6: return [2 /*return*/];
                                                     }
@@ -1264,10 +1290,12 @@ var InternalAuthClass = /** @class */ (function () {
     InternalAuthClass.prototype.updateUserAttributes = function (user, attributes, clientMetadata, customUserAgentDetails) {
         var _this = this;
         if (clientMetadata === void 0) { clientMetadata = this._config.clientMetadata; }
+        var internalUser = user;
         var attributeList = [];
         var that = this;
+        var userAgentValue = getAuthUserAgentValue(AuthAction.UpdateUserAttributes, customUserAgentDetails);
         return new Promise(function (resolve, reject) {
-            that.userSession(user).then(function (session) {
+            that._userSession(userAgentValue, internalUser).then(function (session) {
                 for (var key in attributes) {
                     if (key !== 'sub' && key.indexOf('_verified') < 0) {
                         var attr = {
@@ -1277,7 +1305,7 @@ var InternalAuthClass = /** @class */ (function () {
                         attributeList.push(attr);
                     }
                 }
-                user.updateAttributes(attributeList, function (err, result, details) {
+                internalUser.updateAttributes(attributeList, function (err, result, details) {
                     if (err) {
                         dispatchAuthEvent('updateUserAttributes_failure', err, 'Failed to update attributes');
                         return reject(err);
@@ -1287,7 +1315,7 @@ var InternalAuthClass = /** @class */ (function () {
                         dispatchAuthEvent('updateUserAttributes', attrs, 'Attributes successfully updated');
                         return resolve(result);
                     }
-                }, clientMetadata);
+                }, clientMetadata, userAgentValue);
             });
         });
     };
@@ -1312,23 +1340,28 @@ var InternalAuthClass = /** @class */ (function () {
      * @return - A promise resolves to user attributes if success
      */
     InternalAuthClass.prototype.userAttributes = function (user, customUserAgentDetails) {
+        return this._userAttributes(user, customUserAgentDetails);
+    };
+    InternalAuthClass.prototype._userAttributes = function (user, customUserAgentDetails) {
         var _this = this;
+        var internalUser = user;
+        var userAgentValue = getAuthUserAgentValue(AuthAction.UserAttributes, customUserAgentDetails);
         return new Promise(function (resolve, reject) {
-            _this.userSession(user).then(function (session) {
-                user.getUserAttributes(function (err, attributes) {
+            _this._userSession(userAgentValue, internalUser).then(function (session) {
+                internalUser.getUserAttributes(function (err, attributes) {
                     if (err) {
                         reject(err);
                     }
                     else {
                         resolve(attributes);
                     }
-                });
+                }, userAgentValue);
             });
         });
     };
     InternalAuthClass.prototype.verifiedContact = function (user, customUserAgentDetails) {
         var that = this;
-        return this.userAttributes(user).then(function (attributes) {
+        return this._userAttributes(user, getAuthUserAgentDetails(AuthAction.VerifiedContact, customUserAgentDetails)).then(function (attributes) {
             var attrs = that.attributesToObject(attributes);
             var unverified = {};
             var verified = {};
@@ -1393,14 +1426,14 @@ var InternalAuthClass = /** @class */ (function () {
             this.isRefreshTokenExpiredError(err) ||
             this.isPasswordResetRequiredError(err));
     };
-    InternalAuthClass.prototype.cleanUpInvalidSession = function (user) {
+    InternalAuthClass.prototype.cleanUpInvalidSession = function (internalUser, userAgentValue) {
         return __awaiter(this, void 0, void 0, function () {
             var e_7;
             var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        user.signOut();
+                        internalUser.signOut(undefined, userAgentValue);
                         this.user = null;
                         _a.label = 1;
                     case 1:
@@ -1434,6 +1467,9 @@ var InternalAuthClass = /** @class */ (function () {
      * @return - A promise resolves to current authenticated CognitoUser if success
      */
     InternalAuthClass.prototype.currentUserPoolUser = function (params, customUserAgentDetails) {
+        return this._currentUserPoolUser(params, customUserAgentDetails);
+    };
+    InternalAuthClass.prototype._currentUserPoolUser = function (params, customUserAgentDetails) {
         var _this = this;
         if (!this.userPool) {
             return this.rejectNoUserPool();
@@ -1441,7 +1477,7 @@ var InternalAuthClass = /** @class */ (function () {
         return new Promise(function (res, rej) {
             _this._storageSync
                 .then(function () { return __awaiter(_this, void 0, void 0, function () {
-                var user, session, bypassCache, clientMetadata, _a, scope, err_1;
+                var internalUser, userAgentValue_2, session, bypassCache, clientMetadata, _a, scope, err_1;
                 var _this = this;
                 return __generator(this, function (_b) {
                     switch (_b.label) {
@@ -1471,8 +1507,8 @@ var InternalAuthClass = /** @class */ (function () {
                             _b.sent();
                             _b.label = 2;
                         case 2:
-                            user = this.userPool.getCurrentUser();
-                            if (!user) {
+                            internalUser = this.userPool.getCurrentUser();
+                            if (!internalUser) {
                                 logger.debug('Failed to get user from user pool');
                                 rej('No current user');
                                 return [2 /*return*/];
@@ -1480,7 +1516,8 @@ var InternalAuthClass = /** @class */ (function () {
                             _b.label = 3;
                         case 3:
                             _b.trys.push([3, 7, , 8]);
-                            return [4 /*yield*/, this._userSession(user)];
+                            userAgentValue_2 = getAuthUserAgentValue(AuthAction.CurrentUserPoolUser, customUserAgentDetails);
+                            return [4 /*yield*/, this._userSession(userAgentValue_2, internalUser)];
                         case 4:
                             session = _b.sent();
                             bypassCache = params ? params.bypassCache : false;
@@ -1493,7 +1530,7 @@ var InternalAuthClass = /** @class */ (function () {
                             clientMetadata = this._config.clientMetadata;
                             _a = session.getAccessToken().decodePayload().scope, scope = _a === void 0 ? '' : _a;
                             if (scope.split(' ').includes(USER_ADMIN_SCOPE)) {
-                                user.getUserData(function (err, data) { return __awaiter(_this, void 0, void 0, function () {
+                                internalUser.getUserData(function (err, data) { return __awaiter(_this, void 0, void 0, function () {
                                     var cleanUpError_5, preferredMFA, attributeList, i, attribute, userAttribute, attributes;
                                     return __generator(this, function (_a) {
                                         switch (_a.label) {
@@ -1504,7 +1541,7 @@ var InternalAuthClass = /** @class */ (function () {
                                                 _a.label = 1;
                                             case 1:
                                                 _a.trys.push([1, 3, , 4]);
-                                                return [4 /*yield*/, this.cleanUpInvalidSession(user)];
+                                                return [4 /*yield*/, this.cleanUpInvalidSession(internalUser, userAgentValue_2)];
                                             case 2:
                                                 _a.sent();
                                                 return [3 /*break*/, 4];
@@ -1516,7 +1553,7 @@ var InternalAuthClass = /** @class */ (function () {
                                                 rej(err);
                                                 return [3 /*break*/, 6];
                                             case 5:
-                                                res(user);
+                                                res(internalUser);
                                                 _a.label = 6;
                                             case 6: return [2 /*return*/];
                                             case 7:
@@ -1531,16 +1568,16 @@ var InternalAuthClass = /** @class */ (function () {
                                                     attributeList.push(userAttribute);
                                                 }
                                                 attributes = this.attributesToObject(attributeList);
-                                                Object.assign(user, { attributes: attributes, preferredMFA: preferredMFA });
-                                                return [2 /*return*/, res(user)];
+                                                Object.assign(internalUser, { attributes: attributes, preferredMFA: preferredMFA });
+                                                return [2 /*return*/, res(internalUser)];
                                         }
                                     });
-                                }); }, { bypassCache: bypassCache, clientMetadata: clientMetadata });
+                                }); }, { bypassCache: bypassCache, clientMetadata: clientMetadata }, userAgentValue_2);
                             }
                             else {
                                 logger.debug("Unable to get the user data because the " + USER_ADMIN_SCOPE + " " +
                                     "is not in the scopes of the access token");
-                                return [2 /*return*/, res(user)];
+                                return [2 /*return*/, res(internalUser)];
                             }
                             return [3 /*break*/, 8];
                         case 7:
@@ -1567,6 +1604,9 @@ var InternalAuthClass = /** @class */ (function () {
      * @return - A promise resolves to current authenticated CognitoUser if success
      */
     InternalAuthClass.prototype.currentAuthenticatedUser = function (params, customUserAgentDetails) {
+        return this._currentAuthenticatedUser(params, customUserAgentDetails);
+    };
+    InternalAuthClass.prototype._currentAuthenticatedUser = function (params, customUserAgentDetails) {
         return __awaiter(this, void 0, void 0, function () {
             var federatedUser, e_8, federatedInfo, user, e_9;
             return __generator(this, function (_a) {
@@ -1605,7 +1645,7 @@ var InternalAuthClass = /** @class */ (function () {
                         _a.label = 6;
                     case 6:
                         _a.trys.push([6, 8, , 9]);
-                        return [4 /*yield*/, this.currentUserPoolUser(params)];
+                        return [4 /*yield*/, this._currentUserPoolUser(params, getAuthUserAgentDetails(AuthAction.CurrentAuthenticatedUser, customUserAgentDetails))];
                     case 7:
                         user = _a.sent();
                         return [3 /*break*/, 9];
@@ -1630,7 +1670,11 @@ var InternalAuthClass = /** @class */ (function () {
      * @return - A promise resolves to session object if success
      */
     InternalAuthClass.prototype.currentSession = function (customUserAgentDetails) {
+        return this._currentSession(customUserAgentDetails);
+    };
+    InternalAuthClass.prototype._currentSession = function (customUserAgentDetails) {
         var that = this;
+        var userAgentDetails = getAuthUserAgentDetails(AuthAction.CurrentSession, customUserAgentDetails);
         logger.debug('Getting current session');
         // Purposely not calling the reject method here because we don't need a console error
         if (!this.userPool) {
@@ -1638,10 +1682,10 @@ var InternalAuthClass = /** @class */ (function () {
         }
         return new Promise(function (res, rej) {
             that
-                .currentUserPoolUser()
+                ._currentUserPoolUser(undefined, userAgentDetails)
                 .then(function (user) {
                 that
-                    .userSession(user)
+                    ._userSession(getAmplifyUserAgent(userAgentDetails), user)
                     .then(function (session) {
                     res(session);
                     return;
@@ -1659,14 +1703,14 @@ var InternalAuthClass = /** @class */ (function () {
             });
         });
     };
-    InternalAuthClass.prototype._userSession = function (user) {
+    InternalAuthClass.prototype._userSession = function (userAgentValue, internalUser) {
         return __awaiter(this, void 0, void 0, function () {
             var clientMetadata, userSession;
             var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        if (!user) {
+                        if (!internalUser) {
                             logger.debug('the user is null');
                             return [2 /*return*/, this.rejectAuthError(AuthErrorTypes.NoUserSession)];
                         }
@@ -1675,18 +1719,18 @@ var InternalAuthClass = /** @class */ (function () {
                         // This solution assumes users will always call this function with the same CognitoUser instance.
                         if (this.inflightSessionPromiseCounter === 0) {
                             this.inflightSessionPromise = new Promise(function (res, rej) {
-                                user.getSession(function (err, session) { return __awaiter(_this, void 0, void 0, function () {
+                                internalUser.getSession(function (err, session) { return __awaiter(_this, void 0, void 0, function () {
                                     var cleanUpError_6;
                                     return __generator(this, function (_a) {
                                         switch (_a.label) {
                                             case 0:
                                                 if (!err) return [3 /*break*/, 5];
-                                                logger.debug('Failed to get the session from user', user);
+                                                logger.debug('Failed to get the session from user', internalUser);
                                                 if (!this.isSessionInvalid(err)) return [3 /*break*/, 4];
                                                 _a.label = 1;
                                             case 1:
                                                 _a.trys.push([1, 3, , 4]);
-                                                return [4 /*yield*/, this.cleanUpInvalidSession(user)];
+                                                return [4 /*yield*/, this.cleanUpInvalidSession(internalUser, userAgentValue)];
                                             case 2:
                                                 _a.sent();
                                                 return [3 /*break*/, 4];
@@ -1703,7 +1747,7 @@ var InternalAuthClass = /** @class */ (function () {
                                                 return [2 /*return*/];
                                         }
                                     });
-                                }); }, { clientMetadata: clientMetadata });
+                                }); }, { clientMetadata: clientMetadata }, userAgentValue);
                             });
                         }
                         this.inflightSessionPromiseCounter++;
@@ -1715,7 +1759,7 @@ var InternalAuthClass = /** @class */ (function () {
                         userSession = _a.sent();
                         // Set private member. Avoid user.setSignInUserSession() to prevent excessive localstorage refresh.
                         // @ts-ignore
-                        user.signInUserSession = userSession;
+                        internalUser.signInUserSession = userSession;
                         return [2 /*return*/, userSession];
                     case 3:
                         this.inflightSessionPromiseCounter--;
@@ -1732,7 +1776,7 @@ var InternalAuthClass = /** @class */ (function () {
      * @return - A promise resolves to the session
      */
     InternalAuthClass.prototype.userSession = function (user, customUserAgentDetails) {
-        return this._userSession(user);
+        return this._userSession(getAuthUserAgentValue(AuthAction.UserSession, customUserAgentDetails), user);
     };
     /**
      * Get authenticated credentials of current user.
@@ -1771,7 +1815,7 @@ var InternalAuthClass = /** @class */ (function () {
                             return [2 /*return*/, this.Credentials.refreshFederatedToken(federatedInfo)];
                         }
                         else {
-                            return [2 /*return*/, this.currentSession()
+                            return [2 /*return*/, this._currentSession(getAuthUserAgentDetails(AuthAction.CurrentUserCredentials, customUserAgentDetails))
                                     .then(function (session) {
                                     logger.debug('getting session success', session);
                                     return _this.Credentials.set(session, 'session');
@@ -1794,19 +1838,26 @@ var InternalAuthClass = /** @class */ (function () {
      * Initiate an attribute confirmation request
      * @param {Object} user - The CognitoUser
      * @param {Object} attr - The attributes to be verified
+     * @param {ClientMetaData} clientMetadata - optional client metadata, defaults to config
+     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
      * @return - A promise resolves to callback data if success
      */
     InternalAuthClass.prototype.verifyUserAttribute = function (user, attr, clientMetadata, customUserAgentDetails) {
         if (clientMetadata === void 0) { clientMetadata = this._config.clientMetadata; }
+        return this._verifyUserAttribute(user, attr, clientMetadata, customUserAgentDetails);
+    };
+    InternalAuthClass.prototype._verifyUserAttribute = function (user, attr, clientMetadata, customUserAgentDetails) {
+        if (clientMetadata === void 0) { clientMetadata = this._config.clientMetadata; }
+        var internalUser = user;
         return new Promise(function (resolve, reject) {
-            user.getAttributeVerificationCode(attr, {
+            internalUser.getAttributeVerificationCode(attr, {
                 onSuccess: function (success) {
                     return resolve(success);
                 },
                 onFailure: function (err) {
                     return reject(err);
                 },
-            }, clientMetadata);
+            }, clientMetadata, getAuthUserAgentValue(AuthAction.VerifyUserAttribute, customUserAgentDetails));
         });
     };
     /**
@@ -1818,11 +1869,15 @@ var InternalAuthClass = /** @class */ (function () {
      * @return - A promise resolves to callback data if success
      */
     InternalAuthClass.prototype.verifyUserAttributeSubmit = function (user, attr, code, customUserAgentDetails) {
+        return this._verifyUserAttributeSubmit(user, attr, code, customUserAgentDetails);
+    };
+    InternalAuthClass.prototype._verifyUserAttributeSubmit = function (user, attr, code, customUserAgentDetails) {
         if (!code) {
             return this.rejectAuthError(AuthErrorTypes.EmptyCode);
         }
+        var internalUser = user;
         return new Promise(function (resolve, reject) {
-            user.verifyAttribute(attr, code, {
+            internalUser.verifyAttribute(attr, code, {
                 onSuccess: function (data) {
                     resolve(data);
                     return;
@@ -1831,14 +1886,17 @@ var InternalAuthClass = /** @class */ (function () {
                     reject(err);
                     return;
                 },
-            });
+            }, getAuthUserAgentValue(AuthAction.VerifyUserAttributeSubmit, customUserAgentDetails));
         });
     };
     InternalAuthClass.prototype.verifyCurrentUserAttribute = function (attr, customUserAgentDetails) {
+        var userAgentDetails = getAuthUserAgentDetails(AuthAction.VerifyCurrentUserAttribute, customUserAgentDetails);
         var that = this;
         return that
-            .currentUserPoolUser()
-            .then(function (user) { return that.verifyUserAttribute(user, attr); });
+            ._currentUserPoolUser(undefined, userAgentDetails)
+            .then(function (user) {
+            return that._verifyUserAttribute(user, attr, undefined, userAgentDetails);
+        });
     };
     /**
      * Confirm current user's attribute using a confirmation code
@@ -1848,12 +1906,15 @@ var InternalAuthClass = /** @class */ (function () {
      * @return - A promise resolves to callback data if success
      */
     InternalAuthClass.prototype.verifyCurrentUserAttributeSubmit = function (attr, code, customUserAgentDetails) {
+        var userAgentDetails = getAuthUserAgentDetails(AuthAction.VerifyCurrentUserAttributeSubmit, customUserAgentDetails);
         var that = this;
         return that
-            .currentUserPoolUser()
-            .then(function (user) { return that.verifyUserAttributeSubmit(user, attr, code); });
+            ._currentUserPoolUser(undefined, userAgentDetails)
+            .then(function (user) {
+            return that._verifyUserAttributeSubmit(user, attr, code, userAgentDetails);
+        });
     };
-    InternalAuthClass.prototype.cognitoIdentitySignOut = function (opts, user) {
+    InternalAuthClass.prototype.cognitoIdentitySignOut = function (opts, internalUser, userAgentValue) {
         return __awaiter(this, void 0, void 0, function () {
             var e_11, isSignedInHostedUI;
             var _this = this;
@@ -1874,11 +1935,11 @@ var InternalAuthClass = /** @class */ (function () {
                             this._storage.getItem('amplify-signin-with-hostedUI') === 'true';
                         return [2 /*return*/, new Promise(function (res, rej) {
                                 if (opts && opts.global) {
-                                    logger.debug('user global sign out', user);
+                                    logger.debug('user global sign out', internalUser);
                                     // in order to use global signout
                                     // we must validate the user as an authenticated user by using getSession
                                     var clientMetadata = _this._config.clientMetadata; // TODO: verify behavior if this is override during signIn
-                                    user.getSession(function (err, result) { return __awaiter(_this, void 0, void 0, function () {
+                                    internalUser.getSession(function (err, result) { return __awaiter(_this, void 0, void 0, function () {
                                         var cleanUpError_7;
                                         var _this = this;
                                         return __generator(this, function (_a) {
@@ -1890,7 +1951,7 @@ var InternalAuthClass = /** @class */ (function () {
                                                     _a.label = 1;
                                                 case 1:
                                                     _a.trys.push([1, 3, , 4]);
-                                                    return [4 /*yield*/, this.cleanUpInvalidSession(user)];
+                                                    return [4 /*yield*/, this.cleanUpInvalidSession(internalUser, userAgentValue)];
                                                 case 2:
                                                     _a.sent();
                                                     return [3 /*break*/, 4];
@@ -1900,7 +1961,7 @@ var InternalAuthClass = /** @class */ (function () {
                                                     return [2 /*return*/];
                                                 case 4: return [2 /*return*/, rej(err)];
                                                 case 5:
-                                                    user.globalSignOut({
+                                                    internalUser.globalSignOut({
                                                         onSuccess: function (data) {
                                                             logger.debug('global sign out success');
                                                             if (isSignedInHostedUI) {
@@ -1914,22 +1975,22 @@ var InternalAuthClass = /** @class */ (function () {
                                                             logger.debug('global sign out failed', err);
                                                             return rej(err);
                                                         },
-                                                    });
+                                                    }, userAgentValue);
                                                     return [2 /*return*/];
                                             }
                                         });
-                                    }); }, { clientMetadata: clientMetadata });
+                                    }); }, { clientMetadata: clientMetadata }, userAgentValue);
                                 }
                                 else {
-                                    logger.debug('user sign out', user);
-                                    user.signOut(function () {
+                                    logger.debug('user sign out', internalUser);
+                                    internalUser.signOut(function () {
                                         if (isSignedInHostedUI) {
                                             _this.oAuthSignOutRedirect(res, rej);
                                         }
                                         else {
                                             return res();
                                         }
-                                    });
+                                    }, userAgentValue);
                                 }
                             })];
                 }
@@ -1962,7 +2023,7 @@ var InternalAuthClass = /** @class */ (function () {
      */
     InternalAuthClass.prototype.signOut = function (opts, customUserAgentDetails) {
         return __awaiter(this, void 0, void 0, function () {
-            var e_12, user;
+            var e_12, internalUser;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -1977,9 +2038,9 @@ var InternalAuthClass = /** @class */ (function () {
                         return [3 /*break*/, 3];
                     case 3:
                         if (!this.userPool) return [3 /*break*/, 7];
-                        user = this.userPool.getCurrentUser();
-                        if (!user) return [3 /*break*/, 5];
-                        return [4 /*yield*/, this.cognitoIdentitySignOut(opts, user)];
+                        internalUser = this.userPool.getCurrentUser();
+                        if (!internalUser) return [3 /*break*/, 5];
+                        return [4 /*yield*/, this.cognitoIdentitySignOut(opts, internalUser, getAuthUserAgentValue(AuthAction.SignOut, customUserAgentDetails))];
                     case 4:
                         _a.sent();
                         return [3 /*break*/, 6];
@@ -2031,9 +2092,11 @@ var InternalAuthClass = /** @class */ (function () {
     InternalAuthClass.prototype.changePassword = function (user, oldPassword, newPassword, clientMetadata, customUserAgentDetails) {
         var _this = this;
         if (clientMetadata === void 0) { clientMetadata = this._config.clientMetadata; }
+        var internalUser = user;
+        var userAgentValue = getAuthUserAgentValue(AuthAction.ChangePassword, customUserAgentDetails);
         return new Promise(function (resolve, reject) {
-            _this.userSession(user).then(function (session) {
-                user.changePassword(oldPassword, newPassword, function (err, data) {
+            _this._userSession(userAgentValue, internalUser).then(function (session) {
+                internalUser.changePassword(oldPassword, newPassword, function (err, data) {
                     if (err) {
                         logger.debug('change password failure', err);
                         return reject(err);
@@ -2041,7 +2104,7 @@ var InternalAuthClass = /** @class */ (function () {
                     else {
                         return resolve(data);
                     }
-                }, clientMetadata);
+                }, clientMetadata, userAgentValue);
             });
         });
     };
@@ -2060,9 +2123,9 @@ var InternalAuthClass = /** @class */ (function () {
         if (!username) {
             return this.rejectAuthError(AuthErrorTypes.EmptyUsername);
         }
-        var user = this.createCognitoUser(username);
+        var internalUser = this.createCognitoUser(username);
         return new Promise(function (resolve, reject) {
-            user.forgotPassword({
+            internalUser.forgotPassword({
                 onSuccess: function () {
                     resolve();
                     return;
@@ -2074,11 +2137,11 @@ var InternalAuthClass = /** @class */ (function () {
                     return;
                 },
                 inputVerificationCode: function (data) {
-                    dispatchAuthEvent('forgotPassword', user, username + " has initiated forgot password flow");
+                    dispatchAuthEvent('forgotPassword', internalUser, username + " has initiated forgot password flow");
                     resolve(data);
                     return;
                 },
-            }, clientMetadata);
+            }, clientMetadata, getAuthUserAgentValue(AuthAction.ForgotPassword, customUserAgentDetails));
         });
     };
     /**
@@ -2104,11 +2167,11 @@ var InternalAuthClass = /** @class */ (function () {
         if (!password) {
             return this.rejectAuthError(AuthErrorTypes.EmptyPassword);
         }
-        var user = this.createCognitoUser(username);
+        var internalUser = this.createCognitoUser(username);
         return new Promise(function (resolve, reject) {
-            user.confirmPassword(code, password, {
+            internalUser.confirmPassword(code, password, {
                 onSuccess: function (success) {
-                    dispatchAuthEvent('forgotPasswordSubmit', user, username + " forgotPasswordSubmit successful");
+                    dispatchAuthEvent('forgotPasswordSubmit', internalUser, username + " forgotPasswordSubmit successful");
                     resolve(success);
                     return;
                 },
@@ -2117,7 +2180,7 @@ var InternalAuthClass = /** @class */ (function () {
                     reject(err);
                     return;
                 },
-            }, clientMetadata);
+            }, clientMetadata, getAuthUserAgentValue(AuthAction.ForgotPasswordSubmit, customUserAgentDetails));
         });
     };
     /**
@@ -2128,24 +2191,23 @@ var InternalAuthClass = /** @class */ (function () {
      */
     InternalAuthClass.prototype.currentUserInfo = function (customUserAgentDetails) {
         return __awaiter(this, void 0, void 0, function () {
-            var source, user, attributes, userAttrs, credentials, e_13, info, err_2, user;
+            var source, userAgentDetails, internalUser, attributes, userAttrs, credentials, e_13, info, err_2, user;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         source = this.Credentials.getCredSource();
+                        userAgentDetails = getAuthUserAgentDetails(AuthAction.CurrentUserInfo, customUserAgentDetails);
                         if (!(!source || source === 'aws' || source === 'userPool')) return [3 /*break*/, 9];
-                        return [4 /*yield*/, this.currentUserPoolUser().catch(function (err) {
-                                return logger.error(err);
-                            })];
+                        return [4 /*yield*/, this._currentUserPoolUser(undefined, userAgentDetails).catch(function (err) { return logger.error(err); })];
                     case 1:
-                        user = _a.sent();
-                        if (!user) {
+                        internalUser = _a.sent();
+                        if (!internalUser) {
                             return [2 /*return*/, null];
                         }
                         _a.label = 2;
                     case 2:
                         _a.trys.push([2, 8, , 9]);
-                        return [4 /*yield*/, this.userAttributes(user)];
+                        return [4 /*yield*/, this._userAttributes(internalUser, userAgentDetails)];
                     case 3:
                         attributes = _a.sent();
                         userAttrs = this.attributesToObject(attributes);
@@ -2164,7 +2226,7 @@ var InternalAuthClass = /** @class */ (function () {
                     case 7:
                         info = {
                             id: credentials ? credentials.identityId : undefined,
-                            username: user.getUsername(),
+                            username: internalUser.getUsername(),
                             attributes: userAttrs,
                         };
                         return [2 /*return*/, info];
@@ -2217,6 +2279,7 @@ var InternalAuthClass = /** @class */ (function () {
                             redirect_uri = isCognitoHostedOpts(this._config.oauth)
                                 ? this._config.oauth.redirectSignIn
                                 : this._config.oauth.redirectUri;
+                            this._storage.setItem('aws-amplify-federatedUserAgent', getAuthUserAgentValue(AuthAction.FederatedSignIn, customUserAgentDetails));
                             this._oAuthHandler.oauthSignIn(this._config.oauth.responseType, this._config.oauth.domain, redirect_uri, client_id, provider, customState);
                         }
                         return [3 /*break*/, 4];
@@ -2234,7 +2297,7 @@ var InternalAuthClass = /** @class */ (function () {
                         return [4 /*yield*/, this.Credentials.set({ provider: provider, token: token, identity_id: identity_id, user: user, expires_at: expires_at }, 'federation')];
                     case 2:
                         credentials = _a.sent();
-                        return [4 /*yield*/, this.currentAuthenticatedUser()];
+                        return [4 /*yield*/, this._currentAuthenticatedUser()];
                     case 3:
                         currentUser = _a.sent();
                         dispatchAuthEvent('signIn', currentUser, "A user " + currentUser.username + " has been signed in");
@@ -2251,7 +2314,7 @@ var InternalAuthClass = /** @class */ (function () {
      */
     InternalAuthClass.prototype._handleAuthResponse = function (URL) {
         return __awaiter(this, void 0, void 0, function () {
-            var currentUrl, hasCodeOrError, hasTokenOrError, _a, accessToken, idToken, refreshToken, state, session, credentials, isCustomStateIncluded, currentUser, customState, err_3;
+            var currentUrl, hasCodeOrError, hasTokenOrError, userAgentValue, _a, accessToken, idToken, refreshToken, state, session, credentials, isCustomStateIncluded, currentUser, customState, err_3;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
@@ -2285,10 +2348,12 @@ var InternalAuthClass = /** @class */ (function () {
                         });
                         if (!(hasCodeOrError || hasTokenOrError)) return [3 /*break*/, 7];
                         this._storage.setItem('amplify-redirected-from-hosted-ui', 'true');
+                        userAgentValue = this._storage.getItem('aws-amplify-federatedUserAgent') || undefined;
+                        this._storage.removeItem('aws-amplify-federatedUserAgent');
                         _b.label = 2;
                     case 2:
                         _b.trys.push([2, 6, , 7]);
-                        return [4 /*yield*/, this._oAuthHandler.handleAuthResponse(currentUrl)];
+                        return [4 /*yield*/, this._oAuthHandler.handleAuthResponse(currentUrl, userAgentValue)];
                     case 3:
                         _a = _b.sent(), accessToken = _a.accessToken, idToken = _a.idToken, refreshToken = _a.refreshToken, state = _a.state;
                         session = new CognitoUserSession({
@@ -2385,11 +2450,11 @@ var InternalAuthClass = /** @class */ (function () {
         };
         userData.Storage = this._storage;
         var authenticationFlowType = this._config.authenticationFlowType;
-        var user = new CognitoUser(userData);
+        var internalUser = new InternalCognitoUser(userData);
         if (authenticationFlowType) {
-            user.setAuthenticationFlowType(authenticationFlowType);
+            internalUser.setAuthenticationFlowType(authenticationFlowType);
         }
-        return user;
+        return internalUser;
     };
     InternalAuthClass.prototype._isValidAuthStorage = function (obj) {
         // We need to check if the obj has the functions of Storage
@@ -2416,23 +2481,26 @@ var InternalAuthClass = /** @class */ (function () {
     };
     InternalAuthClass.prototype.rememberDevice = function (customUserAgentDetails) {
         return __awaiter(this, void 0, void 0, function () {
-            var currUser, error_2;
+            var internalUser, userAgentDetails, error_2;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        _a.trys.push([0, 2, , 3]);
-                        return [4 /*yield*/, this.currentUserPoolUser()];
+                        userAgentDetails = getAuthUserAgentDetails(AuthAction.RememberDevice, customUserAgentDetails);
+                        _a.label = 1;
                     case 1:
-                        currUser = _a.sent();
-                        return [3 /*break*/, 3];
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, this._currentUserPoolUser(undefined, userAgentDetails)];
                     case 2:
+                        internalUser = _a.sent();
+                        return [3 /*break*/, 4];
+                    case 3:
                         error_2 = _a.sent();
                         logger.debug('The user is not authenticated by the error', error_2);
                         return [2 /*return*/, Promise.reject('The user is not authenticated')];
-                    case 3:
-                        currUser.getCachedDeviceKeyAndPassword();
+                    case 4:
+                        internalUser.getCachedDeviceKeyAndPassword();
                         return [2 /*return*/, new Promise(function (res, rej) {
-                                currUser.setDeviceStatusRemembered({
+                                internalUser.setDeviceStatusRemembered({
                                     onSuccess: function (data) {
                                         res(data);
                                     },
@@ -2447,7 +2515,7 @@ var InternalAuthClass = /** @class */ (function () {
                                             rej(err);
                                         }
                                     },
-                                });
+                                }, getAmplifyUserAgent(userAgentDetails));
                             })];
                 }
             });
@@ -2455,23 +2523,26 @@ var InternalAuthClass = /** @class */ (function () {
     };
     InternalAuthClass.prototype.forgetDevice = function (customUserAgentDetails) {
         return __awaiter(this, void 0, void 0, function () {
-            var currUser, error_3;
+            var internalUser, userAgentDetails, error_3;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        _a.trys.push([0, 2, , 3]);
-                        return [4 /*yield*/, this.currentUserPoolUser()];
+                        userAgentDetails = getAuthUserAgentDetails(AuthAction.ForgetDevice, customUserAgentDetails);
+                        _a.label = 1;
                     case 1:
-                        currUser = _a.sent();
-                        return [3 /*break*/, 3];
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, this._currentUserPoolUser(undefined, userAgentDetails)];
                     case 2:
+                        internalUser = _a.sent();
+                        return [3 /*break*/, 4];
+                    case 3:
                         error_3 = _a.sent();
                         logger.debug('The user is not authenticated by the error', error_3);
                         return [2 /*return*/, Promise.reject('The user is not authenticated')];
-                    case 3:
-                        currUser.getCachedDeviceKeyAndPassword();
+                    case 4:
+                        internalUser.getCachedDeviceKeyAndPassword();
                         return [2 /*return*/, new Promise(function (res, rej) {
-                                currUser.forgetDevice({
+                                internalUser.forgetDevice({
                                     onSuccess: function (data) {
                                         res(data);
                                     },
@@ -2486,7 +2557,7 @@ var InternalAuthClass = /** @class */ (function () {
                                             rej(err);
                                         }
                                     },
-                                });
+                                }, getAmplifyUserAgent(userAgentDetails));
                             })];
                 }
             });
@@ -2494,21 +2565,24 @@ var InternalAuthClass = /** @class */ (function () {
     };
     InternalAuthClass.prototype.fetchDevices = function (customUserAgentDetails) {
         return __awaiter(this, void 0, void 0, function () {
-            var currUser, error_4;
+            var internalUser, userAgentDetails, error_4;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        _a.trys.push([0, 2, , 3]);
-                        return [4 /*yield*/, this.currentUserPoolUser()];
+                        userAgentDetails = getAuthUserAgentDetails(AuthAction.FetchDevices, customUserAgentDetails);
+                        _a.label = 1;
                     case 1:
-                        currUser = _a.sent();
-                        return [3 /*break*/, 3];
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, this._currentUserPoolUser(undefined, userAgentDetails)];
                     case 2:
+                        internalUser = _a.sent();
+                        return [3 /*break*/, 4];
+                    case 3:
                         error_4 = _a.sent();
                         logger.debug('The user is not authenticated by the error', error_4);
                         throw new Error('The user is not authenticated');
-                    case 3:
-                        currUser.getCachedDeviceKeyAndPassword();
+                    case 4:
+                        internalUser.getCachedDeviceKeyAndPassword();
                         return [2 /*return*/, new Promise(function (res, rej) {
                                 var cb = {
                                     onSuccess: function (data) {
@@ -2537,7 +2611,7 @@ var InternalAuthClass = /** @class */ (function () {
                                         }
                                     },
                                 };
-                                currUser.listDevices(MAX_DEVICES, null, cb);
+                                internalUser.listDevices(MAX_DEVICES, null, cb, getAmplifyUserAgent(userAgentDetails));
                             })];
                 }
             });