@connectedxm/admin-sdk 11.22.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 +4 -0
- package/README.md +2 -2
- package/api.ts +385 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +195 -1
- package/dist/api.js +324 -23
- 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 +195 -1
- package/dist/esm/api.js +302 -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/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/.openapi-generator/FILES
CHANGED
|
@@ -996,6 +996,7 @@ docs/GetLivestreams200Response.md
|
|
|
996
996
|
docs/GetLogin200Response.md
|
|
997
997
|
docs/GetLoginAuthSessions200Response.md
|
|
998
998
|
docs/GetLoginDevices200Response.md
|
|
999
|
+
docs/GetLoginMfa200Response.md
|
|
999
1000
|
docs/GetLogins200Response.md
|
|
1000
1001
|
docs/GetMeetingLinks200Response.md
|
|
1001
1002
|
docs/GetMeetingParticipant200Response.md
|
|
@@ -1181,6 +1182,8 @@ docs/LivestreamSession.md
|
|
|
1181
1182
|
docs/LocationQuestionOption.md
|
|
1182
1183
|
docs/Login.md
|
|
1183
1184
|
docs/LoginAllOfCount.md
|
|
1185
|
+
docs/LoginMfa.md
|
|
1186
|
+
docs/LoginMfaMethod.md
|
|
1184
1187
|
docs/LoginsAccountsApi.md
|
|
1185
1188
|
docs/LoginsApi.md
|
|
1186
1189
|
docs/MarkNotificationsReadInputs.md
|
|
@@ -1446,6 +1449,7 @@ docs/SeriesTranslation.md
|
|
|
1446
1449
|
docs/SeriesTranslationUpdateInputs.md
|
|
1447
1450
|
docs/SeriesTranslationsApi.md
|
|
1448
1451
|
docs/SeriesUpdateInputs.md
|
|
1452
|
+
docs/SetLoginPreferredMfaRequest.md
|
|
1449
1453
|
docs/SideEffect.md
|
|
1450
1454
|
docs/SideEffectActionType.md
|
|
1451
1455
|
docs/SideEffectTriggerType.md
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @connectedxm/admin-sdk@11.
|
|
1
|
+
## @connectedxm/admin-sdk@11.23.0
|
|
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.
|
|
39
|
+
npm install @connectedxm/admin-sdk@11.23.0 --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.
|
|
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).
|
|
@@ -9656,6 +9656,16 @@ export enum GetLoginDevices200ResponseStatusEnum {
|
|
|
9656
9656
|
Ok = 'ok'
|
|
9657
9657
|
}
|
|
9658
9658
|
|
|
9659
|
+
export interface GetLoginMfa200Response {
|
|
9660
|
+
'status': GetLoginMfa200ResponseStatusEnum;
|
|
9661
|
+
'message': string;
|
|
9662
|
+
'data': LoginMfa;
|
|
9663
|
+
}
|
|
9664
|
+
|
|
9665
|
+
export enum GetLoginMfa200ResponseStatusEnum {
|
|
9666
|
+
Ok = 'ok'
|
|
9667
|
+
}
|
|
9668
|
+
|
|
9659
9669
|
export interface GetLogins200Response {
|
|
9660
9670
|
'status': GetLogins200ResponseStatusEnum;
|
|
9661
9671
|
'message': string;
|
|
@@ -11436,6 +11446,21 @@ export interface LoginAllOfCount {
|
|
|
11436
11446
|
'accounts': number;
|
|
11437
11447
|
'devices': number;
|
|
11438
11448
|
}
|
|
11449
|
+
export interface LoginMfa {
|
|
11450
|
+
'supported': boolean;
|
|
11451
|
+
'methods': Array<LoginMfaMethod>;
|
|
11452
|
+
'preferred': LoginMfaMethod | null;
|
|
11453
|
+
}
|
|
11454
|
+
|
|
11455
|
+
|
|
11456
|
+
|
|
11457
|
+
export enum LoginMfaMethod {
|
|
11458
|
+
Totp = 'totp',
|
|
11459
|
+
Sms = 'sms',
|
|
11460
|
+
Email = 'email'
|
|
11461
|
+
}
|
|
11462
|
+
|
|
11463
|
+
|
|
11439
11464
|
export interface MarkNotificationsReadInputs {
|
|
11440
11465
|
'notificationIds': Array<string>;
|
|
11441
11466
|
}
|
|
@@ -14070,6 +14095,11 @@ export interface SeriesUpdateInputs {
|
|
|
14070
14095
|
}
|
|
14071
14096
|
|
|
14072
14097
|
|
|
14098
|
+
export interface SetLoginPreferredMfaRequest {
|
|
14099
|
+
'method': LoginMfaMethod;
|
|
14100
|
+
}
|
|
14101
|
+
|
|
14102
|
+
|
|
14073
14103
|
export interface SideEffect {
|
|
14074
14104
|
'id': string;
|
|
14075
14105
|
'newPassOfPassTypeId': string | null;
|
|
@@ -116551,6 +116581,90 @@ export const LoginsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
116551
116581
|
options: localVarRequestOptions,
|
|
116552
116582
|
};
|
|
116553
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
|
+
},
|
|
116554
116668
|
/**
|
|
116555
116669
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
116556
116670
|
* @summary Get a single login
|
|
@@ -116711,6 +116825,46 @@ export const LoginsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
116711
116825
|
options: localVarRequestOptions,
|
|
116712
116826
|
};
|
|
116713
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
|
+
},
|
|
116714
116868
|
/**
|
|
116715
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.
|
|
116716
116870
|
* @summary List logins
|
|
@@ -116772,6 +116926,51 @@ export const LoginsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
116772
116926
|
options: localVarRequestOptions,
|
|
116773
116927
|
};
|
|
116774
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
|
+
},
|
|
116775
116974
|
/**
|
|
116776
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.
|
|
116777
116976
|
* @summary Update a login\'s email
|
|
@@ -116897,6 +117096,33 @@ export const LoginsApiFp = function(configuration?: Configuration) {
|
|
|
116897
117096
|
const localVarOperationServerBasePath = operationServerMap['LoginsApi.deleteLogin']?.[localVarOperationServerIndex]?.url;
|
|
116898
117097
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
116899
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
|
+
},
|
|
116900
117126
|
/**
|
|
116901
117127
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
116902
117128
|
* @summary Get a single login
|
|
@@ -116944,6 +117170,19 @@ export const LoginsApiFp = function(configuration?: Configuration) {
|
|
|
116944
117170
|
const localVarOperationServerBasePath = operationServerMap['LoginsApi.getLoginDevices']?.[localVarOperationServerIndex]?.url;
|
|
116945
117171
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
116946
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
|
+
},
|
|
116947
117186
|
/**
|
|
116948
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.
|
|
116949
117188
|
* @summary List logins
|
|
@@ -116961,6 +117200,20 @@ export const LoginsApiFp = function(configuration?: Configuration) {
|
|
|
116961
117200
|
const localVarOperationServerBasePath = operationServerMap['LoginsApi.getLogins']?.[localVarOperationServerIndex]?.url;
|
|
116962
117201
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
116963
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
|
+
},
|
|
116964
117217
|
/**
|
|
116965
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.
|
|
116966
117219
|
* @summary Update a login\'s email
|
|
@@ -117018,6 +117271,26 @@ export const LoginsApiFactory = function (configuration?: Configuration, basePat
|
|
|
117018
117271
|
deleteLogin(requestParameters: LoginsApiDeleteLoginRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLogin200Response> {
|
|
117019
117272
|
return localVarFp.deleteLogin(requestParameters.username, options).then((request) => request(axios, basePath));
|
|
117020
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
|
+
},
|
|
117021
117294
|
/**
|
|
117022
117295
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
117023
117296
|
* @summary Get a single login
|
|
@@ -117048,6 +117321,16 @@ export const LoginsApiFactory = function (configuration?: Configuration, basePat
|
|
|
117048
117321
|
getLoginDevices(requestParameters: LoginsApiGetLoginDevicesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginDevices200Response> {
|
|
117049
117322
|
return localVarFp.getLoginDevices(requestParameters.username, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
117050
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
|
+
},
|
|
117051
117334
|
/**
|
|
117052
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.
|
|
117053
117336
|
* @summary List logins
|
|
@@ -117058,6 +117341,16 @@ export const LoginsApiFactory = function (configuration?: Configuration, basePat
|
|
|
117058
117341
|
getLogins(requestParameters: LoginsApiGetLoginsRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<GetLogins200Response> {
|
|
117059
117342
|
return localVarFp.getLogins(requestParameters.accountId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
117060
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
|
+
},
|
|
117061
117354
|
/**
|
|
117062
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.
|
|
117063
117356
|
* @summary Update a login\'s email
|
|
@@ -117101,6 +117394,31 @@ export interface LoginsApiDeleteLoginRequest {
|
|
|
117101
117394
|
readonly username: string
|
|
117102
117395
|
}
|
|
117103
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
|
+
|
|
117104
117422
|
/**
|
|
117105
117423
|
* Request parameters for getLogin operation in LoginsApi.
|
|
117106
117424
|
*/
|
|
@@ -117171,6 +117489,16 @@ export interface LoginsApiGetLoginDevicesRequest {
|
|
|
117171
117489
|
readonly search?: string
|
|
117172
117490
|
}
|
|
117173
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
|
+
|
|
117174
117502
|
/**
|
|
117175
117503
|
* Request parameters for getLogins operation in LoginsApi.
|
|
117176
117504
|
*/
|
|
@@ -117201,6 +117529,18 @@ export interface LoginsApiGetLoginsRequest {
|
|
|
117201
117529
|
readonly search?: string
|
|
117202
117530
|
}
|
|
117203
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
|
+
|
|
117204
117544
|
/**
|
|
117205
117545
|
* Request parameters for updateLoginEmail operation in LoginsApi.
|
|
117206
117546
|
*/
|
|
@@ -117251,6 +117591,28 @@ export class LoginsApi extends BaseAPI {
|
|
|
117251
117591
|
return LoginsApiFp(this.configuration).deleteLogin(requestParameters.username, options).then((request) => request(this.axios, this.basePath));
|
|
117252
117592
|
}
|
|
117253
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
|
+
|
|
117254
117616
|
/**
|
|
117255
117617
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
117256
117618
|
* @summary Get a single login
|
|
@@ -117284,6 +117646,17 @@ export class LoginsApi extends BaseAPI {
|
|
|
117284
117646
|
return LoginsApiFp(this.configuration).getLoginDevices(requestParameters.username, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
117285
117647
|
}
|
|
117286
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
|
+
|
|
117287
117660
|
/**
|
|
117288
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.
|
|
117289
117662
|
* @summary List logins
|
|
@@ -117295,6 +117668,17 @@ export class LoginsApi extends BaseAPI {
|
|
|
117295
117668
|
return LoginsApiFp(this.configuration).getLogins(requestParameters.accountId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
117296
117669
|
}
|
|
117297
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
|
+
|
|
117298
117682
|
/**
|
|
117299
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.
|
|
117300
117684
|
* @summary Update a login\'s email
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 11.
|
|
7
|
+
* The version of the OpenAPI document: 11.23.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/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.
|
|
7
|
+
* The version of the OpenAPI document: 11.23.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/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.
|
|
6
|
+
* The version of the OpenAPI document: 11.23.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|