@connectedxm/admin-sdk 11.22.0 → 11.23.0

package/dist/esm/api.js

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 11.22.0
+ * The version of the OpenAPI document: 11.23.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1627,6 +1627,10 @@ export var GetLoginDevices200ResponseStatusEnum;
 (function (GetLoginDevices200ResponseStatusEnum) {
     GetLoginDevices200ResponseStatusEnum["Ok"] = "ok";
 })(GetLoginDevices200ResponseStatusEnum || (GetLoginDevices200ResponseStatusEnum = {}));
+export var GetLoginMfa200ResponseStatusEnum;
+(function (GetLoginMfa200ResponseStatusEnum) {
+    GetLoginMfa200ResponseStatusEnum["Ok"] = "ok";
+})(GetLoginMfa200ResponseStatusEnum || (GetLoginMfa200ResponseStatusEnum = {}));
 export var GetLogins200ResponseStatusEnum;
 (function (GetLogins200ResponseStatusEnum) {
     GetLogins200ResponseStatusEnum["Ok"] = "ok";
@@ -2166,6 +2170,12 @@ export var LocationQuestionOption;
     LocationQuestionOption["CountryState"] = "countryState";
     LocationQuestionOption["CountryStateCity"] = "countryStateCity";
 })(LocationQuestionOption || (LocationQuestionOption = {}));
+export var LoginMfaMethod;
+(function (LoginMfaMethod) {
+    LoginMfaMethod["Totp"] = "totp";
+    LoginMfaMethod["Sms"] = "sms";
+    LoginMfaMethod["Email"] = "email";
+})(LoginMfaMethod || (LoginMfaMethod = {}));
 export var MatchQuestionType;
 (function (MatchQuestionType) {
     MatchQuestionType["Exclude"] = "exclude";
@@ -79354,6 +79364,78 @@ export const LoginsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Deletes the authenticator app (TOTP) registered to the email login with the given username, for a user who lost their device, and returns its updated MFA settings. The user can then sign in with their password and register a new authenticator. Deleting when none is registered succeeds. Requires read and update permissions on accounts.
+         * @summary Delete a login\'s authenticator app
+         * @param {string} username The username identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteLoginMfaToken: (username_1, ...args_1) => __awaiter(this, [username_1, ...args_1], void 0, function* (username, options = {}) {
+            // verify required parameter 'username' is not null or undefined
+            assertParamExists('deleteLoginMfaToken', 'username', username);
+            const localVarPath = `/logins/{username}/mfa/totp`
+                .replace('{username}', encodeURIComponent(String(username)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication ApiKeyAuth required
+            yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
+            // authentication OrganizationId required
+            yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Turns off the given MFA method for the email login with the given username and returns its updated MFA settings. An authenticator app that is turned off stays registered, so the user can turn it back on without setting it up again; use DeleteLoginMfaToken when the device is lost. Requires read and update permissions on accounts.
+         * @summary Turn off one of a login\'s MFA methods
+         * @param {string} username The username identifier
+         * @param {string} method The method identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        disableLoginMfa: (username_1, method_1, ...args_1) => __awaiter(this, [username_1, method_1, ...args_1], void 0, function* (username, method, options = {}) {
+            // verify required parameter 'username' is not null or undefined
+            assertParamExists('disableLoginMfa', 'username', username);
+            // verify required parameter 'method' is not null or undefined
+            assertParamExists('disableLoginMfa', 'method', method);
+            const localVarPath = `/logins/{username}/mfa/{method}/disable`
+                .replace('{username}', encodeURIComponent(String(username)))
+                .replace('{method}', encodeURIComponent(String(method)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication ApiKeyAuth required
+            yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
+            // authentication OrganizationId required
+            yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
          * @summary Get a single login
@@ -79488,6 +79570,40 @@ export const LoginsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Returns the MFA methods the login has turned on and which one is preferred; only email logins support MFA. Each call is a live Cognito lookup that counts the login as a monthly active user, so fetch it only when an admin views a single login, never for lists. Requires the read permission on accounts.
+         * @summary Get a login\'s MFA settings
+         * @param {string} username The username identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getLoginMfa: (username_1, ...args_1) => __awaiter(this, [username_1, ...args_1], void 0, function* (username, options = {}) {
+            // verify required parameter 'username' is not null or undefined
+            assertParamExists('getLoginMfa', 'username', username);
+            const localVarPath = `/logins/{username}/mfa`
+                .replace('{username}', encodeURIComponent(String(username)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication ApiKeyAuth required
+            yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
+            // authentication OrganizationId required
+            yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Returns a paginated list of logins for the organization, optionally filtered by linked account and with search and ordering support; requires the read permission on accounts.
          * @summary List logins
@@ -79538,6 +79654,45 @@ export const LoginsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Turns on the given MFA method for the email login with the given username, makes it the preferred one, and returns its updated MFA settings. The method must be set up for the user and allowed by the user pool. Requires read and update permissions on accounts.
+         * @summary Set a login\'s preferred MFA method
+         * @param {string} username The username identifier
+         * @param {SetLoginPreferredMfaRequest} setLoginPreferredMfaRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        setLoginPreferredMfa: (username_1, setLoginPreferredMfaRequest_1, ...args_1) => __awaiter(this, [username_1, setLoginPreferredMfaRequest_1, ...args_1], void 0, function* (username, setLoginPreferredMfaRequest, options = {}) {
+            // verify required parameter 'username' is not null or undefined
+            assertParamExists('setLoginPreferredMfa', 'username', username);
+            // verify required parameter 'setLoginPreferredMfaRequest' is not null or undefined
+            assertParamExists('setLoginPreferredMfa', 'setLoginPreferredMfaRequest', setLoginPreferredMfaRequest);
+            const localVarPath = `/logins/{username}/mfa/preferred`
+                .replace('{username}', encodeURIComponent(String(username)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication ApiKeyAuth required
+            yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
+            // authentication OrganizationId required
+            yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(setLoginPreferredMfaRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Changes the email address for the given login username in both the database and Cognito, marking the new email as verified, and requires the \"update\" permission on accounts.
          * @summary Update a login\'s email
@@ -79656,6 +79811,39 @@ export const LoginsApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Deletes the authenticator app (TOTP) registered to the email login with the given username, for a user who lost their device, and returns its updated MFA settings. The user can then sign in with their password and register a new authenticator. Deleting when none is registered succeeds. Requires read and update permissions on accounts.
+         * @summary Delete a login\'s authenticator app
+         * @param {string} username The username identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteLoginMfaToken(username, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteLoginMfaToken(username, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['LoginsApi.deleteLoginMfaToken']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         * Turns off the given MFA method for the email login with the given username and returns its updated MFA settings. An authenticator app that is turned off stays registered, so the user can turn it back on without setting it up again; use DeleteLoginMfaToken when the device is lost. Requires read and update permissions on accounts.
+         * @summary Turn off one of a login\'s MFA methods
+         * @param {string} username The username identifier
+         * @param {string} method The method identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        disableLoginMfa(username, method, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.disableLoginMfa(username, method, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['LoginsApi.disableLoginMfa']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
          * @summary Get a single login
@@ -79712,6 +79900,22 @@ export const LoginsApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Returns the MFA methods the login has turned on and which one is preferred; only email logins support MFA. Each call is a live Cognito lookup that counts the login as a monthly active user, so fetch it only when an admin views a single login, never for lists. Requires the read permission on accounts.
+         * @summary Get a login\'s MFA settings
+         * @param {string} username The username identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getLoginMfa(username, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getLoginMfa(username, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['LoginsApi.getLoginMfa']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Returns a paginated list of logins for the organization, optionally filtered by linked account and with search and ordering support; requires the read permission on accounts.
          * @summary List logins
@@ -79732,6 +79936,23 @@ export const LoginsApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Turns on the given MFA method for the email login with the given username, makes it the preferred one, and returns its updated MFA settings. The method must be set up for the user and allowed by the user pool. Requires read and update permissions on accounts.
+         * @summary Set a login\'s preferred MFA method
+         * @param {string} username The username identifier
+         * @param {SetLoginPreferredMfaRequest} setLoginPreferredMfaRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        setLoginPreferredMfa(username, setLoginPreferredMfaRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.setLoginPreferredMfa(username, setLoginPreferredMfaRequest, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['LoginsApi.setLoginPreferredMfa']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Changes the email address for the given login username in both the database and Cognito, marking the new email as verified, and requires the \"update\" permission on accounts.
          * @summary Update a login\'s email
@@ -79794,6 +80015,26 @@ export const LoginsApiFactory = function (configuration, basePath, axios) {
         deleteLogin(requestParameters, options) {
             return localVarFp.deleteLogin(requestParameters.username, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Deletes the authenticator app (TOTP) registered to the email login with the given username, for a user who lost their device, and returns its updated MFA settings. The user can then sign in with their password and register a new authenticator. Deleting when none is registered succeeds. Requires read and update permissions on accounts.
+         * @summary Delete a login\'s authenticator app
+         * @param {LoginsApiDeleteLoginMfaTokenRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteLoginMfaToken(requestParameters, options) {
+            return localVarFp.deleteLoginMfaToken(requestParameters.username, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Turns off the given MFA method for the email login with the given username and returns its updated MFA settings. An authenticator app that is turned off stays registered, so the user can turn it back on without setting it up again; use DeleteLoginMfaToken when the device is lost. Requires read and update permissions on accounts.
+         * @summary Turn off one of a login\'s MFA methods
+         * @param {LoginsApiDisableLoginMfaRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        disableLoginMfa(requestParameters, options) {
+            return localVarFp.disableLoginMfa(requestParameters.username, requestParameters.method, options).then((request) => request(axios, basePath));
+        },
         /**
          * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
          * @summary Get a single login
@@ -79824,6 +80065,16 @@ export const LoginsApiFactory = function (configuration, basePath, axios) {
         getLoginDevices(requestParameters, options) {
             return localVarFp.getLoginDevices(requestParameters.username, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Returns the MFA methods the login has turned on and which one is preferred; only email logins support MFA. Each call is a live Cognito lookup that counts the login as a monthly active user, so fetch it only when an admin views a single login, never for lists. Requires the read permission on accounts.
+         * @summary Get a login\'s MFA settings
+         * @param {LoginsApiGetLoginMfaRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getLoginMfa(requestParameters, options) {
+            return localVarFp.getLoginMfa(requestParameters.username, options).then((request) => request(axios, basePath));
+        },
         /**
          * Returns a paginated list of logins for the organization, optionally filtered by linked account and with search and ordering support; requires the read permission on accounts.
          * @summary List logins
@@ -79834,6 +80085,16 @@ export const LoginsApiFactory = function (configuration, basePath, axios) {
         getLogins(requestParameters = {}, options) {
             return localVarFp.getLogins(requestParameters.accountId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Turns on the given MFA method for the email login with the given username, makes it the preferred one, and returns its updated MFA settings. The method must be set up for the user and allowed by the user pool. Requires read and update permissions on accounts.
+         * @summary Set a login\'s preferred MFA method
+         * @param {LoginsApiSetLoginPreferredMfaRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        setLoginPreferredMfa(requestParameters, options) {
+            return localVarFp.setLoginPreferredMfa(requestParameters.username, requestParameters.setLoginPreferredMfaRequest, options).then((request) => request(axios, basePath));
+        },
         /**
          * Changes the email address for the given login username in both the database and Cognito, marking the new email as verified, and requires the \"update\" permission on accounts.
          * @summary Update a login\'s email
@@ -79880,6 +80141,26 @@ export class LoginsApi extends BaseAPI {
     deleteLogin(requestParameters, options) {
         return LoginsApiFp(this.configuration).deleteLogin(requestParameters.username, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Deletes the authenticator app (TOTP) registered to the email login with the given username, for a user who lost their device, and returns its updated MFA settings. The user can then sign in with their password and register a new authenticator. Deleting when none is registered succeeds. Requires read and update permissions on accounts.
+     * @summary Delete a login\'s authenticator app
+     * @param {LoginsApiDeleteLoginMfaTokenRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteLoginMfaToken(requestParameters, options) {
+        return LoginsApiFp(this.configuration).deleteLoginMfaToken(requestParameters.username, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Turns off the given MFA method for the email login with the given username and returns its updated MFA settings. An authenticator app that is turned off stays registered, so the user can turn it back on without setting it up again; use DeleteLoginMfaToken when the device is lost. Requires read and update permissions on accounts.
+     * @summary Turn off one of a login\'s MFA methods
+     * @param {LoginsApiDisableLoginMfaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    disableLoginMfa(requestParameters, options) {
+        return LoginsApiFp(this.configuration).disableLoginMfa(requestParameters.username, requestParameters.method, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
      * @summary Get a single login
@@ -79910,6 +80191,16 @@ export class LoginsApi extends BaseAPI {
     getLoginDevices(requestParameters, options) {
         return LoginsApiFp(this.configuration).getLoginDevices(requestParameters.username, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Returns the MFA methods the login has turned on and which one is preferred; only email logins support MFA. Each call is a live Cognito lookup that counts the login as a monthly active user, so fetch it only when an admin views a single login, never for lists. Requires the read permission on accounts.
+     * @summary Get a login\'s MFA settings
+     * @param {LoginsApiGetLoginMfaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getLoginMfa(requestParameters, options) {
+        return LoginsApiFp(this.configuration).getLoginMfa(requestParameters.username, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns a paginated list of logins for the organization, optionally filtered by linked account and with search and ordering support; requires the read permission on accounts.
      * @summary List logins
@@ -79920,6 +80211,16 @@ export class LoginsApi extends BaseAPI {
     getLogins(requestParameters = {}, options) {
         return LoginsApiFp(this.configuration).getLogins(requestParameters.accountId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Turns on the given MFA method for the email login with the given username, makes it the preferred one, and returns its updated MFA settings. The method must be set up for the user and allowed by the user pool. Requires read and update permissions on accounts.
+     * @summary Set a login\'s preferred MFA method
+     * @param {LoginsApiSetLoginPreferredMfaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setLoginPreferredMfa(requestParameters, options) {
+        return LoginsApiFp(this.configuration).setLoginPreferredMfa(requestParameters.username, requestParameters.setLoginPreferredMfaRequest, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Changes the email address for the given login username in both the database and Cognito, marking the new email as verified, and requires the \"update\" permission on accounts.
      * @summary Update a login\'s email

package/dist/esm/base.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 11.22.0
+ * The version of the OpenAPI document: 11.23.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/base.js

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 11.22.0
+ * The version of the OpenAPI document: 11.23.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 11.22.0
+ * The version of the OpenAPI document: 11.23.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.js

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 11.22.0
+ * The version of the OpenAPI document: 11.23.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 11.22.0
+ * The version of the OpenAPI document: 11.23.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.js

@@ -3,7 +3,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 11.22.0
+ * The version of the OpenAPI document: 11.23.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/GetLoginMfa200Response.md

@@ -0,0 +1,24 @@
+# GetLoginMfa200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**LoginMfa**](LoginMfa.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetLoginMfa200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetLoginMfa200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/LoginMfa.md

@@ -0,0 +1,24 @@
+# LoginMfa
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**supported** | **boolean** |  | [default to undefined]
+**methods** | [**Array<LoginMfaMethod>**](LoginMfaMethod.md) |  | [default to undefined]
+**preferred** | [**LoginMfaMethod**](LoginMfaMethod.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { LoginMfa } from '@connectedxm/admin-sdk';
+
+const instance: LoginMfa = {
+    supported,
+    methods,
+    preferred,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/LoginMfaMethod.md

@@ -0,0 +1,12 @@
+# LoginMfaMethod
+
+
+## Enum
+
+* `Totp` (value: `'totp'`)
+
+* `Sms` (value: `'sms'`)
+
+* `Email` (value: `'email'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)