@connectedxm/admin-sdk 11.23.0 → 11.23.1

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.23.0
+ * The version of the OpenAPI document: 11.23.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -79365,8 +79365,8 @@ export const LoginsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * 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
+         * 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}
@@ -79398,44 +79398,6 @@ export const LoginsApiAxiosParamCreator = function (configuration) {
                 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
@@ -79655,7 +79617,7 @@ export const LoginsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * 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.
+         * 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
@@ -79812,8 +79774,8 @@ export const LoginsApiFp = function (configuration) {
             });
         },
         /**
-         * 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
+         * 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}
@@ -79827,23 +79789,6 @@ export const LoginsApiFp = function (configuration) {
                 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
@@ -79937,7 +79882,7 @@ export const LoginsApiFp = function (configuration) {
             });
         },
         /**
-         * 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.
+         * 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
@@ -80016,8 +79961,8 @@ export const LoginsApiFactory = function (configuration, basePath, axios) {
             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
+         * 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}
@@ -80025,16 +79970,6 @@ export const LoginsApiFactory = function (configuration, basePath, axios) {
         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
@@ -80086,7 +80021,7 @@ export const LoginsApiFactory = function (configuration, basePath, axios) {
             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.
+         * 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.
@@ -80142,8 +80077,8 @@ export class LoginsApi extends BaseAPI {
         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
+     * 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}
@@ -80151,16 +80086,6 @@ export class LoginsApi extends BaseAPI {
     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
@@ -80212,7 +80137,7 @@ export class LoginsApi extends BaseAPI {
         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.
+     * 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.

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.23.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/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.23.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/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.23.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/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.23.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/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.23.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/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.23.0
+ * The version of the OpenAPI document: 11.23.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/LoginsApi.md

@@ -6,8 +6,7 @@ All URIs are relative to *https://admin-api.connected.dev*
 |------------- | ------------- | -------------|
 |[**confirmLogin**](#confirmlogin) | **PUT** /logins/{username}/confirm | Confirm a login|
 |[**deleteLogin**](#deletelogin) | **DELETE** /logins/{username} | Delete a login|
-|[**deleteLoginMfaToken**](#deleteloginmfatoken) | **DELETE** /logins/{username}/mfa/totp | Delete a login\'s authenticator app|
-|[**disableLoginMfa**](#disableloginmfa) | **PUT** /logins/{username}/mfa/{method}/disable | Turn off one of a login\'s MFA methods|
+|[**deleteLoginMfaToken**](#deleteloginmfatoken) | **DELETE** /logins/{username}/mfa/totp | Remove a login\'s two-factor authentication|
 |[**getLogin**](#getlogin) | **GET** /logins/{username} | Get a single login|
 |[**getLoginAuthSessions**](#getloginauthsessions) | **GET** /logins/{username}/auth-sessions | List a login\'s auth sessions|
 |[**getLoginDevices**](#getlogindevices) | **GET** /logins/{username}/devices | List a login\'s push devices|
@@ -122,7 +121,7 @@ const { status, data } = await apiInstance.deleteLogin(
 # **deleteLoginMfaToken**
 > GetLoginMfa200Response deleteLoginMfaToken()
 
-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.
+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.
 
 ### Example
 
@@ -149,60 +148,6 @@ const { status, data } = await apiInstance.deleteLoginMfaToken(
 | **username** | [**string**] | The username identifier | defaults to undefined|
 
 
-### Return type
-
-**GetLoginMfa200Response**
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Successful response |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **disableLoginMfa**
-> GetLoginMfa200Response disableLoginMfa()
-
-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.
-
-### Example
-
-```typescript
-import {
-    LoginsApi,
-    Configuration
-} from '@connectedxm/admin-sdk';
-
-const configuration = new Configuration();
-const apiInstance = new LoginsApi(configuration);
-
-let username: string; //The username identifier (default to undefined)
-let method: string; //The method identifier (default to undefined)
-
-const { status, data } = await apiInstance.disableLoginMfa(
-    username,
-    method
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **username** | [**string**] | The username identifier | defaults to undefined|
-| **method** | [**string**] | The method identifier | defaults to undefined|
-
-
 ### Return type
 
 **GetLoginMfa200Response**
@@ -518,7 +463,7 @@ const { status, data } = await apiInstance.getLogins(
 # **setLoginPreferredMfa**
 > GetLoginMfa200Response setLoginPreferredMfa(setLoginPreferredMfaRequest)
 
-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.
+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.
 
 ### Example
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@connectedxm/admin-sdk",
-  "version": "11.23.0",
+  "version": "11.23.1",
   "description": "OpenAPI client for @connectedxm/admin-sdk",
   "author": "OpenAPI-Generator Contributors",
   "repository": {