@connectedxm/admin-sdk 11.22.0 → 11.23.0

package/docs/LoginsApi.md

@@ -6,10 +6,14 @@ 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|
 |[**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 +112,111 @@ 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()
+
+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.
+
+### 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 |
+|-------------|-------------|------------------|
+|**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**
+
+### 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 +394,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 +508,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)
+
+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.
+
+### 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.0",
   "description": "OpenAPI client for @connectedxm/admin-sdk",
   "author": "OpenAPI-Generator Contributors",
   "repository": {