@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/.openapi-generator/FILES +5 -0
- package/README.md +2 -2
- package/api.ts +525 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +269 -1
- package/dist/api.js +422 -27
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +269 -1
- package/dist/esm/api.js +396 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/docs/AccountsMergesApi.md +64 -0
- package/docs/GetAllAccountMerges200Response.md +26 -0
- package/docs/GetLoginMfa200Response.md +24 -0
- package/docs/LoginMfa.md +24 -0
- package/docs/LoginMfaMethod.md +12 -0
- package/docs/LoginsApi.md +215 -0
- package/docs/SetLoginPreferredMfaRequest.md +20 -0
- package/package.json +1 -1
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.
|
|
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).
|
|
@@ -7517,6 +7517,17 @@ export enum GetAdvertisements200ResponseStatusEnum {
|
|
|
7517
7517
|
Ok = 'ok'
|
|
7518
7518
|
}
|
|
7519
7519
|
|
|
7520
|
+
export interface GetAllAccountMerges200Response {
|
|
7521
|
+
'status': GetAllAccountMerges200ResponseStatusEnum;
|
|
7522
|
+
'message': string;
|
|
7523
|
+
'data': Array<AccountMerge>;
|
|
7524
|
+
'count'?: number;
|
|
7525
|
+
}
|
|
7526
|
+
|
|
7527
|
+
export enum GetAllAccountMerges200ResponseStatusEnum {
|
|
7528
|
+
Ok = 'ok'
|
|
7529
|
+
}
|
|
7530
|
+
|
|
7520
7531
|
export interface GetAnnouncementAudience200Response {
|
|
7521
7532
|
'status': GetAnnouncementAudience200ResponseStatusEnum;
|
|
7522
7533
|
'message': string;
|
|
@@ -9645,6 +9656,16 @@ export enum GetLoginDevices200ResponseStatusEnum {
|
|
|
9645
9656
|
Ok = 'ok'
|
|
9646
9657
|
}
|
|
9647
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
|
+
|
|
9648
9669
|
export interface GetLogins200Response {
|
|
9649
9670
|
'status': GetLogins200ResponseStatusEnum;
|
|
9650
9671
|
'message': string;
|
|
@@ -11425,6 +11446,21 @@ export interface LoginAllOfCount {
|
|
|
11425
11446
|
'accounts': number;
|
|
11426
11447
|
'devices': number;
|
|
11427
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
|
+
|
|
11428
11464
|
export interface MarkNotificationsReadInputs {
|
|
11429
11465
|
'notificationIds': Array<string>;
|
|
11430
11466
|
}
|
|
@@ -14059,6 +14095,11 @@ export interface SeriesUpdateInputs {
|
|
|
14059
14095
|
}
|
|
14060
14096
|
|
|
14061
14097
|
|
|
14098
|
+
export interface SetLoginPreferredMfaRequest {
|
|
14099
|
+
'method': LoginMfaMethod;
|
|
14100
|
+
}
|
|
14101
|
+
|
|
14102
|
+
|
|
14062
14103
|
export interface SideEffect {
|
|
14063
14104
|
'id': string;
|
|
14064
14105
|
'newPassOfPassTypeId': string | null;
|
|
@@ -20924,6 +20965,67 @@ export const AccountsMergesApiAxiosParamCreator = function (configuration?: Conf
|
|
|
20924
20965
|
options: localVarRequestOptions,
|
|
20925
20966
|
};
|
|
20926
20967
|
},
|
|
20968
|
+
/**
|
|
20969
|
+
* 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.
|
|
20970
|
+
* @summary List every account merge in the organization
|
|
20971
|
+
* @param {AccountMergeStatus} [status] Filter by status
|
|
20972
|
+
* @param {number} [page] Page number
|
|
20973
|
+
* @param {number} [pageSize] Number of items per page
|
|
20974
|
+
* @param {string} [orderBy] Field to order by
|
|
20975
|
+
* @param {string} [search] Search query
|
|
20976
|
+
* @param {*} [options] Override http request option.
|
|
20977
|
+
* @throws {RequiredError}
|
|
20978
|
+
*/
|
|
20979
|
+
getAllAccountMerges: async (status?: AccountMergeStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
20980
|
+
const localVarPath = `/accounts/merges`;
|
|
20981
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20982
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
20983
|
+
let baseOptions;
|
|
20984
|
+
if (configuration) {
|
|
20985
|
+
baseOptions = configuration.baseOptions;
|
|
20986
|
+
}
|
|
20987
|
+
|
|
20988
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
20989
|
+
const localVarHeaderParameter = {} as any;
|
|
20990
|
+
const localVarQueryParameter = {} as any;
|
|
20991
|
+
|
|
20992
|
+
// authentication ApiKeyAuth required
|
|
20993
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
20994
|
+
|
|
20995
|
+
// authentication OrganizationId required
|
|
20996
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
20997
|
+
|
|
20998
|
+
if (status !== undefined) {
|
|
20999
|
+
localVarQueryParameter['status'] = status;
|
|
21000
|
+
}
|
|
21001
|
+
|
|
21002
|
+
if (page !== undefined) {
|
|
21003
|
+
localVarQueryParameter['page'] = page;
|
|
21004
|
+
}
|
|
21005
|
+
|
|
21006
|
+
if (pageSize !== undefined) {
|
|
21007
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
21008
|
+
}
|
|
21009
|
+
|
|
21010
|
+
if (orderBy !== undefined) {
|
|
21011
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
21012
|
+
}
|
|
21013
|
+
|
|
21014
|
+
if (search !== undefined) {
|
|
21015
|
+
localVarQueryParameter['search'] = search;
|
|
21016
|
+
}
|
|
21017
|
+
|
|
21018
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
21019
|
+
|
|
21020
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
21021
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
21022
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
21023
|
+
|
|
21024
|
+
return {
|
|
21025
|
+
url: toPathString(localVarUrlObj),
|
|
21026
|
+
options: localVarRequestOptions,
|
|
21027
|
+
};
|
|
21028
|
+
},
|
|
20927
21029
|
/**
|
|
20928
21030
|
* 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.
|
|
20929
21031
|
* @summary Merge an account into another
|
|
@@ -21058,6 +21160,23 @@ export const AccountsMergesApiFp = function(configuration?: Configuration) {
|
|
|
21058
21160
|
const localVarOperationServerBasePath = operationServerMap['AccountsMergesApi.getAccountMerges']?.[localVarOperationServerIndex]?.url;
|
|
21059
21161
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21060
21162
|
},
|
|
21163
|
+
/**
|
|
21164
|
+
* 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.
|
|
21165
|
+
* @summary List every account merge in the organization
|
|
21166
|
+
* @param {AccountMergeStatus} [status] Filter by status
|
|
21167
|
+
* @param {number} [page] Page number
|
|
21168
|
+
* @param {number} [pageSize] Number of items per page
|
|
21169
|
+
* @param {string} [orderBy] Field to order by
|
|
21170
|
+
* @param {string} [search] Search query
|
|
21171
|
+
* @param {*} [options] Override http request option.
|
|
21172
|
+
* @throws {RequiredError}
|
|
21173
|
+
*/
|
|
21174
|
+
async getAllAccountMerges(status?: AccountMergeStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllAccountMerges200Response>> {
|
|
21175
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAllAccountMerges(status, page, pageSize, orderBy, search, options);
|
|
21176
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
21177
|
+
const localVarOperationServerBasePath = operationServerMap['AccountsMergesApi.getAllAccountMerges']?.[localVarOperationServerIndex]?.url;
|
|
21178
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21179
|
+
},
|
|
21061
21180
|
/**
|
|
21062
21181
|
* 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.
|
|
21063
21182
|
* @summary Merge an account into another
|
|
@@ -21124,6 +21243,16 @@ export const AccountsMergesApiFactory = function (configuration?: Configuration,
|
|
|
21124
21243
|
getAccountMerges(requestParameters: AccountsMergesApiGetAccountMergesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMerges200Response> {
|
|
21125
21244
|
return localVarFp.getAccountMerges(requestParameters.accountId, options).then((request) => request(axios, basePath));
|
|
21126
21245
|
},
|
|
21246
|
+
/**
|
|
21247
|
+
* 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.
|
|
21248
|
+
* @summary List every account merge in the organization
|
|
21249
|
+
* @param {AccountsMergesApiGetAllAccountMergesRequest} requestParameters Request parameters.
|
|
21250
|
+
* @param {*} [options] Override http request option.
|
|
21251
|
+
* @throws {RequiredError}
|
|
21252
|
+
*/
|
|
21253
|
+
getAllAccountMerges(requestParameters: AccountsMergesApiGetAllAccountMergesRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<GetAllAccountMerges200Response> {
|
|
21254
|
+
return localVarFp.getAllAccountMerges(requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
21255
|
+
},
|
|
21127
21256
|
/**
|
|
21128
21257
|
* 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.
|
|
21129
21258
|
* @summary Merge an account into another
|
|
@@ -21182,6 +21311,36 @@ export interface AccountsMergesApiGetAccountMergesRequest {
|
|
|
21182
21311
|
readonly accountId: string
|
|
21183
21312
|
}
|
|
21184
21313
|
|
|
21314
|
+
/**
|
|
21315
|
+
* Request parameters for getAllAccountMerges operation in AccountsMergesApi.
|
|
21316
|
+
*/
|
|
21317
|
+
export interface AccountsMergesApiGetAllAccountMergesRequest {
|
|
21318
|
+
/**
|
|
21319
|
+
* Filter by status
|
|
21320
|
+
*/
|
|
21321
|
+
readonly status?: AccountMergeStatus
|
|
21322
|
+
|
|
21323
|
+
/**
|
|
21324
|
+
* Page number
|
|
21325
|
+
*/
|
|
21326
|
+
readonly page?: number
|
|
21327
|
+
|
|
21328
|
+
/**
|
|
21329
|
+
* Number of items per page
|
|
21330
|
+
*/
|
|
21331
|
+
readonly pageSize?: number
|
|
21332
|
+
|
|
21333
|
+
/**
|
|
21334
|
+
* Field to order by
|
|
21335
|
+
*/
|
|
21336
|
+
readonly orderBy?: string
|
|
21337
|
+
|
|
21338
|
+
/**
|
|
21339
|
+
* Search query
|
|
21340
|
+
*/
|
|
21341
|
+
readonly search?: string
|
|
21342
|
+
}
|
|
21343
|
+
|
|
21185
21344
|
/**
|
|
21186
21345
|
* Request parameters for mergeAccount operation in AccountsMergesApi.
|
|
21187
21346
|
*/
|
|
@@ -21241,6 +21400,17 @@ export class AccountsMergesApi extends BaseAPI {
|
|
|
21241
21400
|
return AccountsMergesApiFp(this.configuration).getAccountMerges(requestParameters.accountId, options).then((request) => request(this.axios, this.basePath));
|
|
21242
21401
|
}
|
|
21243
21402
|
|
|
21403
|
+
/**
|
|
21404
|
+
* 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.
|
|
21405
|
+
* @summary List every account merge in the organization
|
|
21406
|
+
* @param {AccountsMergesApiGetAllAccountMergesRequest} requestParameters Request parameters.
|
|
21407
|
+
* @param {*} [options] Override http request option.
|
|
21408
|
+
* @throws {RequiredError}
|
|
21409
|
+
*/
|
|
21410
|
+
public getAllAccountMerges(requestParameters: AccountsMergesApiGetAllAccountMergesRequest = {}, options?: RawAxiosRequestConfig) {
|
|
21411
|
+
return AccountsMergesApiFp(this.configuration).getAllAccountMerges(requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
21412
|
+
}
|
|
21413
|
+
|
|
21244
21414
|
/**
|
|
21245
21415
|
* 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.
|
|
21246
21416
|
* @summary Merge an account into another
|
|
@@ -116411,6 +116581,90 @@ export const LoginsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
116411
116581
|
options: localVarRequestOptions,
|
|
116412
116582
|
};
|
|
116413
116583
|
},
|
|
116584
|
+
/**
|
|
116585
|
+
* 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.
|
|
116586
|
+
* @summary Delete a login\'s authenticator app
|
|
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
|
+
},
|
|
116624
|
+
/**
|
|
116625
|
+
* 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.
|
|
116626
|
+
* @summary Turn off one of a login\'s MFA methods
|
|
116627
|
+
* @param {string} username The username identifier
|
|
116628
|
+
* @param {string} method The method identifier
|
|
116629
|
+
* @param {*} [options] Override http request option.
|
|
116630
|
+
* @throws {RequiredError}
|
|
116631
|
+
*/
|
|
116632
|
+
disableLoginMfa: async (username: string, method: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
116633
|
+
// verify required parameter 'username' is not null or undefined
|
|
116634
|
+
assertParamExists('disableLoginMfa', 'username', username)
|
|
116635
|
+
// verify required parameter 'method' is not null or undefined
|
|
116636
|
+
assertParamExists('disableLoginMfa', 'method', method)
|
|
116637
|
+
const localVarPath = `/logins/{username}/mfa/{method}/disable`
|
|
116638
|
+
.replace('{username}', encodeURIComponent(String(username)))
|
|
116639
|
+
.replace('{method}', encodeURIComponent(String(method)));
|
|
116640
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
116641
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
116642
|
+
let baseOptions;
|
|
116643
|
+
if (configuration) {
|
|
116644
|
+
baseOptions = configuration.baseOptions;
|
|
116645
|
+
}
|
|
116646
|
+
|
|
116647
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
116648
|
+
const localVarHeaderParameter = {} as any;
|
|
116649
|
+
const localVarQueryParameter = {} as any;
|
|
116650
|
+
|
|
116651
|
+
// authentication ApiKeyAuth required
|
|
116652
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
116653
|
+
|
|
116654
|
+
// authentication OrganizationId required
|
|
116655
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
116656
|
+
|
|
116657
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
116658
|
+
|
|
116659
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
116660
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
116661
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
116662
|
+
|
|
116663
|
+
return {
|
|
116664
|
+
url: toPathString(localVarUrlObj),
|
|
116665
|
+
options: localVarRequestOptions,
|
|
116666
|
+
};
|
|
116667
|
+
},
|
|
116414
116668
|
/**
|
|
116415
116669
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
116416
116670
|
* @summary Get a single login
|
|
@@ -116571,6 +116825,46 @@ export const LoginsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
116571
116825
|
options: localVarRequestOptions,
|
|
116572
116826
|
};
|
|
116573
116827
|
},
|
|
116828
|
+
/**
|
|
116829
|
+
* 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.
|
|
116830
|
+
* @summary Get a login\'s MFA settings
|
|
116831
|
+
* @param {string} username The username identifier
|
|
116832
|
+
* @param {*} [options] Override http request option.
|
|
116833
|
+
* @throws {RequiredError}
|
|
116834
|
+
*/
|
|
116835
|
+
getLoginMfa: async (username: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
116836
|
+
// verify required parameter 'username' is not null or undefined
|
|
116837
|
+
assertParamExists('getLoginMfa', 'username', username)
|
|
116838
|
+
const localVarPath = `/logins/{username}/mfa`
|
|
116839
|
+
.replace('{username}', encodeURIComponent(String(username)));
|
|
116840
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
116841
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
116842
|
+
let baseOptions;
|
|
116843
|
+
if (configuration) {
|
|
116844
|
+
baseOptions = configuration.baseOptions;
|
|
116845
|
+
}
|
|
116846
|
+
|
|
116847
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
116848
|
+
const localVarHeaderParameter = {} as any;
|
|
116849
|
+
const localVarQueryParameter = {} as any;
|
|
116850
|
+
|
|
116851
|
+
// authentication ApiKeyAuth required
|
|
116852
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
116853
|
+
|
|
116854
|
+
// authentication OrganizationId required
|
|
116855
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
116856
|
+
|
|
116857
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
116858
|
+
|
|
116859
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
116860
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
116861
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
116862
|
+
|
|
116863
|
+
return {
|
|
116864
|
+
url: toPathString(localVarUrlObj),
|
|
116865
|
+
options: localVarRequestOptions,
|
|
116866
|
+
};
|
|
116867
|
+
},
|
|
116574
116868
|
/**
|
|
116575
116869
|
* 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.
|
|
116576
116870
|
* @summary List logins
|
|
@@ -116632,6 +116926,51 @@ export const LoginsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
116632
116926
|
options: localVarRequestOptions,
|
|
116633
116927
|
};
|
|
116634
116928
|
},
|
|
116929
|
+
/**
|
|
116930
|
+
* 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.
|
|
116931
|
+
* @summary Set a login\'s preferred MFA method
|
|
116932
|
+
* @param {string} username The username identifier
|
|
116933
|
+
* @param {SetLoginPreferredMfaRequest} setLoginPreferredMfaRequest
|
|
116934
|
+
* @param {*} [options] Override http request option.
|
|
116935
|
+
* @throws {RequiredError}
|
|
116936
|
+
*/
|
|
116937
|
+
setLoginPreferredMfa: async (username: string, setLoginPreferredMfaRequest: SetLoginPreferredMfaRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
116938
|
+
// verify required parameter 'username' is not null or undefined
|
|
116939
|
+
assertParamExists('setLoginPreferredMfa', 'username', username)
|
|
116940
|
+
// verify required parameter 'setLoginPreferredMfaRequest' is not null or undefined
|
|
116941
|
+
assertParamExists('setLoginPreferredMfa', 'setLoginPreferredMfaRequest', setLoginPreferredMfaRequest)
|
|
116942
|
+
const localVarPath = `/logins/{username}/mfa/preferred`
|
|
116943
|
+
.replace('{username}', encodeURIComponent(String(username)));
|
|
116944
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
116945
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
116946
|
+
let baseOptions;
|
|
116947
|
+
if (configuration) {
|
|
116948
|
+
baseOptions = configuration.baseOptions;
|
|
116949
|
+
}
|
|
116950
|
+
|
|
116951
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
116952
|
+
const localVarHeaderParameter = {} as any;
|
|
116953
|
+
const localVarQueryParameter = {} as any;
|
|
116954
|
+
|
|
116955
|
+
// authentication ApiKeyAuth required
|
|
116956
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
116957
|
+
|
|
116958
|
+
// authentication OrganizationId required
|
|
116959
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
116960
|
+
|
|
116961
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
116962
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
116963
|
+
|
|
116964
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
116965
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
116966
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
116967
|
+
localVarRequestOptions.data = serializeDataIfNeeded(setLoginPreferredMfaRequest, localVarRequestOptions, configuration)
|
|
116968
|
+
|
|
116969
|
+
return {
|
|
116970
|
+
url: toPathString(localVarUrlObj),
|
|
116971
|
+
options: localVarRequestOptions,
|
|
116972
|
+
};
|
|
116973
|
+
},
|
|
116635
116974
|
/**
|
|
116636
116975
|
* 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.
|
|
116637
116976
|
* @summary Update a login\'s email
|
|
@@ -116757,6 +117096,33 @@ export const LoginsApiFp = function(configuration?: Configuration) {
|
|
|
116757
117096
|
const localVarOperationServerBasePath = operationServerMap['LoginsApi.deleteLogin']?.[localVarOperationServerIndex]?.url;
|
|
116758
117097
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
116759
117098
|
},
|
|
117099
|
+
/**
|
|
117100
|
+
* 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.
|
|
117101
|
+
* @summary Delete a login\'s authenticator app
|
|
117102
|
+
* @param {string} username The username identifier
|
|
117103
|
+
* @param {*} [options] Override http request option.
|
|
117104
|
+
* @throws {RequiredError}
|
|
117105
|
+
*/
|
|
117106
|
+
async deleteLoginMfaToken(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginMfa200Response>> {
|
|
117107
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteLoginMfaToken(username, options);
|
|
117108
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
117109
|
+
const localVarOperationServerBasePath = operationServerMap['LoginsApi.deleteLoginMfaToken']?.[localVarOperationServerIndex]?.url;
|
|
117110
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
117111
|
+
},
|
|
117112
|
+
/**
|
|
117113
|
+
* 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.
|
|
117114
|
+
* @summary Turn off one of a login\'s MFA methods
|
|
117115
|
+
* @param {string} username The username identifier
|
|
117116
|
+
* @param {string} method The method identifier
|
|
117117
|
+
* @param {*} [options] Override http request option.
|
|
117118
|
+
* @throws {RequiredError}
|
|
117119
|
+
*/
|
|
117120
|
+
async disableLoginMfa(username: string, method: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginMfa200Response>> {
|
|
117121
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.disableLoginMfa(username, method, options);
|
|
117122
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
117123
|
+
const localVarOperationServerBasePath = operationServerMap['LoginsApi.disableLoginMfa']?.[localVarOperationServerIndex]?.url;
|
|
117124
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
117125
|
+
},
|
|
116760
117126
|
/**
|
|
116761
117127
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
116762
117128
|
* @summary Get a single login
|
|
@@ -116804,6 +117170,19 @@ export const LoginsApiFp = function(configuration?: Configuration) {
|
|
|
116804
117170
|
const localVarOperationServerBasePath = operationServerMap['LoginsApi.getLoginDevices']?.[localVarOperationServerIndex]?.url;
|
|
116805
117171
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
116806
117172
|
},
|
|
117173
|
+
/**
|
|
117174
|
+
* 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.
|
|
117175
|
+
* @summary Get a login\'s MFA settings
|
|
117176
|
+
* @param {string} username The username identifier
|
|
117177
|
+
* @param {*} [options] Override http request option.
|
|
117178
|
+
* @throws {RequiredError}
|
|
117179
|
+
*/
|
|
117180
|
+
async getLoginMfa(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginMfa200Response>> {
|
|
117181
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getLoginMfa(username, options);
|
|
117182
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
117183
|
+
const localVarOperationServerBasePath = operationServerMap['LoginsApi.getLoginMfa']?.[localVarOperationServerIndex]?.url;
|
|
117184
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
117185
|
+
},
|
|
116807
117186
|
/**
|
|
116808
117187
|
* 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.
|
|
116809
117188
|
* @summary List logins
|
|
@@ -116821,6 +117200,20 @@ export const LoginsApiFp = function(configuration?: Configuration) {
|
|
|
116821
117200
|
const localVarOperationServerBasePath = operationServerMap['LoginsApi.getLogins']?.[localVarOperationServerIndex]?.url;
|
|
116822
117201
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
116823
117202
|
},
|
|
117203
|
+
/**
|
|
117204
|
+
* 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.
|
|
117205
|
+
* @summary Set a login\'s preferred MFA method
|
|
117206
|
+
* @param {string} username The username identifier
|
|
117207
|
+
* @param {SetLoginPreferredMfaRequest} setLoginPreferredMfaRequest
|
|
117208
|
+
* @param {*} [options] Override http request option.
|
|
117209
|
+
* @throws {RequiredError}
|
|
117210
|
+
*/
|
|
117211
|
+
async setLoginPreferredMfa(username: string, setLoginPreferredMfaRequest: SetLoginPreferredMfaRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginMfa200Response>> {
|
|
117212
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setLoginPreferredMfa(username, setLoginPreferredMfaRequest, options);
|
|
117213
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
117214
|
+
const localVarOperationServerBasePath = operationServerMap['LoginsApi.setLoginPreferredMfa']?.[localVarOperationServerIndex]?.url;
|
|
117215
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
117216
|
+
},
|
|
116824
117217
|
/**
|
|
116825
117218
|
* 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.
|
|
116826
117219
|
* @summary Update a login\'s email
|
|
@@ -116878,6 +117271,26 @@ export const LoginsApiFactory = function (configuration?: Configuration, basePat
|
|
|
116878
117271
|
deleteLogin(requestParameters: LoginsApiDeleteLoginRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLogin200Response> {
|
|
116879
117272
|
return localVarFp.deleteLogin(requestParameters.username, options).then((request) => request(axios, basePath));
|
|
116880
117273
|
},
|
|
117274
|
+
/**
|
|
117275
|
+
* 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.
|
|
117276
|
+
* @summary Delete a login\'s authenticator app
|
|
117277
|
+
* @param {LoginsApiDeleteLoginMfaTokenRequest} requestParameters Request parameters.
|
|
117278
|
+
* @param {*} [options] Override http request option.
|
|
117279
|
+
* @throws {RequiredError}
|
|
117280
|
+
*/
|
|
117281
|
+
deleteLoginMfaToken(requestParameters: LoginsApiDeleteLoginMfaTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginMfa200Response> {
|
|
117282
|
+
return localVarFp.deleteLoginMfaToken(requestParameters.username, options).then((request) => request(axios, basePath));
|
|
117283
|
+
},
|
|
117284
|
+
/**
|
|
117285
|
+
* 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.
|
|
117286
|
+
* @summary Turn off one of a login\'s MFA methods
|
|
117287
|
+
* @param {LoginsApiDisableLoginMfaRequest} requestParameters Request parameters.
|
|
117288
|
+
* @param {*} [options] Override http request option.
|
|
117289
|
+
* @throws {RequiredError}
|
|
117290
|
+
*/
|
|
117291
|
+
disableLoginMfa(requestParameters: LoginsApiDisableLoginMfaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginMfa200Response> {
|
|
117292
|
+
return localVarFp.disableLoginMfa(requestParameters.username, requestParameters.method, options).then((request) => request(axios, basePath));
|
|
117293
|
+
},
|
|
116881
117294
|
/**
|
|
116882
117295
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
116883
117296
|
* @summary Get a single login
|
|
@@ -116908,6 +117321,16 @@ export const LoginsApiFactory = function (configuration?: Configuration, basePat
|
|
|
116908
117321
|
getLoginDevices(requestParameters: LoginsApiGetLoginDevicesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginDevices200Response> {
|
|
116909
117322
|
return localVarFp.getLoginDevices(requestParameters.username, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
116910
117323
|
},
|
|
117324
|
+
/**
|
|
117325
|
+
* 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.
|
|
117326
|
+
* @summary Get a login\'s MFA settings
|
|
117327
|
+
* @param {LoginsApiGetLoginMfaRequest} requestParameters Request parameters.
|
|
117328
|
+
* @param {*} [options] Override http request option.
|
|
117329
|
+
* @throws {RequiredError}
|
|
117330
|
+
*/
|
|
117331
|
+
getLoginMfa(requestParameters: LoginsApiGetLoginMfaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginMfa200Response> {
|
|
117332
|
+
return localVarFp.getLoginMfa(requestParameters.username, options).then((request) => request(axios, basePath));
|
|
117333
|
+
},
|
|
116911
117334
|
/**
|
|
116912
117335
|
* 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.
|
|
116913
117336
|
* @summary List logins
|
|
@@ -116918,6 +117341,16 @@ export const LoginsApiFactory = function (configuration?: Configuration, basePat
|
|
|
116918
117341
|
getLogins(requestParameters: LoginsApiGetLoginsRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<GetLogins200Response> {
|
|
116919
117342
|
return localVarFp.getLogins(requestParameters.accountId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
116920
117343
|
},
|
|
117344
|
+
/**
|
|
117345
|
+
* 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.
|
|
117346
|
+
* @summary Set a login\'s preferred MFA method
|
|
117347
|
+
* @param {LoginsApiSetLoginPreferredMfaRequest} requestParameters Request parameters.
|
|
117348
|
+
* @param {*} [options] Override http request option.
|
|
117349
|
+
* @throws {RequiredError}
|
|
117350
|
+
*/
|
|
117351
|
+
setLoginPreferredMfa(requestParameters: LoginsApiSetLoginPreferredMfaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginMfa200Response> {
|
|
117352
|
+
return localVarFp.setLoginPreferredMfa(requestParameters.username, requestParameters.setLoginPreferredMfaRequest, options).then((request) => request(axios, basePath));
|
|
117353
|
+
},
|
|
116921
117354
|
/**
|
|
116922
117355
|
* 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.
|
|
116923
117356
|
* @summary Update a login\'s email
|
|
@@ -116961,6 +117394,31 @@ export interface LoginsApiDeleteLoginRequest {
|
|
|
116961
117394
|
readonly username: string
|
|
116962
117395
|
}
|
|
116963
117396
|
|
|
117397
|
+
/**
|
|
117398
|
+
* Request parameters for deleteLoginMfaToken operation in LoginsApi.
|
|
117399
|
+
*/
|
|
117400
|
+
export interface LoginsApiDeleteLoginMfaTokenRequest {
|
|
117401
|
+
/**
|
|
117402
|
+
* The username identifier
|
|
117403
|
+
*/
|
|
117404
|
+
readonly username: string
|
|
117405
|
+
}
|
|
117406
|
+
|
|
117407
|
+
/**
|
|
117408
|
+
* Request parameters for disableLoginMfa operation in LoginsApi.
|
|
117409
|
+
*/
|
|
117410
|
+
export interface LoginsApiDisableLoginMfaRequest {
|
|
117411
|
+
/**
|
|
117412
|
+
* The username identifier
|
|
117413
|
+
*/
|
|
117414
|
+
readonly username: string
|
|
117415
|
+
|
|
117416
|
+
/**
|
|
117417
|
+
* The method identifier
|
|
117418
|
+
*/
|
|
117419
|
+
readonly method: string
|
|
117420
|
+
}
|
|
117421
|
+
|
|
116964
117422
|
/**
|
|
116965
117423
|
* Request parameters for getLogin operation in LoginsApi.
|
|
116966
117424
|
*/
|
|
@@ -117031,6 +117489,16 @@ export interface LoginsApiGetLoginDevicesRequest {
|
|
|
117031
117489
|
readonly search?: string
|
|
117032
117490
|
}
|
|
117033
117491
|
|
|
117492
|
+
/**
|
|
117493
|
+
* Request parameters for getLoginMfa operation in LoginsApi.
|
|
117494
|
+
*/
|
|
117495
|
+
export interface LoginsApiGetLoginMfaRequest {
|
|
117496
|
+
/**
|
|
117497
|
+
* The username identifier
|
|
117498
|
+
*/
|
|
117499
|
+
readonly username: string
|
|
117500
|
+
}
|
|
117501
|
+
|
|
117034
117502
|
/**
|
|
117035
117503
|
* Request parameters for getLogins operation in LoginsApi.
|
|
117036
117504
|
*/
|
|
@@ -117061,6 +117529,18 @@ export interface LoginsApiGetLoginsRequest {
|
|
|
117061
117529
|
readonly search?: string
|
|
117062
117530
|
}
|
|
117063
117531
|
|
|
117532
|
+
/**
|
|
117533
|
+
* Request parameters for setLoginPreferredMfa operation in LoginsApi.
|
|
117534
|
+
*/
|
|
117535
|
+
export interface LoginsApiSetLoginPreferredMfaRequest {
|
|
117536
|
+
/**
|
|
117537
|
+
* The username identifier
|
|
117538
|
+
*/
|
|
117539
|
+
readonly username: string
|
|
117540
|
+
|
|
117541
|
+
readonly setLoginPreferredMfaRequest: SetLoginPreferredMfaRequest
|
|
117542
|
+
}
|
|
117543
|
+
|
|
117064
117544
|
/**
|
|
117065
117545
|
* Request parameters for updateLoginEmail operation in LoginsApi.
|
|
117066
117546
|
*/
|
|
@@ -117111,6 +117591,28 @@ export class LoginsApi extends BaseAPI {
|
|
|
117111
117591
|
return LoginsApiFp(this.configuration).deleteLogin(requestParameters.username, options).then((request) => request(this.axios, this.basePath));
|
|
117112
117592
|
}
|
|
117113
117593
|
|
|
117594
|
+
/**
|
|
117595
|
+
* 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.
|
|
117596
|
+
* @summary Delete a login\'s authenticator app
|
|
117597
|
+
* @param {LoginsApiDeleteLoginMfaTokenRequest} requestParameters Request parameters.
|
|
117598
|
+
* @param {*} [options] Override http request option.
|
|
117599
|
+
* @throws {RequiredError}
|
|
117600
|
+
*/
|
|
117601
|
+
public deleteLoginMfaToken(requestParameters: LoginsApiDeleteLoginMfaTokenRequest, options?: RawAxiosRequestConfig) {
|
|
117602
|
+
return LoginsApiFp(this.configuration).deleteLoginMfaToken(requestParameters.username, options).then((request) => request(this.axios, this.basePath));
|
|
117603
|
+
}
|
|
117604
|
+
|
|
117605
|
+
/**
|
|
117606
|
+
* 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.
|
|
117607
|
+
* @summary Turn off one of a login\'s MFA methods
|
|
117608
|
+
* @param {LoginsApiDisableLoginMfaRequest} requestParameters Request parameters.
|
|
117609
|
+
* @param {*} [options] Override http request option.
|
|
117610
|
+
* @throws {RequiredError}
|
|
117611
|
+
*/
|
|
117612
|
+
public disableLoginMfa(requestParameters: LoginsApiDisableLoginMfaRequest, options?: RawAxiosRequestConfig) {
|
|
117613
|
+
return LoginsApiFp(this.configuration).disableLoginMfa(requestParameters.username, requestParameters.method, options).then((request) => request(this.axios, this.basePath));
|
|
117614
|
+
}
|
|
117615
|
+
|
|
117114
117616
|
/**
|
|
117115
117617
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
117116
117618
|
* @summary Get a single login
|
|
@@ -117144,6 +117646,17 @@ export class LoginsApi extends BaseAPI {
|
|
|
117144
117646
|
return LoginsApiFp(this.configuration).getLoginDevices(requestParameters.username, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
117145
117647
|
}
|
|
117146
117648
|
|
|
117649
|
+
/**
|
|
117650
|
+
* 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.
|
|
117651
|
+
* @summary Get a login\'s MFA settings
|
|
117652
|
+
* @param {LoginsApiGetLoginMfaRequest} requestParameters Request parameters.
|
|
117653
|
+
* @param {*} [options] Override http request option.
|
|
117654
|
+
* @throws {RequiredError}
|
|
117655
|
+
*/
|
|
117656
|
+
public getLoginMfa(requestParameters: LoginsApiGetLoginMfaRequest, options?: RawAxiosRequestConfig) {
|
|
117657
|
+
return LoginsApiFp(this.configuration).getLoginMfa(requestParameters.username, options).then((request) => request(this.axios, this.basePath));
|
|
117658
|
+
}
|
|
117659
|
+
|
|
117147
117660
|
/**
|
|
117148
117661
|
* 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.
|
|
117149
117662
|
* @summary List logins
|
|
@@ -117155,6 +117668,17 @@ export class LoginsApi extends BaseAPI {
|
|
|
117155
117668
|
return LoginsApiFp(this.configuration).getLogins(requestParameters.accountId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
117156
117669
|
}
|
|
117157
117670
|
|
|
117671
|
+
/**
|
|
117672
|
+
* 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.
|
|
117673
|
+
* @summary Set a login\'s preferred MFA method
|
|
117674
|
+
* @param {LoginsApiSetLoginPreferredMfaRequest} requestParameters Request parameters.
|
|
117675
|
+
* @param {*} [options] Override http request option.
|
|
117676
|
+
* @throws {RequiredError}
|
|
117677
|
+
*/
|
|
117678
|
+
public setLoginPreferredMfa(requestParameters: LoginsApiSetLoginPreferredMfaRequest, options?: RawAxiosRequestConfig) {
|
|
117679
|
+
return LoginsApiFp(this.configuration).setLoginPreferredMfa(requestParameters.username, requestParameters.setLoginPreferredMfaRequest, options).then((request) => request(this.axios, this.basePath));
|
|
117680
|
+
}
|
|
117681
|
+
|
|
117158
117682
|
/**
|
|
117159
117683
|
* 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.
|
|
117160
117684
|
* @summary Update a login\'s email
|