@connectedxm/admin-sdk 11.22.0 → 11.23.1

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.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.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/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.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.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/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.1
  *
  *
  * 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)

package/docs/LoginsApi.md

@@ -6,10 +6,13 @@ 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 | 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|
+|[**getLoginMfa**](#getloginmfa) | **GET** /logins/{username}/mfa | Get a login\'s MFA settings|
 |[**getLogins**](#getlogins) | **GET** /logins | List logins|
+|[**setLoginPreferredMfa**](#setloginpreferredmfa) | **PUT** /logins/{username}/mfa/preferred | Set a login\'s preferred MFA method|
 |[**updateLoginEmail**](#updateloginemail) | **PUT** /logins/{username}/email | Update a login\'s email|
 |[**updateLoginPassword**](#updateloginpassword) | **PUT** /logins/{username}/password | Set a login\'s password|
 
@@ -108,6 +111,57 @@ const { status, data } = await apiInstance.deleteLogin(
  - **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)
+
+# **deleteLoginMfaToken**
+> GetLoginMfa200Response deleteLoginMfaToken()
+
+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
+
+```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)
+
+const { status, data } = await apiInstance.deleteLoginMfaToken(
+    username
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **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 |
 |-------------|-------------|------------------|
@@ -285,6 +339,57 @@ const { status, data } = await apiInstance.getLoginDevices(
  - **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)
+
+# **getLoginMfa**
+> GetLoginMfa200Response getLoginMfa()
+
+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.
+
+### 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)
+
+const { status, data } = await apiInstance.getLoginMfa(
+    username
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **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 |
 |-------------|-------------|------------------|
@@ -348,6 +453,61 @@ const { status, data } = await apiInstance.getLogins(
  - **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)
+
+# **setLoginPreferredMfa**
+> GetLoginMfa200Response setLoginPreferredMfa(setLoginPreferredMfaRequest)
+
+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
+
+```typescript
+import {
+    LoginsApi,
+    Configuration,
+    SetLoginPreferredMfaRequest
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new LoginsApi(configuration);
+
+let username: string; //The username identifier (default to undefined)
+let setLoginPreferredMfaRequest: SetLoginPreferredMfaRequest; //
+
+const { status, data } = await apiInstance.setLoginPreferredMfa(
+    username,
+    setLoginPreferredMfaRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **setLoginPreferredMfaRequest** | **SetLoginPreferredMfaRequest**|  | |
+| **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**: application/json
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|

package/docs/SetLoginPreferredMfaRequest.md

@@ -0,0 +1,20 @@
+# SetLoginPreferredMfaRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**method** | [**LoginMfaMethod**](LoginMfaMethod.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SetLoginPreferredMfaRequest } from '@connectedxm/admin-sdk';
+
+const instance: SetLoginPreferredMfaRequest = {
+    method,
+};
+```
+
+[[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/package.json

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