@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/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @connectedxm/admin-sdk@11.23.
|
|
1
|
+
## @connectedxm/admin-sdk@11.23.1
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @connectedxm/admin-sdk@11.23.
|
|
39
|
+
npm install @connectedxm/admin-sdk@11.23.1 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 11.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).
|
|
@@ -116582,8 +116582,8 @@ export const LoginsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
116582
116582
|
};
|
|
116583
116583
|
},
|
|
116584
116584
|
/**
|
|
116585
|
-
*
|
|
116586
|
-
* @summary
|
|
116585
|
+
* Removes two-factor authentication from the email login with the given username and returns its updated MFA settings. It turns TOTP off and deletes it, so nothing is left to turn back on. The user can then sign in with their password and set up two-factor authentication again. Removing when none is set up succeeds. Requires read and update permissions on accounts.
|
|
116586
|
+
* @summary Remove a login\'s two-factor authentication
|
|
116587
116587
|
* @param {string} username The username identifier
|
|
116588
116588
|
* @param {*} [options] Override http request option.
|
|
116589
116589
|
* @throws {RequiredError}
|
|
@@ -116621,50 +116621,6 @@ export const LoginsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
116621
116621
|
options: localVarRequestOptions,
|
|
116622
116622
|
};
|
|
116623
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
|
-
},
|
|
116668
116624
|
/**
|
|
116669
116625
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
116670
116626
|
* @summary Get a single login
|
|
@@ -116927,7 +116883,7 @@ export const LoginsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
116927
116883
|
};
|
|
116928
116884
|
},
|
|
116929
116885
|
/**
|
|
116930
|
-
*
|
|
116886
|
+
* Makes the given MFA method the preferred one for the email login with the given username, and returns its updated MFA settings. The method must already be turned on for the login; any other method returns a 400, so this can\'t revive a method the user turned off. Requires read and update permissions on accounts.
|
|
116931
116887
|
* @summary Set a login\'s preferred MFA method
|
|
116932
116888
|
* @param {string} username The username identifier
|
|
116933
116889
|
* @param {SetLoginPreferredMfaRequest} setLoginPreferredMfaRequest
|
|
@@ -117097,8 +117053,8 @@ export const LoginsApiFp = function(configuration?: Configuration) {
|
|
|
117097
117053
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
117098
117054
|
},
|
|
117099
117055
|
/**
|
|
117100
|
-
*
|
|
117101
|
-
* @summary
|
|
117056
|
+
* Removes two-factor authentication from the email login with the given username and returns its updated MFA settings. It turns TOTP off and deletes it, so nothing is left to turn back on. The user can then sign in with their password and set up two-factor authentication again. Removing when none is set up succeeds. Requires read and update permissions on accounts.
|
|
117057
|
+
* @summary Remove a login\'s two-factor authentication
|
|
117102
117058
|
* @param {string} username The username identifier
|
|
117103
117059
|
* @param {*} [options] Override http request option.
|
|
117104
117060
|
* @throws {RequiredError}
|
|
@@ -117109,20 +117065,6 @@ export const LoginsApiFp = function(configuration?: Configuration) {
|
|
|
117109
117065
|
const localVarOperationServerBasePath = operationServerMap['LoginsApi.deleteLoginMfaToken']?.[localVarOperationServerIndex]?.url;
|
|
117110
117066
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
117111
117067
|
},
|
|
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
|
-
},
|
|
117126
117068
|
/**
|
|
117127
117069
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
117128
117070
|
* @summary Get a single login
|
|
@@ -117201,7 +117143,7 @@ export const LoginsApiFp = function(configuration?: Configuration) {
|
|
|
117201
117143
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
117202
117144
|
},
|
|
117203
117145
|
/**
|
|
117204
|
-
*
|
|
117146
|
+
* Makes the given MFA method the preferred one for the email login with the given username, and returns its updated MFA settings. The method must already be turned on for the login; any other method returns a 400, so this can\'t revive a method the user turned off. Requires read and update permissions on accounts.
|
|
117205
117147
|
* @summary Set a login\'s preferred MFA method
|
|
117206
117148
|
* @param {string} username The username identifier
|
|
117207
117149
|
* @param {SetLoginPreferredMfaRequest} setLoginPreferredMfaRequest
|
|
@@ -117272,8 +117214,8 @@ export const LoginsApiFactory = function (configuration?: Configuration, basePat
|
|
|
117272
117214
|
return localVarFp.deleteLogin(requestParameters.username, options).then((request) => request(axios, basePath));
|
|
117273
117215
|
},
|
|
117274
117216
|
/**
|
|
117275
|
-
*
|
|
117276
|
-
* @summary
|
|
117217
|
+
* Removes two-factor authentication from the email login with the given username and returns its updated MFA settings. It turns TOTP off and deletes it, so nothing is left to turn back on. The user can then sign in with their password and set up two-factor authentication again. Removing when none is set up succeeds. Requires read and update permissions on accounts.
|
|
117218
|
+
* @summary Remove a login\'s two-factor authentication
|
|
117277
117219
|
* @param {LoginsApiDeleteLoginMfaTokenRequest} requestParameters Request parameters.
|
|
117278
117220
|
* @param {*} [options] Override http request option.
|
|
117279
117221
|
* @throws {RequiredError}
|
|
@@ -117281,16 +117223,6 @@ export const LoginsApiFactory = function (configuration?: Configuration, basePat
|
|
|
117281
117223
|
deleteLoginMfaToken(requestParameters: LoginsApiDeleteLoginMfaTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginMfa200Response> {
|
|
117282
117224
|
return localVarFp.deleteLoginMfaToken(requestParameters.username, options).then((request) => request(axios, basePath));
|
|
117283
117225
|
},
|
|
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
|
-
},
|
|
117294
117226
|
/**
|
|
117295
117227
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
117296
117228
|
* @summary Get a single login
|
|
@@ -117342,7 +117274,7 @@ export const LoginsApiFactory = function (configuration?: Configuration, basePat
|
|
|
117342
117274
|
return localVarFp.getLogins(requestParameters.accountId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
117343
117275
|
},
|
|
117344
117276
|
/**
|
|
117345
|
-
*
|
|
117277
|
+
* Makes the given MFA method the preferred one for the email login with the given username, and returns its updated MFA settings. The method must already be turned on for the login; any other method returns a 400, so this can\'t revive a method the user turned off. Requires read and update permissions on accounts.
|
|
117346
117278
|
* @summary Set a login\'s preferred MFA method
|
|
117347
117279
|
* @param {LoginsApiSetLoginPreferredMfaRequest} requestParameters Request parameters.
|
|
117348
117280
|
* @param {*} [options] Override http request option.
|
|
@@ -117404,21 +117336,6 @@ export interface LoginsApiDeleteLoginMfaTokenRequest {
|
|
|
117404
117336
|
readonly username: string
|
|
117405
117337
|
}
|
|
117406
117338
|
|
|
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
|
-
|
|
117422
117339
|
/**
|
|
117423
117340
|
* Request parameters for getLogin operation in LoginsApi.
|
|
117424
117341
|
*/
|
|
@@ -117592,8 +117509,8 @@ export class LoginsApi extends BaseAPI {
|
|
|
117592
117509
|
}
|
|
117593
117510
|
|
|
117594
117511
|
/**
|
|
117595
|
-
*
|
|
117596
|
-
* @summary
|
|
117512
|
+
* Removes two-factor authentication from the email login with the given username and returns its updated MFA settings. It turns TOTP off and deletes it, so nothing is left to turn back on. The user can then sign in with their password and set up two-factor authentication again. Removing when none is set up succeeds. Requires read and update permissions on accounts.
|
|
117513
|
+
* @summary Remove a login\'s two-factor authentication
|
|
117597
117514
|
* @param {LoginsApiDeleteLoginMfaTokenRequest} requestParameters Request parameters.
|
|
117598
117515
|
* @param {*} [options] Override http request option.
|
|
117599
117516
|
* @throws {RequiredError}
|
|
@@ -117602,17 +117519,6 @@ export class LoginsApi extends BaseAPI {
|
|
|
117602
117519
|
return LoginsApiFp(this.configuration).deleteLoginMfaToken(requestParameters.username, options).then((request) => request(this.axios, this.basePath));
|
|
117603
117520
|
}
|
|
117604
117521
|
|
|
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
|
-
|
|
117616
117522
|
/**
|
|
117617
117523
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
117618
117524
|
* @summary Get a single login
|
|
@@ -117669,7 +117575,7 @@ export class LoginsApi extends BaseAPI {
|
|
|
117669
117575
|
}
|
|
117670
117576
|
|
|
117671
117577
|
/**
|
|
117672
|
-
*
|
|
117578
|
+
* Makes the given MFA method the preferred one for the email login with the given username, and returns its updated MFA settings. The method must already be turned on for the login; any other method returns a 400, so this can\'t revive a method the user turned off. Requires read and update permissions on accounts.
|
|
117673
117579
|
* @summary Set a login\'s preferred MFA method
|
|
117674
117580
|
* @param {LoginsApiSetLoginPreferredMfaRequest} requestParameters Request parameters.
|
|
117675
117581
|
* @param {*} [options] Override http request option.
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 11.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/common.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 11.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/configuration.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Connected Admin API
|
|
4
4
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 11.23.
|
|
6
|
+
* The version of the OpenAPI document: 11.23.1
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/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.
|