@connectedxm/admin-sdk 11.22.0 → 11.23.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -996,6 +996,7 @@ docs/GetLivestreams200Response.md
996
996
  docs/GetLogin200Response.md
997
997
  docs/GetLoginAuthSessions200Response.md
998
998
  docs/GetLoginDevices200Response.md
999
+ docs/GetLoginMfa200Response.md
999
1000
  docs/GetLogins200Response.md
1000
1001
  docs/GetMeetingLinks200Response.md
1001
1002
  docs/GetMeetingParticipant200Response.md
@@ -1181,6 +1182,8 @@ docs/LivestreamSession.md
1181
1182
  docs/LocationQuestionOption.md
1182
1183
  docs/Login.md
1183
1184
  docs/LoginAllOfCount.md
1185
+ docs/LoginMfa.md
1186
+ docs/LoginMfaMethod.md
1184
1187
  docs/LoginsAccountsApi.md
1185
1188
  docs/LoginsApi.md
1186
1189
  docs/MarkNotificationsReadInputs.md
@@ -1446,6 +1449,7 @@ docs/SeriesTranslation.md
1446
1449
  docs/SeriesTranslationUpdateInputs.md
1447
1450
  docs/SeriesTranslationsApi.md
1448
1451
  docs/SeriesUpdateInputs.md
1452
+ docs/SetLoginPreferredMfaRequest.md
1449
1453
  docs/SideEffect.md
1450
1454
  docs/SideEffectActionType.md
1451
1455
  docs/SideEffectTriggerType.md
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @connectedxm/admin-sdk@11.22.0
1
+ ## @connectedxm/admin-sdk@11.23.1
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @connectedxm/admin-sdk@11.22.0 --save
39
+ npm install @connectedxm/admin-sdk@11.23.1 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
package/api.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 11.22.0
7
+ * The version of the OpenAPI document: 11.23.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -9656,6 +9656,16 @@ export enum GetLoginDevices200ResponseStatusEnum {
9656
9656
  Ok = 'ok'
9657
9657
  }
9658
9658
 
9659
+ export interface GetLoginMfa200Response {
9660
+ 'status': GetLoginMfa200ResponseStatusEnum;
9661
+ 'message': string;
9662
+ 'data': LoginMfa;
9663
+ }
9664
+
9665
+ export enum GetLoginMfa200ResponseStatusEnum {
9666
+ Ok = 'ok'
9667
+ }
9668
+
9659
9669
  export interface GetLogins200Response {
9660
9670
  'status': GetLogins200ResponseStatusEnum;
9661
9671
  'message': string;
@@ -11436,6 +11446,21 @@ export interface LoginAllOfCount {
11436
11446
  'accounts': number;
11437
11447
  'devices': number;
11438
11448
  }
11449
+ export interface LoginMfa {
11450
+ 'supported': boolean;
11451
+ 'methods': Array<LoginMfaMethod>;
11452
+ 'preferred': LoginMfaMethod | null;
11453
+ }
11454
+
11455
+
11456
+
11457
+ export enum LoginMfaMethod {
11458
+ Totp = 'totp',
11459
+ Sms = 'sms',
11460
+ Email = 'email'
11461
+ }
11462
+
11463
+
11439
11464
  export interface MarkNotificationsReadInputs {
11440
11465
  'notificationIds': Array<string>;
11441
11466
  }
@@ -14070,6 +14095,11 @@ export interface SeriesUpdateInputs {
14070
14095
  }
14071
14096
 
14072
14097
 
14098
+ export interface SetLoginPreferredMfaRequest {
14099
+ 'method': LoginMfaMethod;
14100
+ }
14101
+
14102
+
14073
14103
  export interface SideEffect {
14074
14104
  'id': string;
14075
14105
  'newPassOfPassTypeId': string | null;
@@ -116551,6 +116581,46 @@ export const LoginsApiAxiosParamCreator = function (configuration?: Configuratio
116551
116581
  options: localVarRequestOptions,
116552
116582
  };
116553
116583
  },
116584
+ /**
116585
+ * 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.
116586
+ * @summary Remove a login\'s two-factor authentication
116587
+ * @param {string} username The username identifier
116588
+ * @param {*} [options] Override http request option.
116589
+ * @throws {RequiredError}
116590
+ */
116591
+ deleteLoginMfaToken: async (username: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
116592
+ // verify required parameter 'username' is not null or undefined
116593
+ assertParamExists('deleteLoginMfaToken', 'username', username)
116594
+ const localVarPath = `/logins/{username}/mfa/totp`
116595
+ .replace('{username}', encodeURIComponent(String(username)));
116596
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
116597
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
116598
+ let baseOptions;
116599
+ if (configuration) {
116600
+ baseOptions = configuration.baseOptions;
116601
+ }
116602
+
116603
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
116604
+ const localVarHeaderParameter = {} as any;
116605
+ const localVarQueryParameter = {} as any;
116606
+
116607
+ // authentication ApiKeyAuth required
116608
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
116609
+
116610
+ // authentication OrganizationId required
116611
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
116612
+
116613
+ localVarHeaderParameter['Accept'] = 'application/json';
116614
+
116615
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
116616
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
116617
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
116618
+
116619
+ return {
116620
+ url: toPathString(localVarUrlObj),
116621
+ options: localVarRequestOptions,
116622
+ };
116623
+ },
116554
116624
  /**
116555
116625
  * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
116556
116626
  * @summary Get a single login
@@ -116711,6 +116781,46 @@ export const LoginsApiAxiosParamCreator = function (configuration?: Configuratio
116711
116781
  options: localVarRequestOptions,
116712
116782
  };
116713
116783
  },
116784
+ /**
116785
+ * 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.
116786
+ * @summary Get a login\'s MFA settings
116787
+ * @param {string} username The username identifier
116788
+ * @param {*} [options] Override http request option.
116789
+ * @throws {RequiredError}
116790
+ */
116791
+ getLoginMfa: async (username: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
116792
+ // verify required parameter 'username' is not null or undefined
116793
+ assertParamExists('getLoginMfa', 'username', username)
116794
+ const localVarPath = `/logins/{username}/mfa`
116795
+ .replace('{username}', encodeURIComponent(String(username)));
116796
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
116797
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
116798
+ let baseOptions;
116799
+ if (configuration) {
116800
+ baseOptions = configuration.baseOptions;
116801
+ }
116802
+
116803
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
116804
+ const localVarHeaderParameter = {} as any;
116805
+ const localVarQueryParameter = {} as any;
116806
+
116807
+ // authentication ApiKeyAuth required
116808
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
116809
+
116810
+ // authentication OrganizationId required
116811
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
116812
+
116813
+ localVarHeaderParameter['Accept'] = 'application/json';
116814
+
116815
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
116816
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
116817
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
116818
+
116819
+ return {
116820
+ url: toPathString(localVarUrlObj),
116821
+ options: localVarRequestOptions,
116822
+ };
116823
+ },
116714
116824
  /**
116715
116825
  * 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.
116716
116826
  * @summary List logins
@@ -116772,6 +116882,51 @@ export const LoginsApiAxiosParamCreator = function (configuration?: Configuratio
116772
116882
  options: localVarRequestOptions,
116773
116883
  };
116774
116884
  },
116885
+ /**
116886
+ * 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.
116887
+ * @summary Set a login\'s preferred MFA method
116888
+ * @param {string} username The username identifier
116889
+ * @param {SetLoginPreferredMfaRequest} setLoginPreferredMfaRequest
116890
+ * @param {*} [options] Override http request option.
116891
+ * @throws {RequiredError}
116892
+ */
116893
+ setLoginPreferredMfa: async (username: string, setLoginPreferredMfaRequest: SetLoginPreferredMfaRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
116894
+ // verify required parameter 'username' is not null or undefined
116895
+ assertParamExists('setLoginPreferredMfa', 'username', username)
116896
+ // verify required parameter 'setLoginPreferredMfaRequest' is not null or undefined
116897
+ assertParamExists('setLoginPreferredMfa', 'setLoginPreferredMfaRequest', setLoginPreferredMfaRequest)
116898
+ const localVarPath = `/logins/{username}/mfa/preferred`
116899
+ .replace('{username}', encodeURIComponent(String(username)));
116900
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
116901
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
116902
+ let baseOptions;
116903
+ if (configuration) {
116904
+ baseOptions = configuration.baseOptions;
116905
+ }
116906
+
116907
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
116908
+ const localVarHeaderParameter = {} as any;
116909
+ const localVarQueryParameter = {} as any;
116910
+
116911
+ // authentication ApiKeyAuth required
116912
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
116913
+
116914
+ // authentication OrganizationId required
116915
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
116916
+
116917
+ localVarHeaderParameter['Content-Type'] = 'application/json';
116918
+ localVarHeaderParameter['Accept'] = 'application/json';
116919
+
116920
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
116921
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
116922
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
116923
+ localVarRequestOptions.data = serializeDataIfNeeded(setLoginPreferredMfaRequest, localVarRequestOptions, configuration)
116924
+
116925
+ return {
116926
+ url: toPathString(localVarUrlObj),
116927
+ options: localVarRequestOptions,
116928
+ };
116929
+ },
116775
116930
  /**
116776
116931
  * 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.
116777
116932
  * @summary Update a login\'s email
@@ -116897,6 +117052,19 @@ export const LoginsApiFp = function(configuration?: Configuration) {
116897
117052
  const localVarOperationServerBasePath = operationServerMap['LoginsApi.deleteLogin']?.[localVarOperationServerIndex]?.url;
116898
117053
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
116899
117054
  },
117055
+ /**
117056
+ * 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.
117057
+ * @summary Remove a login\'s two-factor authentication
117058
+ * @param {string} username The username identifier
117059
+ * @param {*} [options] Override http request option.
117060
+ * @throws {RequiredError}
117061
+ */
117062
+ async deleteLoginMfaToken(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginMfa200Response>> {
117063
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteLoginMfaToken(username, options);
117064
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
117065
+ const localVarOperationServerBasePath = operationServerMap['LoginsApi.deleteLoginMfaToken']?.[localVarOperationServerIndex]?.url;
117066
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
117067
+ },
116900
117068
  /**
116901
117069
  * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
116902
117070
  * @summary Get a single login
@@ -116944,6 +117112,19 @@ export const LoginsApiFp = function(configuration?: Configuration) {
116944
117112
  const localVarOperationServerBasePath = operationServerMap['LoginsApi.getLoginDevices']?.[localVarOperationServerIndex]?.url;
116945
117113
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
116946
117114
  },
117115
+ /**
117116
+ * 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.
117117
+ * @summary Get a login\'s MFA settings
117118
+ * @param {string} username The username identifier
117119
+ * @param {*} [options] Override http request option.
117120
+ * @throws {RequiredError}
117121
+ */
117122
+ async getLoginMfa(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginMfa200Response>> {
117123
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getLoginMfa(username, options);
117124
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
117125
+ const localVarOperationServerBasePath = operationServerMap['LoginsApi.getLoginMfa']?.[localVarOperationServerIndex]?.url;
117126
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
117127
+ },
116947
117128
  /**
116948
117129
  * 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.
116949
117130
  * @summary List logins
@@ -116961,6 +117142,20 @@ export const LoginsApiFp = function(configuration?: Configuration) {
116961
117142
  const localVarOperationServerBasePath = operationServerMap['LoginsApi.getLogins']?.[localVarOperationServerIndex]?.url;
116962
117143
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
116963
117144
  },
117145
+ /**
117146
+ * 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.
117147
+ * @summary Set a login\'s preferred MFA method
117148
+ * @param {string} username The username identifier
117149
+ * @param {SetLoginPreferredMfaRequest} setLoginPreferredMfaRequest
117150
+ * @param {*} [options] Override http request option.
117151
+ * @throws {RequiredError}
117152
+ */
117153
+ async setLoginPreferredMfa(username: string, setLoginPreferredMfaRequest: SetLoginPreferredMfaRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginMfa200Response>> {
117154
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setLoginPreferredMfa(username, setLoginPreferredMfaRequest, options);
117155
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
117156
+ const localVarOperationServerBasePath = operationServerMap['LoginsApi.setLoginPreferredMfa']?.[localVarOperationServerIndex]?.url;
117157
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
117158
+ },
116964
117159
  /**
116965
117160
  * 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.
116966
117161
  * @summary Update a login\'s email
@@ -117018,6 +117213,16 @@ export const LoginsApiFactory = function (configuration?: Configuration, basePat
117018
117213
  deleteLogin(requestParameters: LoginsApiDeleteLoginRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLogin200Response> {
117019
117214
  return localVarFp.deleteLogin(requestParameters.username, options).then((request) => request(axios, basePath));
117020
117215
  },
117216
+ /**
117217
+ * 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.
117218
+ * @summary Remove a login\'s two-factor authentication
117219
+ * @param {LoginsApiDeleteLoginMfaTokenRequest} requestParameters Request parameters.
117220
+ * @param {*} [options] Override http request option.
117221
+ * @throws {RequiredError}
117222
+ */
117223
+ deleteLoginMfaToken(requestParameters: LoginsApiDeleteLoginMfaTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginMfa200Response> {
117224
+ return localVarFp.deleteLoginMfaToken(requestParameters.username, options).then((request) => request(axios, basePath));
117225
+ },
117021
117226
  /**
117022
117227
  * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
117023
117228
  * @summary Get a single login
@@ -117048,6 +117253,16 @@ export const LoginsApiFactory = function (configuration?: Configuration, basePat
117048
117253
  getLoginDevices(requestParameters: LoginsApiGetLoginDevicesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginDevices200Response> {
117049
117254
  return localVarFp.getLoginDevices(requestParameters.username, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
117050
117255
  },
117256
+ /**
117257
+ * 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.
117258
+ * @summary Get a login\'s MFA settings
117259
+ * @param {LoginsApiGetLoginMfaRequest} requestParameters Request parameters.
117260
+ * @param {*} [options] Override http request option.
117261
+ * @throws {RequiredError}
117262
+ */
117263
+ getLoginMfa(requestParameters: LoginsApiGetLoginMfaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginMfa200Response> {
117264
+ return localVarFp.getLoginMfa(requestParameters.username, options).then((request) => request(axios, basePath));
117265
+ },
117051
117266
  /**
117052
117267
  * 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.
117053
117268
  * @summary List logins
@@ -117058,6 +117273,16 @@ export const LoginsApiFactory = function (configuration?: Configuration, basePat
117058
117273
  getLogins(requestParameters: LoginsApiGetLoginsRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<GetLogins200Response> {
117059
117274
  return localVarFp.getLogins(requestParameters.accountId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
117060
117275
  },
117276
+ /**
117277
+ * 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.
117278
+ * @summary Set a login\'s preferred MFA method
117279
+ * @param {LoginsApiSetLoginPreferredMfaRequest} requestParameters Request parameters.
117280
+ * @param {*} [options] Override http request option.
117281
+ * @throws {RequiredError}
117282
+ */
117283
+ setLoginPreferredMfa(requestParameters: LoginsApiSetLoginPreferredMfaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginMfa200Response> {
117284
+ return localVarFp.setLoginPreferredMfa(requestParameters.username, requestParameters.setLoginPreferredMfaRequest, options).then((request) => request(axios, basePath));
117285
+ },
117061
117286
  /**
117062
117287
  * 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.
117063
117288
  * @summary Update a login\'s email
@@ -117101,6 +117326,16 @@ export interface LoginsApiDeleteLoginRequest {
117101
117326
  readonly username: string
117102
117327
  }
117103
117328
 
117329
+ /**
117330
+ * Request parameters for deleteLoginMfaToken operation in LoginsApi.
117331
+ */
117332
+ export interface LoginsApiDeleteLoginMfaTokenRequest {
117333
+ /**
117334
+ * The username identifier
117335
+ */
117336
+ readonly username: string
117337
+ }
117338
+
117104
117339
  /**
117105
117340
  * Request parameters for getLogin operation in LoginsApi.
117106
117341
  */
@@ -117171,6 +117406,16 @@ export interface LoginsApiGetLoginDevicesRequest {
117171
117406
  readonly search?: string
117172
117407
  }
117173
117408
 
117409
+ /**
117410
+ * Request parameters for getLoginMfa operation in LoginsApi.
117411
+ */
117412
+ export interface LoginsApiGetLoginMfaRequest {
117413
+ /**
117414
+ * The username identifier
117415
+ */
117416
+ readonly username: string
117417
+ }
117418
+
117174
117419
  /**
117175
117420
  * Request parameters for getLogins operation in LoginsApi.
117176
117421
  */
@@ -117201,6 +117446,18 @@ export interface LoginsApiGetLoginsRequest {
117201
117446
  readonly search?: string
117202
117447
  }
117203
117448
 
117449
+ /**
117450
+ * Request parameters for setLoginPreferredMfa operation in LoginsApi.
117451
+ */
117452
+ export interface LoginsApiSetLoginPreferredMfaRequest {
117453
+ /**
117454
+ * The username identifier
117455
+ */
117456
+ readonly username: string
117457
+
117458
+ readonly setLoginPreferredMfaRequest: SetLoginPreferredMfaRequest
117459
+ }
117460
+
117204
117461
  /**
117205
117462
  * Request parameters for updateLoginEmail operation in LoginsApi.
117206
117463
  */
@@ -117251,6 +117508,17 @@ export class LoginsApi extends BaseAPI {
117251
117508
  return LoginsApiFp(this.configuration).deleteLogin(requestParameters.username, options).then((request) => request(this.axios, this.basePath));
117252
117509
  }
117253
117510
 
117511
+ /**
117512
+ * 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.
117513
+ * @summary Remove a login\'s two-factor authentication
117514
+ * @param {LoginsApiDeleteLoginMfaTokenRequest} requestParameters Request parameters.
117515
+ * @param {*} [options] Override http request option.
117516
+ * @throws {RequiredError}
117517
+ */
117518
+ public deleteLoginMfaToken(requestParameters: LoginsApiDeleteLoginMfaTokenRequest, options?: RawAxiosRequestConfig) {
117519
+ return LoginsApiFp(this.configuration).deleteLoginMfaToken(requestParameters.username, options).then((request) => request(this.axios, this.basePath));
117520
+ }
117521
+
117254
117522
  /**
117255
117523
  * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
117256
117524
  * @summary Get a single login
@@ -117284,6 +117552,17 @@ export class LoginsApi extends BaseAPI {
117284
117552
  return LoginsApiFp(this.configuration).getLoginDevices(requestParameters.username, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
117285
117553
  }
117286
117554
 
117555
+ /**
117556
+ * 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.
117557
+ * @summary Get a login\'s MFA settings
117558
+ * @param {LoginsApiGetLoginMfaRequest} requestParameters Request parameters.
117559
+ * @param {*} [options] Override http request option.
117560
+ * @throws {RequiredError}
117561
+ */
117562
+ public getLoginMfa(requestParameters: LoginsApiGetLoginMfaRequest, options?: RawAxiosRequestConfig) {
117563
+ return LoginsApiFp(this.configuration).getLoginMfa(requestParameters.username, options).then((request) => request(this.axios, this.basePath));
117564
+ }
117565
+
117287
117566
  /**
117288
117567
  * 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.
117289
117568
  * @summary List logins
@@ -117295,6 +117574,17 @@ export class LoginsApi extends BaseAPI {
117295
117574
  return LoginsApiFp(this.configuration).getLogins(requestParameters.accountId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
117296
117575
  }
117297
117576
 
117577
+ /**
117578
+ * 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.
117579
+ * @summary Set a login\'s preferred MFA method
117580
+ * @param {LoginsApiSetLoginPreferredMfaRequest} requestParameters Request parameters.
117581
+ * @param {*} [options] Override http request option.
117582
+ * @throws {RequiredError}
117583
+ */
117584
+ public setLoginPreferredMfa(requestParameters: LoginsApiSetLoginPreferredMfaRequest, options?: RawAxiosRequestConfig) {
117585
+ return LoginsApiFp(this.configuration).setLoginPreferredMfa(requestParameters.username, requestParameters.setLoginPreferredMfaRequest, options).then((request) => request(this.axios, this.basePath));
117586
+ }
117587
+
117298
117588
  /**
117299
117589
  * 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.
117300
117590
  * @summary Update a login\'s email
package/base.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 11.22.0
7
+ * The version of the OpenAPI document: 11.23.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/common.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 11.22.0
7
+ * The version of the OpenAPI document: 11.23.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/configuration.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  * Connected Admin API
4
4
  * The Admin API allows you to manage your Connected community programmatically.
5
5
  *
6
- * The version of the OpenAPI document: 11.22.0
6
+ * The version of the OpenAPI document: 11.23.1
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).