@connectedxm/admin-sdk 11.21.0 → 11.23.0

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.
package/dist/base.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Connected Admin API
3
3
  * The Admin API allows you to manage your Connected community programmatically.
4
4
  *
5
- * The version of the OpenAPI document: 11.21.0
5
+ * The version of the OpenAPI document: 11.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/base.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Connected Admin API
6
6
  * The Admin API allows you to manage your Connected community programmatically.
7
7
  *
8
- * The version of the OpenAPI document: 11.21.0
8
+ * The version of the OpenAPI document: 11.23.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Connected Admin API
3
3
  * The Admin API allows you to manage your Connected community programmatically.
4
4
  *
5
- * The version of the OpenAPI document: 11.21.0
5
+ * The version of the OpenAPI document: 11.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Connected Admin API
6
6
  * The Admin API allows you to manage your Connected community programmatically.
7
7
  *
8
- * The version of the OpenAPI document: 11.21.0
8
+ * The version of the OpenAPI document: 11.23.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Connected Admin API
3
3
  * The Admin API allows you to manage your Connected community programmatically.
4
4
  *
5
- * The version of the OpenAPI document: 11.21.0
5
+ * The version of the OpenAPI document: 11.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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.21.0
7
+ * The version of the OpenAPI document: 11.23.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Connected Admin API
3
3
  * The Admin API allows you to manage your Connected community programmatically.
4
4
  *
5
- * The version of the OpenAPI document: 11.21.0
5
+ * The version of the OpenAPI document: 11.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -6876,6 +6876,15 @@ export interface GetAdvertisements200Response {
6876
6876
  export declare enum GetAdvertisements200ResponseStatusEnum {
6877
6877
  Ok = "ok"
6878
6878
  }
6879
+ export interface GetAllAccountMerges200Response {
6880
+ 'status': GetAllAccountMerges200ResponseStatusEnum;
6881
+ 'message': string;
6882
+ 'data': Array<AccountMerge>;
6883
+ 'count'?: number;
6884
+ }
6885
+ export declare enum GetAllAccountMerges200ResponseStatusEnum {
6886
+ Ok = "ok"
6887
+ }
6879
6888
  export interface GetAnnouncementAudience200Response {
6880
6889
  'status': GetAnnouncementAudience200ResponseStatusEnum;
6881
6890
  'message': string;
@@ -8606,6 +8615,14 @@ export interface GetLoginDevices200Response {
8606
8615
  export declare enum GetLoginDevices200ResponseStatusEnum {
8607
8616
  Ok = "ok"
8608
8617
  }
8618
+ export interface GetLoginMfa200Response {
8619
+ 'status': GetLoginMfa200ResponseStatusEnum;
8620
+ 'message': string;
8621
+ 'data': LoginMfa;
8622
+ }
8623
+ export declare enum GetLoginMfa200ResponseStatusEnum {
8624
+ Ok = "ok"
8625
+ }
8609
8626
  export interface GetLogins200Response {
8610
8627
  'status': GetLogins200ResponseStatusEnum;
8611
8628
  'message': string;
@@ -10082,6 +10099,16 @@ export interface LoginAllOfCount {
10082
10099
  'accounts': number;
10083
10100
  'devices': number;
10084
10101
  }
10102
+ export interface LoginMfa {
10103
+ 'supported': boolean;
10104
+ 'methods': Array<LoginMfaMethod>;
10105
+ 'preferred': LoginMfaMethod | null;
10106
+ }
10107
+ export declare enum LoginMfaMethod {
10108
+ Totp = "totp",
10109
+ Sms = "sms",
10110
+ Email = "email"
10111
+ }
10085
10112
  export interface MarkNotificationsReadInputs {
10086
10113
  'notificationIds': Array<string>;
10087
10114
  }
@@ -12518,6 +12545,9 @@ export interface SeriesUpdateInputs {
12518
12545
  'paymentIntegrationId'?: string | null;
12519
12546
  'entityId'?: string | null;
12520
12547
  }
12548
+ export interface SetLoginPreferredMfaRequest {
12549
+ 'method': LoginMfaMethod;
12550
+ }
12521
12551
  export interface SideEffect {
12522
12552
  'id': string;
12523
12553
  'newPassOfPassTypeId': string | null;
@@ -16595,6 +16625,18 @@ export declare const AccountsMergesApiAxiosParamCreator: (configuration?: Config
16595
16625
  * @throws {RequiredError}
16596
16626
  */
16597
16627
  getAccountMerges: (accountId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
16628
+ /**
16629
+ * Returns a paginated list of the organization\'s account merges, newest first, optionally filtered by status and searched by the merged account\'s name or email or the surviving account\'s; requires read access to accounts.
16630
+ * @summary List every account merge in the organization
16631
+ * @param {AccountMergeStatus} [status] Filter by status
16632
+ * @param {number} [page] Page number
16633
+ * @param {number} [pageSize] Number of items per page
16634
+ * @param {string} [orderBy] Field to order by
16635
+ * @param {string} [search] Search query
16636
+ * @param {*} [options] Override http request option.
16637
+ * @throws {RequiredError}
16638
+ */
16639
+ getAllAccountMerges: (status?: AccountMergeStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
16598
16640
  /**
16599
16641
  * Starts a background merge of mergeAccountId into the surviving account accountId: its logins, registrations, payments, and other related data move to the survivor and the merged account is then deleted. Returns the merge record to poll; requires read, create, update and delete permission on accounts.
16600
16642
  * @summary Merge an account into another
@@ -16642,6 +16684,18 @@ export declare const AccountsMergesApiFp: (configuration?: Configuration) => {
16642
16684
  * @throws {RequiredError}
16643
16685
  */
16644
16686
  getAccountMerges(accountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountMerges200Response>>;
16687
+ /**
16688
+ * Returns a paginated list of the organization\'s account merges, newest first, optionally filtered by status and searched by the merged account\'s name or email or the surviving account\'s; requires read access to accounts.
16689
+ * @summary List every account merge in the organization
16690
+ * @param {AccountMergeStatus} [status] Filter by status
16691
+ * @param {number} [page] Page number
16692
+ * @param {number} [pageSize] Number of items per page
16693
+ * @param {string} [orderBy] Field to order by
16694
+ * @param {string} [search] Search query
16695
+ * @param {*} [options] Override http request option.
16696
+ * @throws {RequiredError}
16697
+ */
16698
+ getAllAccountMerges(status?: AccountMergeStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllAccountMerges200Response>>;
16645
16699
  /**
16646
16700
  * Starts a background merge of mergeAccountId into the surviving account accountId: its logins, registrations, payments, and other related data move to the survivor and the merged account is then deleted. Returns the merge record to poll; requires read, create, update and delete permission on accounts.
16647
16701
  * @summary Merge an account into another
@@ -16688,6 +16742,14 @@ export declare const AccountsMergesApiFactory: (configuration?: Configuration, b
16688
16742
  * @throws {RequiredError}
16689
16743
  */
16690
16744
  getAccountMerges(requestParameters: AccountsMergesApiGetAccountMergesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMerges200Response>;
16745
+ /**
16746
+ * Returns a paginated list of the organization\'s account merges, newest first, optionally filtered by status and searched by the merged account\'s name or email or the surviving account\'s; requires read access to accounts.
16747
+ * @summary List every account merge in the organization
16748
+ * @param {AccountsMergesApiGetAllAccountMergesRequest} requestParameters Request parameters.
16749
+ * @param {*} [options] Override http request option.
16750
+ * @throws {RequiredError}
16751
+ */
16752
+ getAllAccountMerges(requestParameters?: AccountsMergesApiGetAllAccountMergesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAllAccountMerges200Response>;
16691
16753
  /**
16692
16754
  * Starts a background merge of mergeAccountId into the surviving account accountId: its logins, registrations, payments, and other related data move to the survivor and the merged account is then deleted. Returns the merge record to poll; requires read, create, update and delete permission on accounts.
16693
16755
  * @summary Merge an account into another
@@ -16736,6 +16798,31 @@ export interface AccountsMergesApiGetAccountMergesRequest {
16736
16798
  */
16737
16799
  readonly accountId: string;
16738
16800
  }
16801
+ /**
16802
+ * Request parameters for getAllAccountMerges operation in AccountsMergesApi.
16803
+ */
16804
+ export interface AccountsMergesApiGetAllAccountMergesRequest {
16805
+ /**
16806
+ * Filter by status
16807
+ */
16808
+ readonly status?: AccountMergeStatus;
16809
+ /**
16810
+ * Page number
16811
+ */
16812
+ readonly page?: number;
16813
+ /**
16814
+ * Number of items per page
16815
+ */
16816
+ readonly pageSize?: number;
16817
+ /**
16818
+ * Field to order by
16819
+ */
16820
+ readonly orderBy?: string;
16821
+ /**
16822
+ * Search query
16823
+ */
16824
+ readonly search?: string;
16825
+ }
16739
16826
  /**
16740
16827
  * Request parameters for mergeAccount operation in AccountsMergesApi.
16741
16828
  */
@@ -16783,6 +16870,14 @@ export declare class AccountsMergesApi extends BaseAPI {
16783
16870
  * @throws {RequiredError}
16784
16871
  */
16785
16872
  getAccountMerges(requestParameters: AccountsMergesApiGetAccountMergesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountMerges200Response, any, {}, any>>;
16873
+ /**
16874
+ * Returns a paginated list of the organization\'s account merges, newest first, optionally filtered by status and searched by the merged account\'s name or email or the surviving account\'s; requires read access to accounts.
16875
+ * @summary List every account merge in the organization
16876
+ * @param {AccountsMergesApiGetAllAccountMergesRequest} requestParameters Request parameters.
16877
+ * @param {*} [options] Override http request option.
16878
+ * @throws {RequiredError}
16879
+ */
16880
+ getAllAccountMerges(requestParameters?: AccountsMergesApiGetAllAccountMergesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllAccountMerges200Response, any, {}, any>>;
16786
16881
  /**
16787
16882
  * Starts a background merge of mergeAccountId into the surviving account accountId: its logins, registrations, payments, and other related data move to the survivor and the merged account is then deleted. Returns the merge record to poll; requires read, create, update and delete permission on accounts.
16788
16883
  * @summary Merge an account into another
@@ -65112,6 +65207,23 @@ export declare const LoginsApiAxiosParamCreator: (configuration?: Configuration)
65112
65207
  * @throws {RequiredError}
65113
65208
  */
65114
65209
  deleteLogin: (username: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
65210
+ /**
65211
+ * 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.
65212
+ * @summary Delete a login\'s authenticator app
65213
+ * @param {string} username The username identifier
65214
+ * @param {*} [options] Override http request option.
65215
+ * @throws {RequiredError}
65216
+ */
65217
+ deleteLoginMfaToken: (username: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
65218
+ /**
65219
+ * 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.
65220
+ * @summary Turn off one of a login\'s MFA methods
65221
+ * @param {string} username The username identifier
65222
+ * @param {string} method The method identifier
65223
+ * @param {*} [options] Override http request option.
65224
+ * @throws {RequiredError}
65225
+ */
65226
+ disableLoginMfa: (username: string, method: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
65115
65227
  /**
65116
65228
  * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
65117
65229
  * @summary Get a single login
@@ -65144,6 +65256,14 @@ export declare const LoginsApiAxiosParamCreator: (configuration?: Configuration)
65144
65256
  * @throws {RequiredError}
65145
65257
  */
65146
65258
  getLoginDevices: (username: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
65259
+ /**
65260
+ * 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.
65261
+ * @summary Get a login\'s MFA settings
65262
+ * @param {string} username The username identifier
65263
+ * @param {*} [options] Override http request option.
65264
+ * @throws {RequiredError}
65265
+ */
65266
+ getLoginMfa: (username: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
65147
65267
  /**
65148
65268
  * 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.
65149
65269
  * @summary List logins
@@ -65156,6 +65276,15 @@ export declare const LoginsApiAxiosParamCreator: (configuration?: Configuration)
65156
65276
  * @throws {RequiredError}
65157
65277
  */
65158
65278
  getLogins: (accountId?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
65279
+ /**
65280
+ * 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.
65281
+ * @summary Set a login\'s preferred MFA method
65282
+ * @param {string} username The username identifier
65283
+ * @param {SetLoginPreferredMfaRequest} setLoginPreferredMfaRequest
65284
+ * @param {*} [options] Override http request option.
65285
+ * @throws {RequiredError}
65286
+ */
65287
+ setLoginPreferredMfa: (username: string, setLoginPreferredMfaRequest: SetLoginPreferredMfaRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
65159
65288
  /**
65160
65289
  * 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.
65161
65290
  * @summary Update a login\'s email
@@ -65195,6 +65324,23 @@ export declare const LoginsApiFp: (configuration?: Configuration) => {
65195
65324
  * @throws {RequiredError}
65196
65325
  */
65197
65326
  deleteLogin(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLogin200Response>>;
65327
+ /**
65328
+ * 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.
65329
+ * @summary Delete a login\'s authenticator app
65330
+ * @param {string} username The username identifier
65331
+ * @param {*} [options] Override http request option.
65332
+ * @throws {RequiredError}
65333
+ */
65334
+ deleteLoginMfaToken(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginMfa200Response>>;
65335
+ /**
65336
+ * 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.
65337
+ * @summary Turn off one of a login\'s MFA methods
65338
+ * @param {string} username The username identifier
65339
+ * @param {string} method The method identifier
65340
+ * @param {*} [options] Override http request option.
65341
+ * @throws {RequiredError}
65342
+ */
65343
+ disableLoginMfa(username: string, method: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginMfa200Response>>;
65198
65344
  /**
65199
65345
  * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
65200
65346
  * @summary Get a single login
@@ -65227,6 +65373,14 @@ export declare const LoginsApiFp: (configuration?: Configuration) => {
65227
65373
  * @throws {RequiredError}
65228
65374
  */
65229
65375
  getLoginDevices(username: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginDevices200Response>>;
65376
+ /**
65377
+ * 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.
65378
+ * @summary Get a login\'s MFA settings
65379
+ * @param {string} username The username identifier
65380
+ * @param {*} [options] Override http request option.
65381
+ * @throws {RequiredError}
65382
+ */
65383
+ getLoginMfa(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginMfa200Response>>;
65230
65384
  /**
65231
65385
  * 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.
65232
65386
  * @summary List logins
@@ -65239,6 +65393,15 @@ export declare const LoginsApiFp: (configuration?: Configuration) => {
65239
65393
  * @throws {RequiredError}
65240
65394
  */
65241
65395
  getLogins(accountId?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLogins200Response>>;
65396
+ /**
65397
+ * 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.
65398
+ * @summary Set a login\'s preferred MFA method
65399
+ * @param {string} username The username identifier
65400
+ * @param {SetLoginPreferredMfaRequest} setLoginPreferredMfaRequest
65401
+ * @param {*} [options] Override http request option.
65402
+ * @throws {RequiredError}
65403
+ */
65404
+ setLoginPreferredMfa(username: string, setLoginPreferredMfaRequest: SetLoginPreferredMfaRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginMfa200Response>>;
65242
65405
  /**
65243
65406
  * 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.
65244
65407
  * @summary Update a login\'s email
@@ -65278,6 +65441,22 @@ export declare const LoginsApiFactory: (configuration?: Configuration, basePath?
65278
65441
  * @throws {RequiredError}
65279
65442
  */
65280
65443
  deleteLogin(requestParameters: LoginsApiDeleteLoginRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLogin200Response>;
65444
+ /**
65445
+ * 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.
65446
+ * @summary Delete a login\'s authenticator app
65447
+ * @param {LoginsApiDeleteLoginMfaTokenRequest} requestParameters Request parameters.
65448
+ * @param {*} [options] Override http request option.
65449
+ * @throws {RequiredError}
65450
+ */
65451
+ deleteLoginMfaToken(requestParameters: LoginsApiDeleteLoginMfaTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginMfa200Response>;
65452
+ /**
65453
+ * 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.
65454
+ * @summary Turn off one of a login\'s MFA methods
65455
+ * @param {LoginsApiDisableLoginMfaRequest} requestParameters Request parameters.
65456
+ * @param {*} [options] Override http request option.
65457
+ * @throws {RequiredError}
65458
+ */
65459
+ disableLoginMfa(requestParameters: LoginsApiDisableLoginMfaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginMfa200Response>;
65281
65460
  /**
65282
65461
  * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
65283
65462
  * @summary Get a single login
@@ -65302,6 +65481,14 @@ export declare const LoginsApiFactory: (configuration?: Configuration, basePath?
65302
65481
  * @throws {RequiredError}
65303
65482
  */
65304
65483
  getLoginDevices(requestParameters: LoginsApiGetLoginDevicesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginDevices200Response>;
65484
+ /**
65485
+ * 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.
65486
+ * @summary Get a login\'s MFA settings
65487
+ * @param {LoginsApiGetLoginMfaRequest} requestParameters Request parameters.
65488
+ * @param {*} [options] Override http request option.
65489
+ * @throws {RequiredError}
65490
+ */
65491
+ getLoginMfa(requestParameters: LoginsApiGetLoginMfaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginMfa200Response>;
65305
65492
  /**
65306
65493
  * 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.
65307
65494
  * @summary List logins
@@ -65310,6 +65497,14 @@ export declare const LoginsApiFactory: (configuration?: Configuration, basePath?
65310
65497
  * @throws {RequiredError}
65311
65498
  */
65312
65499
  getLogins(requestParameters?: LoginsApiGetLoginsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLogins200Response>;
65500
+ /**
65501
+ * 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.
65502
+ * @summary Set a login\'s preferred MFA method
65503
+ * @param {LoginsApiSetLoginPreferredMfaRequest} requestParameters Request parameters.
65504
+ * @param {*} [options] Override http request option.
65505
+ * @throws {RequiredError}
65506
+ */
65507
+ setLoginPreferredMfa(requestParameters: LoginsApiSetLoginPreferredMfaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginMfa200Response>;
65313
65508
  /**
65314
65509
  * 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.
65315
65510
  * @summary Update a login\'s email
@@ -65345,6 +65540,28 @@ export interface LoginsApiDeleteLoginRequest {
65345
65540
  */
65346
65541
  readonly username: string;
65347
65542
  }
65543
+ /**
65544
+ * Request parameters for deleteLoginMfaToken operation in LoginsApi.
65545
+ */
65546
+ export interface LoginsApiDeleteLoginMfaTokenRequest {
65547
+ /**
65548
+ * The username identifier
65549
+ */
65550
+ readonly username: string;
65551
+ }
65552
+ /**
65553
+ * Request parameters for disableLoginMfa operation in LoginsApi.
65554
+ */
65555
+ export interface LoginsApiDisableLoginMfaRequest {
65556
+ /**
65557
+ * The username identifier
65558
+ */
65559
+ readonly username: string;
65560
+ /**
65561
+ * The method identifier
65562
+ */
65563
+ readonly method: string;
65564
+ }
65348
65565
  /**
65349
65566
  * Request parameters for getLogin operation in LoginsApi.
65350
65567
  */
@@ -65404,6 +65621,15 @@ export interface LoginsApiGetLoginDevicesRequest {
65404
65621
  */
65405
65622
  readonly search?: string;
65406
65623
  }
65624
+ /**
65625
+ * Request parameters for getLoginMfa operation in LoginsApi.
65626
+ */
65627
+ export interface LoginsApiGetLoginMfaRequest {
65628
+ /**
65629
+ * The username identifier
65630
+ */
65631
+ readonly username: string;
65632
+ }
65407
65633
  /**
65408
65634
  * Request parameters for getLogins operation in LoginsApi.
65409
65635
  */
@@ -65429,6 +65655,16 @@ export interface LoginsApiGetLoginsRequest {
65429
65655
  */
65430
65656
  readonly search?: string;
65431
65657
  }
65658
+ /**
65659
+ * Request parameters for setLoginPreferredMfa operation in LoginsApi.
65660
+ */
65661
+ export interface LoginsApiSetLoginPreferredMfaRequest {
65662
+ /**
65663
+ * The username identifier
65664
+ */
65665
+ readonly username: string;
65666
+ readonly setLoginPreferredMfaRequest: SetLoginPreferredMfaRequest;
65667
+ }
65432
65668
  /**
65433
65669
  * Request parameters for updateLoginEmail operation in LoginsApi.
65434
65670
  */
@@ -65469,6 +65705,22 @@ export declare class LoginsApi extends BaseAPI {
65469
65705
  * @throws {RequiredError}
65470
65706
  */
65471
65707
  deleteLogin(requestParameters: LoginsApiDeleteLoginRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLogin200Response, any, {}, any>>;
65708
+ /**
65709
+ * 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.
65710
+ * @summary Delete a login\'s authenticator app
65711
+ * @param {LoginsApiDeleteLoginMfaTokenRequest} requestParameters Request parameters.
65712
+ * @param {*} [options] Override http request option.
65713
+ * @throws {RequiredError}
65714
+ */
65715
+ deleteLoginMfaToken(requestParameters: LoginsApiDeleteLoginMfaTokenRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginMfa200Response, any, {}, any>>;
65716
+ /**
65717
+ * 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.
65718
+ * @summary Turn off one of a login\'s MFA methods
65719
+ * @param {LoginsApiDisableLoginMfaRequest} requestParameters Request parameters.
65720
+ * @param {*} [options] Override http request option.
65721
+ * @throws {RequiredError}
65722
+ */
65723
+ disableLoginMfa(requestParameters: LoginsApiDisableLoginMfaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginMfa200Response, any, {}, any>>;
65472
65724
  /**
65473
65725
  * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
65474
65726
  * @summary Get a single login
@@ -65493,6 +65745,14 @@ export declare class LoginsApi extends BaseAPI {
65493
65745
  * @throws {RequiredError}
65494
65746
  */
65495
65747
  getLoginDevices(requestParameters: LoginsApiGetLoginDevicesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginDevices200Response, any, {}, any>>;
65748
+ /**
65749
+ * 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.
65750
+ * @summary Get a login\'s MFA settings
65751
+ * @param {LoginsApiGetLoginMfaRequest} requestParameters Request parameters.
65752
+ * @param {*} [options] Override http request option.
65753
+ * @throws {RequiredError}
65754
+ */
65755
+ getLoginMfa(requestParameters: LoginsApiGetLoginMfaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginMfa200Response, any, {}, any>>;
65496
65756
  /**
65497
65757
  * 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.
65498
65758
  * @summary List logins
@@ -65501,6 +65761,14 @@ export declare class LoginsApi extends BaseAPI {
65501
65761
  * @throws {RequiredError}
65502
65762
  */
65503
65763
  getLogins(requestParameters?: LoginsApiGetLoginsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLogins200Response, any, {}, any>>;
65764
+ /**
65765
+ * 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.
65766
+ * @summary Set a login\'s preferred MFA method
65767
+ * @param {LoginsApiSetLoginPreferredMfaRequest} requestParameters Request parameters.
65768
+ * @param {*} [options] Override http request option.
65769
+ * @throws {RequiredError}
65770
+ */
65771
+ setLoginPreferredMfa(requestParameters: LoginsApiSetLoginPreferredMfaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginMfa200Response, any, {}, any>>;
65504
65772
  /**
65505
65773
  * 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.
65506
65774
  * @summary Update a login\'s email