@connectedxm/admin-sdk 11.23.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.
- package/README.md +2 -2
- package/api.ts +13 -107
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +13 -60
- package/dist/api.js +13 -88
- 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 +13 -60
- package/dist/esm/api.js +13 -88
- 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/LoginsApi.md +3 -58
- package/package.json +1 -1
package/dist/api.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.23.
|
|
8
|
+
* The version of the OpenAPI document: 11.23.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -79904,8 +79904,8 @@ const LoginsApiAxiosParamCreator = function (configuration) {
|
|
|
79904
79904
|
};
|
|
79905
79905
|
}),
|
|
79906
79906
|
/**
|
|
79907
|
-
*
|
|
79908
|
-
* @summary
|
|
79907
|
+
* 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.
|
|
79908
|
+
* @summary Remove a login\'s two-factor authentication
|
|
79909
79909
|
* @param {string} username The username identifier
|
|
79910
79910
|
* @param {*} [options] Override http request option.
|
|
79911
79911
|
* @throws {RequiredError}
|
|
@@ -79937,44 +79937,6 @@ const LoginsApiAxiosParamCreator = function (configuration) {
|
|
|
79937
79937
|
options: localVarRequestOptions,
|
|
79938
79938
|
};
|
|
79939
79939
|
}),
|
|
79940
|
-
/**
|
|
79941
|
-
* 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.
|
|
79942
|
-
* @summary Turn off one of a login\'s MFA methods
|
|
79943
|
-
* @param {string} username The username identifier
|
|
79944
|
-
* @param {string} method The method identifier
|
|
79945
|
-
* @param {*} [options] Override http request option.
|
|
79946
|
-
* @throws {RequiredError}
|
|
79947
|
-
*/
|
|
79948
|
-
disableLoginMfa: (username_1, method_1, ...args_1) => __awaiter(this, [username_1, method_1, ...args_1], void 0, function* (username, method, options = {}) {
|
|
79949
|
-
// verify required parameter 'username' is not null or undefined
|
|
79950
|
-
(0, common_1.assertParamExists)('disableLoginMfa', 'username', username);
|
|
79951
|
-
// verify required parameter 'method' is not null or undefined
|
|
79952
|
-
(0, common_1.assertParamExists)('disableLoginMfa', 'method', method);
|
|
79953
|
-
const localVarPath = `/logins/{username}/mfa/{method}/disable`
|
|
79954
|
-
.replace('{username}', encodeURIComponent(String(username)))
|
|
79955
|
-
.replace('{method}', encodeURIComponent(String(method)));
|
|
79956
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
79957
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
79958
|
-
let baseOptions;
|
|
79959
|
-
if (configuration) {
|
|
79960
|
-
baseOptions = configuration.baseOptions;
|
|
79961
|
-
}
|
|
79962
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
79963
|
-
const localVarHeaderParameter = {};
|
|
79964
|
-
const localVarQueryParameter = {};
|
|
79965
|
-
// authentication ApiKeyAuth required
|
|
79966
|
-
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api-key", configuration);
|
|
79967
|
-
// authentication OrganizationId required
|
|
79968
|
-
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "organization", configuration);
|
|
79969
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
79970
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
79971
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
79972
|
-
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
79973
|
-
return {
|
|
79974
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
79975
|
-
options: localVarRequestOptions,
|
|
79976
|
-
};
|
|
79977
|
-
}),
|
|
79978
79940
|
/**
|
|
79979
79941
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
79980
79942
|
* @summary Get a single login
|
|
@@ -80194,7 +80156,7 @@ const LoginsApiAxiosParamCreator = function (configuration) {
|
|
|
80194
80156
|
};
|
|
80195
80157
|
}),
|
|
80196
80158
|
/**
|
|
80197
|
-
*
|
|
80159
|
+
* 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.
|
|
80198
80160
|
* @summary Set a login\'s preferred MFA method
|
|
80199
80161
|
* @param {string} username The username identifier
|
|
80200
80162
|
* @param {SetLoginPreferredMfaRequest} setLoginPreferredMfaRequest
|
|
@@ -80352,8 +80314,8 @@ const LoginsApiFp = function (configuration) {
|
|
|
80352
80314
|
});
|
|
80353
80315
|
},
|
|
80354
80316
|
/**
|
|
80355
|
-
*
|
|
80356
|
-
* @summary
|
|
80317
|
+
* 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.
|
|
80318
|
+
* @summary Remove a login\'s two-factor authentication
|
|
80357
80319
|
* @param {string} username The username identifier
|
|
80358
80320
|
* @param {*} [options] Override http request option.
|
|
80359
80321
|
* @throws {RequiredError}
|
|
@@ -80367,23 +80329,6 @@ const LoginsApiFp = function (configuration) {
|
|
|
80367
80329
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
80368
80330
|
});
|
|
80369
80331
|
},
|
|
80370
|
-
/**
|
|
80371
|
-
* 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.
|
|
80372
|
-
* @summary Turn off one of a login\'s MFA methods
|
|
80373
|
-
* @param {string} username The username identifier
|
|
80374
|
-
* @param {string} method The method identifier
|
|
80375
|
-
* @param {*} [options] Override http request option.
|
|
80376
|
-
* @throws {RequiredError}
|
|
80377
|
-
*/
|
|
80378
|
-
disableLoginMfa(username, method, options) {
|
|
80379
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
80380
|
-
var _a, _b, _c;
|
|
80381
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.disableLoginMfa(username, method, options);
|
|
80382
|
-
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
80383
|
-
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['LoginsApi.disableLoginMfa']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
80384
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
80385
|
-
});
|
|
80386
|
-
},
|
|
80387
80332
|
/**
|
|
80388
80333
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
80389
80334
|
* @summary Get a single login
|
|
@@ -80477,7 +80422,7 @@ const LoginsApiFp = function (configuration) {
|
|
|
80477
80422
|
});
|
|
80478
80423
|
},
|
|
80479
80424
|
/**
|
|
80480
|
-
*
|
|
80425
|
+
* 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.
|
|
80481
80426
|
* @summary Set a login\'s preferred MFA method
|
|
80482
80427
|
* @param {string} username The username identifier
|
|
80483
80428
|
* @param {SetLoginPreferredMfaRequest} setLoginPreferredMfaRequest
|
|
@@ -80557,8 +80502,8 @@ const LoginsApiFactory = function (configuration, basePath, axios) {
|
|
|
80557
80502
|
return localVarFp.deleteLogin(requestParameters.username, options).then((request) => request(axios, basePath));
|
|
80558
80503
|
},
|
|
80559
80504
|
/**
|
|
80560
|
-
*
|
|
80561
|
-
* @summary
|
|
80505
|
+
* 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.
|
|
80506
|
+
* @summary Remove a login\'s two-factor authentication
|
|
80562
80507
|
* @param {LoginsApiDeleteLoginMfaTokenRequest} requestParameters Request parameters.
|
|
80563
80508
|
* @param {*} [options] Override http request option.
|
|
80564
80509
|
* @throws {RequiredError}
|
|
@@ -80566,16 +80511,6 @@ const LoginsApiFactory = function (configuration, basePath, axios) {
|
|
|
80566
80511
|
deleteLoginMfaToken(requestParameters, options) {
|
|
80567
80512
|
return localVarFp.deleteLoginMfaToken(requestParameters.username, options).then((request) => request(axios, basePath));
|
|
80568
80513
|
},
|
|
80569
|
-
/**
|
|
80570
|
-
* 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.
|
|
80571
|
-
* @summary Turn off one of a login\'s MFA methods
|
|
80572
|
-
* @param {LoginsApiDisableLoginMfaRequest} requestParameters Request parameters.
|
|
80573
|
-
* @param {*} [options] Override http request option.
|
|
80574
|
-
* @throws {RequiredError}
|
|
80575
|
-
*/
|
|
80576
|
-
disableLoginMfa(requestParameters, options) {
|
|
80577
|
-
return localVarFp.disableLoginMfa(requestParameters.username, requestParameters.method, options).then((request) => request(axios, basePath));
|
|
80578
|
-
},
|
|
80579
80514
|
/**
|
|
80580
80515
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
80581
80516
|
* @summary Get a single login
|
|
@@ -80627,7 +80562,7 @@ const LoginsApiFactory = function (configuration, basePath, axios) {
|
|
|
80627
80562
|
return localVarFp.getLogins(requestParameters.accountId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
80628
80563
|
},
|
|
80629
80564
|
/**
|
|
80630
|
-
*
|
|
80565
|
+
* 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.
|
|
80631
80566
|
* @summary Set a login\'s preferred MFA method
|
|
80632
80567
|
* @param {LoginsApiSetLoginPreferredMfaRequest} requestParameters Request parameters.
|
|
80633
80568
|
* @param {*} [options] Override http request option.
|
|
@@ -80684,8 +80619,8 @@ class LoginsApi extends base_1.BaseAPI {
|
|
|
80684
80619
|
return (0, exports.LoginsApiFp)(this.configuration).deleteLogin(requestParameters.username, options).then((request) => request(this.axios, this.basePath));
|
|
80685
80620
|
}
|
|
80686
80621
|
/**
|
|
80687
|
-
*
|
|
80688
|
-
* @summary
|
|
80622
|
+
* 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.
|
|
80623
|
+
* @summary Remove a login\'s two-factor authentication
|
|
80689
80624
|
* @param {LoginsApiDeleteLoginMfaTokenRequest} requestParameters Request parameters.
|
|
80690
80625
|
* @param {*} [options] Override http request option.
|
|
80691
80626
|
* @throws {RequiredError}
|
|
@@ -80693,16 +80628,6 @@ class LoginsApi extends base_1.BaseAPI {
|
|
|
80693
80628
|
deleteLoginMfaToken(requestParameters, options) {
|
|
80694
80629
|
return (0, exports.LoginsApiFp)(this.configuration).deleteLoginMfaToken(requestParameters.username, options).then((request) => request(this.axios, this.basePath));
|
|
80695
80630
|
}
|
|
80696
|
-
/**
|
|
80697
|
-
* 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.
|
|
80698
|
-
* @summary Turn off one of a login\'s MFA methods
|
|
80699
|
-
* @param {LoginsApiDisableLoginMfaRequest} requestParameters Request parameters.
|
|
80700
|
-
* @param {*} [options] Override http request option.
|
|
80701
|
-
* @throws {RequiredError}
|
|
80702
|
-
*/
|
|
80703
|
-
disableLoginMfa(requestParameters, options) {
|
|
80704
|
-
return (0, exports.LoginsApiFp)(this.configuration).disableLoginMfa(requestParameters.username, requestParameters.method, options).then((request) => request(this.axios, this.basePath));
|
|
80705
|
-
}
|
|
80706
80631
|
/**
|
|
80707
80632
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
80708
80633
|
* @summary Get a single login
|
|
@@ -80754,7 +80679,7 @@ class LoginsApi extends base_1.BaseAPI {
|
|
|
80754
80679
|
return (0, exports.LoginsApiFp)(this.configuration).getLogins(requestParameters.accountId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
80755
80680
|
}
|
|
80756
80681
|
/**
|
|
80757
|
-
*
|
|
80682
|
+
* 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.
|
|
80758
80683
|
* @summary Set a login\'s preferred MFA method
|
|
80759
80684
|
* @param {LoginsApiSetLoginPreferredMfaRequest} requestParameters Request parameters.
|
|
80760
80685
|
* @param {*} [options] Override http request option.
|
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.23.
|
|
5
|
+
* The version of the OpenAPI document: 11.23.1
|
|
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.23.
|
|
8
|
+
* The version of the OpenAPI document: 11.23.1
|
|
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.23.
|
|
5
|
+
* The version of the OpenAPI document: 11.23.1
|
|
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.23.
|
|
8
|
+
* The version of the OpenAPI document: 11.23.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.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.23.
|
|
5
|
+
* The version of the OpenAPI document: 11.23.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.js
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.23.
|
|
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/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.23.
|
|
5
|
+
* The version of the OpenAPI document: 11.23.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -65208,22 +65208,13 @@ export declare const LoginsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
65208
65208
|
*/
|
|
65209
65209
|
deleteLogin: (username: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
65210
65210
|
/**
|
|
65211
|
-
*
|
|
65212
|
-
* @summary
|
|
65211
|
+
* 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.
|
|
65212
|
+
* @summary Remove a login\'s two-factor authentication
|
|
65213
65213
|
* @param {string} username The username identifier
|
|
65214
65214
|
* @param {*} [options] Override http request option.
|
|
65215
65215
|
* @throws {RequiredError}
|
|
65216
65216
|
*/
|
|
65217
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>;
|
|
65227
65218
|
/**
|
|
65228
65219
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
65229
65220
|
* @summary Get a single login
|
|
@@ -65277,7 +65268,7 @@ export declare const LoginsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
65277
65268
|
*/
|
|
65278
65269
|
getLogins: (accountId?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
65279
65270
|
/**
|
|
65280
|
-
*
|
|
65271
|
+
* 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.
|
|
65281
65272
|
* @summary Set a login\'s preferred MFA method
|
|
65282
65273
|
* @param {string} username The username identifier
|
|
65283
65274
|
* @param {SetLoginPreferredMfaRequest} setLoginPreferredMfaRequest
|
|
@@ -65325,22 +65316,13 @@ export declare const LoginsApiFp: (configuration?: Configuration) => {
|
|
|
65325
65316
|
*/
|
|
65326
65317
|
deleteLogin(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLogin200Response>>;
|
|
65327
65318
|
/**
|
|
65328
|
-
*
|
|
65329
|
-
* @summary
|
|
65319
|
+
* 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.
|
|
65320
|
+
* @summary Remove a login\'s two-factor authentication
|
|
65330
65321
|
* @param {string} username The username identifier
|
|
65331
65322
|
* @param {*} [options] Override http request option.
|
|
65332
65323
|
* @throws {RequiredError}
|
|
65333
65324
|
*/
|
|
65334
65325
|
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>>;
|
|
65344
65326
|
/**
|
|
65345
65327
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
65346
65328
|
* @summary Get a single login
|
|
@@ -65394,7 +65376,7 @@ export declare const LoginsApiFp: (configuration?: Configuration) => {
|
|
|
65394
65376
|
*/
|
|
65395
65377
|
getLogins(accountId?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLogins200Response>>;
|
|
65396
65378
|
/**
|
|
65397
|
-
*
|
|
65379
|
+
* 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.
|
|
65398
65380
|
* @summary Set a login\'s preferred MFA method
|
|
65399
65381
|
* @param {string} username The username identifier
|
|
65400
65382
|
* @param {SetLoginPreferredMfaRequest} setLoginPreferredMfaRequest
|
|
@@ -65442,21 +65424,13 @@ export declare const LoginsApiFactory: (configuration?: Configuration, basePath?
|
|
|
65442
65424
|
*/
|
|
65443
65425
|
deleteLogin(requestParameters: LoginsApiDeleteLoginRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLogin200Response>;
|
|
65444
65426
|
/**
|
|
65445
|
-
*
|
|
65446
|
-
* @summary
|
|
65427
|
+
* 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.
|
|
65428
|
+
* @summary Remove a login\'s two-factor authentication
|
|
65447
65429
|
* @param {LoginsApiDeleteLoginMfaTokenRequest} requestParameters Request parameters.
|
|
65448
65430
|
* @param {*} [options] Override http request option.
|
|
65449
65431
|
* @throws {RequiredError}
|
|
65450
65432
|
*/
|
|
65451
65433
|
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>;
|
|
65460
65434
|
/**
|
|
65461
65435
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
65462
65436
|
* @summary Get a single login
|
|
@@ -65498,7 +65472,7 @@ export declare const LoginsApiFactory: (configuration?: Configuration, basePath?
|
|
|
65498
65472
|
*/
|
|
65499
65473
|
getLogins(requestParameters?: LoginsApiGetLoginsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLogins200Response>;
|
|
65500
65474
|
/**
|
|
65501
|
-
*
|
|
65475
|
+
* 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.
|
|
65502
65476
|
* @summary Set a login\'s preferred MFA method
|
|
65503
65477
|
* @param {LoginsApiSetLoginPreferredMfaRequest} requestParameters Request parameters.
|
|
65504
65478
|
* @param {*} [options] Override http request option.
|
|
@@ -65549,19 +65523,6 @@ export interface LoginsApiDeleteLoginMfaTokenRequest {
|
|
|
65549
65523
|
*/
|
|
65550
65524
|
readonly username: string;
|
|
65551
65525
|
}
|
|
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
|
-
}
|
|
65565
65526
|
/**
|
|
65566
65527
|
* Request parameters for getLogin operation in LoginsApi.
|
|
65567
65528
|
*/
|
|
@@ -65706,21 +65667,13 @@ export declare class LoginsApi extends BaseAPI {
|
|
|
65706
65667
|
*/
|
|
65707
65668
|
deleteLogin(requestParameters: LoginsApiDeleteLoginRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLogin200Response, any, {}, any>>;
|
|
65708
65669
|
/**
|
|
65709
|
-
*
|
|
65710
|
-
* @summary
|
|
65670
|
+
* 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.
|
|
65671
|
+
* @summary Remove a login\'s two-factor authentication
|
|
65711
65672
|
* @param {LoginsApiDeleteLoginMfaTokenRequest} requestParameters Request parameters.
|
|
65712
65673
|
* @param {*} [options] Override http request option.
|
|
65713
65674
|
* @throws {RequiredError}
|
|
65714
65675
|
*/
|
|
65715
65676
|
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>>;
|
|
65724
65677
|
/**
|
|
65725
65678
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
65726
65679
|
* @summary Get a single login
|
|
@@ -65762,7 +65715,7 @@ export declare class LoginsApi extends BaseAPI {
|
|
|
65762
65715
|
*/
|
|
65763
65716
|
getLogins(requestParameters?: LoginsApiGetLoginsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLogins200Response, any, {}, any>>;
|
|
65764
65717
|
/**
|
|
65765
|
-
*
|
|
65718
|
+
* 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.
|
|
65766
65719
|
* @summary Set a login\'s preferred MFA method
|
|
65767
65720
|
* @param {LoginsApiSetLoginPreferredMfaRequest} requestParameters Request parameters.
|
|
65768
65721
|
* @param {*} [options] Override http request option.
|