@connectedxm/admin-sdk 11.22.0 → 11.23.1

package/dist/common.js

@@ -5,7 +5,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.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/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.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/configuration.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.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/api.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.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -8615,6 +8615,14 @@ export interface GetLoginDevices200Response {
 export declare enum GetLoginDevices200ResponseStatusEnum {
     Ok = "ok"
 }
+export interface GetLoginMfa200Response {
+    'status': GetLoginMfa200ResponseStatusEnum;
+    'message': string;
+    'data': LoginMfa;
+}
+export declare enum GetLoginMfa200ResponseStatusEnum {
+    Ok = "ok"
+}
 export interface GetLogins200Response {
     'status': GetLogins200ResponseStatusEnum;
     'message': string;
@@ -10091,6 +10099,16 @@ export interface LoginAllOfCount {
     'accounts': number;
     'devices': number;
 }
+export interface LoginMfa {
+    'supported': boolean;
+    'methods': Array<LoginMfaMethod>;
+    'preferred': LoginMfaMethod | null;
+}
+export declare enum LoginMfaMethod {
+    Totp = "totp",
+    Sms = "sms",
+    Email = "email"
+}
 export interface MarkNotificationsReadInputs {
     'notificationIds': Array<string>;
 }
@@ -12527,6 +12545,9 @@ export interface SeriesUpdateInputs {
     'paymentIntegrationId'?: string | null;
     'entityId'?: string | null;
 }
+export interface SetLoginPreferredMfaRequest {
+    'method': LoginMfaMethod;
+}
 export interface SideEffect {
     'id': string;
     'newPassOfPassTypeId': string | null;
@@ -65186,6 +65207,14 @@ export declare const LoginsApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     deleteLogin: (username: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Removes two-factor authentication from the email login with the given username and returns its updated MFA settings. It turns TOTP off and deletes it, so nothing is left to turn back on. The user can then sign in with their password and set up two-factor authentication again. Removing when none is set up succeeds. Requires read and update permissions on accounts.
+     * @summary Remove a login\'s two-factor authentication
+     * @param {string} username The username identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteLoginMfaToken: (username: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
      * @summary Get a single login
@@ -65218,6 +65247,14 @@ export declare const LoginsApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     getLoginDevices: (username: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * 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
@@ -65230,6 +65267,15 @@ export declare const LoginsApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     getLogins: (accountId?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Makes the given MFA method the preferred one for the email login with the given username, and returns its updated MFA settings. The method must already be turned on for the login; any other method returns a 400, so this can\'t revive a method the user turned off. 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: string, setLoginPreferredMfaRequest: SetLoginPreferredMfaRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * 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
@@ -65269,6 +65315,14 @@ export declare const LoginsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteLogin(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLogin200Response>>;
+    /**
+     * Removes two-factor authentication from the email login with the given username and returns its updated MFA settings. It turns TOTP off and deletes it, so nothing is left to turn back on. The user can then sign in with their password and set up two-factor authentication again. Removing when none is set up succeeds. Requires read and update permissions on accounts.
+     * @summary Remove a login\'s two-factor authentication
+     * @param {string} username The username identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteLoginMfaToken(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginMfa200Response>>;
     /**
      * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
      * @summary Get a single login
@@ -65301,6 +65355,14 @@ export declare const LoginsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getLoginDevices(username: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginDevices200Response>>;
+    /**
+     * 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: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginMfa200Response>>;
     /**
      * 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
@@ -65313,6 +65375,15 @@ export declare const LoginsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getLogins(accountId?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLogins200Response>>;
+    /**
+     * Makes the given MFA method the preferred one for the email login with the given username, and returns its updated MFA settings. The method must already be turned on for the login; any other method returns a 400, so this can\'t revive a method the user turned off. 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: string, setLoginPreferredMfaRequest: SetLoginPreferredMfaRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginMfa200Response>>;
     /**
      * 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
@@ -65352,6 +65423,14 @@ export declare const LoginsApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     deleteLogin(requestParameters: LoginsApiDeleteLoginRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLogin200Response>;
+    /**
+     * Removes two-factor authentication from the email login with the given username and returns its updated MFA settings. It turns TOTP off and deletes it, so nothing is left to turn back on. The user can then sign in with their password and set up two-factor authentication again. Removing when none is set up succeeds. Requires read and update permissions on accounts.
+     * @summary Remove a login\'s two-factor authentication
+     * @param {LoginsApiDeleteLoginMfaTokenRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteLoginMfaToken(requestParameters: LoginsApiDeleteLoginMfaTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginMfa200Response>;
     /**
      * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
      * @summary Get a single login
@@ -65376,6 +65455,14 @@ export declare const LoginsApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     getLoginDevices(requestParameters: LoginsApiGetLoginDevicesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginDevices200Response>;
+    /**
+     * 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: LoginsApiGetLoginMfaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginMfa200Response>;
     /**
      * 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
@@ -65384,6 +65471,14 @@ export declare const LoginsApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     getLogins(requestParameters?: LoginsApiGetLoginsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLogins200Response>;
+    /**
+     * Makes the given MFA method the preferred one for the email login with the given username, and returns its updated MFA settings. The method must already be turned on for the login; any other method returns a 400, so this can\'t revive a method the user turned off. 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: LoginsApiSetLoginPreferredMfaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginMfa200Response>;
     /**
      * 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
@@ -65419,6 +65514,15 @@ export interface LoginsApiDeleteLoginRequest {
      */
     readonly username: string;
 }
+/**
+ * Request parameters for deleteLoginMfaToken operation in LoginsApi.
+ */
+export interface LoginsApiDeleteLoginMfaTokenRequest {
+    /**
+     * The username identifier
+     */
+    readonly username: string;
+}
 /**
  * Request parameters for getLogin operation in LoginsApi.
  */
@@ -65478,6 +65582,15 @@ export interface LoginsApiGetLoginDevicesRequest {
      */
     readonly search?: string;
 }
+/**
+ * Request parameters for getLoginMfa operation in LoginsApi.
+ */
+export interface LoginsApiGetLoginMfaRequest {
+    /**
+     * The username identifier
+     */
+    readonly username: string;
+}
 /**
  * Request parameters for getLogins operation in LoginsApi.
  */
@@ -65503,6 +65616,16 @@ export interface LoginsApiGetLoginsRequest {
      */
     readonly search?: string;
 }
+/**
+ * Request parameters for setLoginPreferredMfa operation in LoginsApi.
+ */
+export interface LoginsApiSetLoginPreferredMfaRequest {
+    /**
+     * The username identifier
+     */
+    readonly username: string;
+    readonly setLoginPreferredMfaRequest: SetLoginPreferredMfaRequest;
+}
 /**
  * Request parameters for updateLoginEmail operation in LoginsApi.
  */
@@ -65543,6 +65666,14 @@ export declare class LoginsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     deleteLogin(requestParameters: LoginsApiDeleteLoginRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLogin200Response, any, {}, any>>;
+    /**
+     * Removes two-factor authentication from the email login with the given username and returns its updated MFA settings. It turns TOTP off and deletes it, so nothing is left to turn back on. The user can then sign in with their password and set up two-factor authentication again. Removing when none is set up succeeds. Requires read and update permissions on accounts.
+     * @summary Remove a login\'s two-factor authentication
+     * @param {LoginsApiDeleteLoginMfaTokenRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteLoginMfaToken(requestParameters: LoginsApiDeleteLoginMfaTokenRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginMfa200Response, any, {}, any>>;
     /**
      * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
      * @summary Get a single login
@@ -65567,6 +65698,14 @@ export declare class LoginsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getLoginDevices(requestParameters: LoginsApiGetLoginDevicesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginDevices200Response, any, {}, any>>;
+    /**
+     * 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: LoginsApiGetLoginMfaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginMfa200Response, any, {}, any>>;
     /**
      * 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
@@ -65575,6 +65714,14 @@ export declare class LoginsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getLogins(requestParameters?: LoginsApiGetLoginsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLogins200Response, any, {}, any>>;
+    /**
+     * Makes the given MFA method the preferred one for the email login with the given username, and returns its updated MFA settings. The method must already be turned on for the login; any other method returns a 400, so this can\'t revive a method the user turned off. 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: LoginsApiSetLoginPreferredMfaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginMfa200Response, any, {}, any>>;
     /**
      * 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/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.1
  *
  *
  * 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,40 @@ export const LoginsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Removes two-factor authentication from the email login with the given username and returns its updated MFA settings. It turns TOTP off and deletes it, so nothing is left to turn back on. The user can then sign in with their password and set up two-factor authentication again. Removing when none is set up succeeds. Requires read and update permissions on accounts.
+         * @summary Remove a login\'s two-factor authentication
+         * @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,
+            };
+        }),
         /**
          * 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 +79532,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 +79616,45 @@ export const LoginsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Makes the given MFA method the preferred one for the email login with the given username, and returns its updated MFA settings. The method must already be turned on for the login; any other method returns a 400, so this can\'t revive a method the user turned off. 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 +79773,22 @@ export const LoginsApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Removes two-factor authentication from the email login with the given username and returns its updated MFA settings. It turns TOTP off and deletes it, so nothing is left to turn back on. The user can then sign in with their password and set up two-factor authentication again. Removing when none is set up succeeds. Requires read and update permissions on accounts.
+         * @summary Remove a login\'s two-factor authentication
+         * @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);
+            });
+        },
         /**
          * 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 +79845,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 +79881,23 @@ export const LoginsApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Makes the given MFA method the preferred one for the email login with the given username, and returns its updated MFA settings. The method must already be turned on for the login; any other method returns a 400, so this can\'t revive a method the user turned off. 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 +79960,16 @@ export const LoginsApiFactory = function (configuration, basePath, axios) {
         deleteLogin(requestParameters, options) {
             return localVarFp.deleteLogin(requestParameters.username, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Removes two-factor authentication from the email login with the given username and returns its updated MFA settings. It turns TOTP off and deletes it, so nothing is left to turn back on. The user can then sign in with their password and set up two-factor authentication again. Removing when none is set up succeeds. Requires read and update permissions on accounts.
+         * @summary Remove a login\'s two-factor authentication
+         * @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));
+        },
         /**
          * 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 +80000,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 +80020,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));
         },
+        /**
+         * Makes the given MFA method the preferred one for the email login with the given username, and returns its updated MFA settings. The method must already be turned on for the login; any other method returns a 400, so this can\'t revive a method the user turned off. 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 +80076,16 @@ export class LoginsApi extends BaseAPI {
     deleteLogin(requestParameters, options) {
         return LoginsApiFp(this.configuration).deleteLogin(requestParameters.username, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Removes two-factor authentication from the email login with the given username and returns its updated MFA settings. It turns TOTP off and deletes it, so nothing is left to turn back on. The user can then sign in with their password and set up two-factor authentication again. Removing when none is set up succeeds. Requires read and update permissions on accounts.
+     * @summary Remove a login\'s two-factor authentication
+     * @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));
+    }
     /**
      * 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 +80116,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 +80136,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));
     }
+    /**
+     * Makes the given MFA method the preferred one for the email login with the given username, and returns its updated MFA settings. The method must already be turned on for the login; any other method returns a 400, so this can\'t revive a method the user turned off. 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.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).