@emilgroup/tenant-sdk 1.42.1-beta.124 → 1.42.1-beta.125
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/user-controller-rest-api.ts +20 -16
- package/api/users-api.ts +20 -16
- package/dist/api/user-controller-rest-api.d.ts +20 -16
- package/dist/api/user-controller-rest-api.js +18 -14
- package/dist/api/users-api.d.ts +20 -16
- package/dist/api/users-api.js +18 -14
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/tenant-sdk@1.42.1-beta.
|
|
20
|
+
npm install @emilgroup/tenant-sdk@1.42.1-beta.125 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/tenant-sdk@1.42.1-beta.
|
|
24
|
+
yarn add @emilgroup/tenant-sdk@1.42.1-beta.125
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `UsersApi`.
|
|
@@ -307,10 +307,11 @@ export const UserControllerRestApiAxiosParamCreator = function (configuration?:
|
|
|
307
307
|
};
|
|
308
308
|
},
|
|
309
309
|
/**
|
|
310
|
-
*
|
|
310
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
311
|
+
* @summary Retrieve the user
|
|
311
312
|
* @param {string} code
|
|
312
313
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
313
|
-
* @param {string} [expand]
|
|
314
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
314
315
|
* @param {*} [options] Override http request option.
|
|
315
316
|
* @throws {RequiredError}
|
|
316
317
|
*/
|
|
@@ -586,7 +587,7 @@ export const UserControllerRestApiAxiosParamCreator = function (configuration?:
|
|
|
586
587
|
};
|
|
587
588
|
},
|
|
588
589
|
/**
|
|
589
|
-
* Returns a list of users
|
|
590
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
590
591
|
* @summary List users
|
|
591
592
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
592
593
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -594,7 +595,7 @@ export const UserControllerRestApiAxiosParamCreator = function (configuration?:
|
|
|
594
595
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
595
596
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
596
597
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, firstName, lastName</i>
|
|
597
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups<i>
|
|
598
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
598
599
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
599
600
|
* @param {*} [options] Override http request option.
|
|
600
601
|
* @throws {RequiredError}
|
|
@@ -732,10 +733,11 @@ export const UserControllerRestApiFp = function(configuration?: Configuration) {
|
|
|
732
733
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
733
734
|
},
|
|
734
735
|
/**
|
|
735
|
-
*
|
|
736
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
737
|
+
* @summary Retrieve the user
|
|
736
738
|
* @param {string} code
|
|
737
739
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
738
|
-
* @param {string} [expand]
|
|
740
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
739
741
|
* @param {*} [options] Override http request option.
|
|
740
742
|
* @throws {RequiredError}
|
|
741
743
|
*/
|
|
@@ -798,7 +800,7 @@ export const UserControllerRestApiFp = function(configuration?: Configuration) {
|
|
|
798
800
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
799
801
|
},
|
|
800
802
|
/**
|
|
801
|
-
* Returns a list of users
|
|
803
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
802
804
|
* @summary List users
|
|
803
805
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
804
806
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -806,7 +808,7 @@ export const UserControllerRestApiFp = function(configuration?: Configuration) {
|
|
|
806
808
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
807
809
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
808
810
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, firstName, lastName</i>
|
|
809
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups<i>
|
|
811
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
810
812
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
811
813
|
* @param {*} [options] Override http request option.
|
|
812
814
|
* @throws {RequiredError}
|
|
@@ -879,10 +881,11 @@ export const UserControllerRestApiFactory = function (configuration?: Configurat
|
|
|
879
881
|
return localVarFp.enableUsers(enableUsersRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
880
882
|
},
|
|
881
883
|
/**
|
|
882
|
-
*
|
|
884
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
885
|
+
* @summary Retrieve the user
|
|
883
886
|
* @param {string} code
|
|
884
887
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
885
|
-
* @param {string} [expand]
|
|
888
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
886
889
|
* @param {*} [options] Override http request option.
|
|
887
890
|
* @throws {RequiredError}
|
|
888
891
|
*/
|
|
@@ -940,7 +943,7 @@ export const UserControllerRestApiFactory = function (configuration?: Configurat
|
|
|
940
943
|
return localVarFp.listInvites(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
941
944
|
},
|
|
942
945
|
/**
|
|
943
|
-
* Returns a list of users
|
|
946
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
944
947
|
* @summary List users
|
|
945
948
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
946
949
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -948,7 +951,7 @@ export const UserControllerRestApiFactory = function (configuration?: Configurat
|
|
|
948
951
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
949
952
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
950
953
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, firstName, lastName</i>
|
|
951
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups<i>
|
|
954
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
952
955
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
953
956
|
* @param {*} [options] Override http request option.
|
|
954
957
|
* @throws {RequiredError}
|
|
@@ -1092,7 +1095,7 @@ export interface UserControllerRestApiGetUserRequest {
|
|
|
1092
1095
|
readonly authorization?: string
|
|
1093
1096
|
|
|
1094
1097
|
/**
|
|
1095
|
-
*
|
|
1098
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
1096
1099
|
* @type {string}
|
|
1097
1100
|
* @memberof UserControllerRestApiGetUser
|
|
1098
1101
|
*/
|
|
@@ -1281,7 +1284,7 @@ export interface UserControllerRestApiListUsersRequest {
|
|
|
1281
1284
|
readonly order?: string
|
|
1282
1285
|
|
|
1283
1286
|
/**
|
|
1284
|
-
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups<i>
|
|
1287
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
1285
1288
|
* @type {string}
|
|
1286
1289
|
* @memberof UserControllerRestApiListUsers
|
|
1287
1290
|
*/
|
|
@@ -1360,7 +1363,8 @@ export class UserControllerRestApi extends BaseAPI {
|
|
|
1360
1363
|
}
|
|
1361
1364
|
|
|
1362
1365
|
/**
|
|
1363
|
-
*
|
|
1366
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
1367
|
+
* @summary Retrieve the user
|
|
1364
1368
|
* @param {UserControllerRestApiGetUserRequest} requestParameters Request parameters.
|
|
1365
1369
|
* @param {*} [options] Override http request option.
|
|
1366
1370
|
* @throws {RequiredError}
|
|
@@ -1418,7 +1422,7 @@ export class UserControllerRestApi extends BaseAPI {
|
|
|
1418
1422
|
}
|
|
1419
1423
|
|
|
1420
1424
|
/**
|
|
1421
|
-
* Returns a list of users
|
|
1425
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
1422
1426
|
* @summary List users
|
|
1423
1427
|
* @param {UserControllerRestApiListUsersRequest} requestParameters Request parameters.
|
|
1424
1428
|
* @param {*} [options] Override http request option.
|
package/api/users-api.ts
CHANGED
|
@@ -248,10 +248,11 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
248
248
|
};
|
|
249
249
|
},
|
|
250
250
|
/**
|
|
251
|
-
*
|
|
251
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
252
|
+
* @summary Retrieve the user
|
|
252
253
|
* @param {string} code
|
|
253
254
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
254
|
-
* @param {string} [expand]
|
|
255
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
255
256
|
* @param {*} [options] Override http request option.
|
|
256
257
|
* @throws {RequiredError}
|
|
257
258
|
*/
|
|
@@ -351,7 +352,7 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
351
352
|
};
|
|
352
353
|
},
|
|
353
354
|
/**
|
|
354
|
-
* Returns a list of users
|
|
355
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
355
356
|
* @summary List users
|
|
356
357
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
357
358
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -359,7 +360,7 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
359
360
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
360
361
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
361
362
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, firstName, lastName</i>
|
|
362
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups<i>
|
|
363
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
363
364
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
364
365
|
* @param {*} [options] Override http request option.
|
|
365
366
|
* @throws {RequiredError}
|
|
@@ -485,10 +486,11 @@ export const UsersApiFp = function(configuration?: Configuration) {
|
|
|
485
486
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
486
487
|
},
|
|
487
488
|
/**
|
|
488
|
-
*
|
|
489
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
490
|
+
* @summary Retrieve the user
|
|
489
491
|
* @param {string} code
|
|
490
492
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
491
|
-
* @param {string} [expand]
|
|
493
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
492
494
|
* @param {*} [options] Override http request option.
|
|
493
495
|
* @throws {RequiredError}
|
|
494
496
|
*/
|
|
@@ -509,7 +511,7 @@ export const UsersApiFp = function(configuration?: Configuration) {
|
|
|
509
511
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
510
512
|
},
|
|
511
513
|
/**
|
|
512
|
-
* Returns a list of users
|
|
514
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
513
515
|
* @summary List users
|
|
514
516
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
515
517
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -517,7 +519,7 @@ export const UsersApiFp = function(configuration?: Configuration) {
|
|
|
517
519
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
518
520
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
519
521
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, firstName, lastName</i>
|
|
520
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups<i>
|
|
522
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
521
523
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
522
524
|
* @param {*} [options] Override http request option.
|
|
523
525
|
* @throws {RequiredError}
|
|
@@ -579,10 +581,11 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath
|
|
|
579
581
|
return localVarFp.enableUsers(enableUsersRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
580
582
|
},
|
|
581
583
|
/**
|
|
582
|
-
*
|
|
584
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
585
|
+
* @summary Retrieve the user
|
|
583
586
|
* @param {string} code
|
|
584
587
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
585
|
-
* @param {string} [expand]
|
|
588
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
586
589
|
* @param {*} [options] Override http request option.
|
|
587
590
|
* @throws {RequiredError}
|
|
588
591
|
*/
|
|
@@ -601,7 +604,7 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath
|
|
|
601
604
|
return localVarFp.linkUserWithPartner(code, linkUserWithPartnerRequestDtoRest, authorization, options).then((request) => request(axios, basePath));
|
|
602
605
|
},
|
|
603
606
|
/**
|
|
604
|
-
* Returns a list of users
|
|
607
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
605
608
|
* @summary List users
|
|
606
609
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
607
610
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -609,7 +612,7 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath
|
|
|
609
612
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
610
613
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
611
614
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, firstName, lastName</i>
|
|
612
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups<i>
|
|
615
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
613
616
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
614
617
|
* @param {*} [options] Override http request option.
|
|
615
618
|
* @throws {RequiredError}
|
|
@@ -732,7 +735,7 @@ export interface UsersApiGetUserRequest {
|
|
|
732
735
|
readonly authorization?: string
|
|
733
736
|
|
|
734
737
|
/**
|
|
735
|
-
*
|
|
738
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
736
739
|
* @type {string}
|
|
737
740
|
* @memberof UsersApiGetUser
|
|
738
741
|
*/
|
|
@@ -816,7 +819,7 @@ export interface UsersApiListUsersRequest {
|
|
|
816
819
|
readonly order?: string
|
|
817
820
|
|
|
818
821
|
/**
|
|
819
|
-
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups<i>
|
|
822
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
820
823
|
* @type {string}
|
|
821
824
|
* @memberof UsersApiListUsers
|
|
822
825
|
*/
|
|
@@ -883,7 +886,8 @@ export class UsersApi extends BaseAPI {
|
|
|
883
886
|
}
|
|
884
887
|
|
|
885
888
|
/**
|
|
886
|
-
*
|
|
889
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
890
|
+
* @summary Retrieve the user
|
|
887
891
|
* @param {UsersApiGetUserRequest} requestParameters Request parameters.
|
|
888
892
|
* @param {*} [options] Override http request option.
|
|
889
893
|
* @throws {RequiredError}
|
|
@@ -905,7 +909,7 @@ export class UsersApi extends BaseAPI {
|
|
|
905
909
|
}
|
|
906
910
|
|
|
907
911
|
/**
|
|
908
|
-
* Returns a list of users
|
|
912
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
909
913
|
* @summary List users
|
|
910
914
|
* @param {UsersApiListUsersRequest} requestParameters Request parameters.
|
|
911
915
|
* @param {*} [options] Override http request option.
|
|
@@ -78,10 +78,11 @@ export declare const UserControllerRestApiAxiosParamCreator: (configuration?: Co
|
|
|
78
78
|
*/
|
|
79
79
|
enableUsers: (enableUsersRequestDto: EnableUsersRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
80
80
|
/**
|
|
81
|
-
*
|
|
81
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
82
|
+
* @summary Retrieve the user
|
|
82
83
|
* @param {string} code
|
|
83
84
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
84
|
-
* @param {string} [expand]
|
|
85
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
85
86
|
* @param {*} [options] Override http request option.
|
|
86
87
|
* @throws {RequiredError}
|
|
87
88
|
*/
|
|
@@ -129,7 +130,7 @@ export declare const UserControllerRestApiAxiosParamCreator: (configuration?: Co
|
|
|
129
130
|
*/
|
|
130
131
|
listInvites: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
131
132
|
/**
|
|
132
|
-
* Returns a list of users
|
|
133
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
133
134
|
* @summary List users
|
|
134
135
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
135
136
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -137,7 +138,7 @@ export declare const UserControllerRestApiAxiosParamCreator: (configuration?: Co
|
|
|
137
138
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
138
139
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
139
140
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, firstName, lastName</i>
|
|
140
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups<i>
|
|
141
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
141
142
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
142
143
|
* @param {*} [options] Override http request option.
|
|
143
144
|
* @throws {RequiredError}
|
|
@@ -193,10 +194,11 @@ export declare const UserControllerRestApiFp: (configuration?: Configuration) =>
|
|
|
193
194
|
*/
|
|
194
195
|
enableUsers(enableUsersRequestDto: EnableUsersRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EnableUsersResponseClass>>;
|
|
195
196
|
/**
|
|
196
|
-
*
|
|
197
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
198
|
+
* @summary Retrieve the user
|
|
197
199
|
* @param {string} code
|
|
198
200
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
199
|
-
* @param {string} [expand]
|
|
201
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
200
202
|
* @param {*} [options] Override http request option.
|
|
201
203
|
* @throws {RequiredError}
|
|
202
204
|
*/
|
|
@@ -244,7 +246,7 @@ export declare const UserControllerRestApiFp: (configuration?: Configuration) =>
|
|
|
244
246
|
*/
|
|
245
247
|
listInvites(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInvitesResponseClass>>;
|
|
246
248
|
/**
|
|
247
|
-
* Returns a list of users
|
|
249
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
248
250
|
* @summary List users
|
|
249
251
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
250
252
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -252,7 +254,7 @@ export declare const UserControllerRestApiFp: (configuration?: Configuration) =>
|
|
|
252
254
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
253
255
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
254
256
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, firstName, lastName</i>
|
|
255
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups<i>
|
|
257
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
256
258
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
257
259
|
* @param {*} [options] Override http request option.
|
|
258
260
|
* @throws {RequiredError}
|
|
@@ -308,10 +310,11 @@ export declare const UserControllerRestApiFactory: (configuration?: Configuratio
|
|
|
308
310
|
*/
|
|
309
311
|
enableUsers(enableUsersRequestDto: EnableUsersRequestDto, authorization?: string, options?: any): AxiosPromise<EnableUsersResponseClass>;
|
|
310
312
|
/**
|
|
311
|
-
*
|
|
313
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
314
|
+
* @summary Retrieve the user
|
|
312
315
|
* @param {string} code
|
|
313
316
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
314
|
-
* @param {string} [expand]
|
|
317
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
315
318
|
* @param {*} [options] Override http request option.
|
|
316
319
|
* @throws {RequiredError}
|
|
317
320
|
*/
|
|
@@ -359,7 +362,7 @@ export declare const UserControllerRestApiFactory: (configuration?: Configuratio
|
|
|
359
362
|
*/
|
|
360
363
|
listInvites(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListInvitesResponseClass>;
|
|
361
364
|
/**
|
|
362
|
-
* Returns a list of users
|
|
365
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
363
366
|
* @summary List users
|
|
364
367
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
365
368
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -367,7 +370,7 @@ export declare const UserControllerRestApiFactory: (configuration?: Configuratio
|
|
|
367
370
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
368
371
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
369
372
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, firstName, lastName</i>
|
|
370
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups<i>
|
|
373
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
371
374
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
372
375
|
* @param {*} [options] Override http request option.
|
|
373
376
|
* @throws {RequiredError}
|
|
@@ -494,7 +497,7 @@ export interface UserControllerRestApiGetUserRequest {
|
|
|
494
497
|
*/
|
|
495
498
|
readonly authorization?: string;
|
|
496
499
|
/**
|
|
497
|
-
*
|
|
500
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
498
501
|
* @type {string}
|
|
499
502
|
* @memberof UserControllerRestApiGetUser
|
|
500
503
|
*/
|
|
@@ -661,7 +664,7 @@ export interface UserControllerRestApiListUsersRequest {
|
|
|
661
664
|
*/
|
|
662
665
|
readonly order?: string;
|
|
663
666
|
/**
|
|
664
|
-
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups<i>
|
|
667
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
665
668
|
* @type {string}
|
|
666
669
|
* @memberof UserControllerRestApiListUsers
|
|
667
670
|
*/
|
|
@@ -723,7 +726,8 @@ export declare class UserControllerRestApi extends BaseAPI {
|
|
|
723
726
|
*/
|
|
724
727
|
enableUsers(requestParameters: UserControllerRestApiEnableUsersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EnableUsersResponseClass, any, {}>>;
|
|
725
728
|
/**
|
|
726
|
-
*
|
|
729
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
730
|
+
* @summary Retrieve the user
|
|
727
731
|
* @param {UserControllerRestApiGetUserRequest} requestParameters Request parameters.
|
|
728
732
|
* @param {*} [options] Override http request option.
|
|
729
733
|
* @throws {RequiredError}
|
|
@@ -766,7 +770,7 @@ export declare class UserControllerRestApi extends BaseAPI {
|
|
|
766
770
|
*/
|
|
767
771
|
listInvites(requestParameters?: UserControllerRestApiListInvitesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListInvitesResponseClass, any, {}>>;
|
|
768
772
|
/**
|
|
769
|
-
* Returns a list of users
|
|
773
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
770
774
|
* @summary List users
|
|
771
775
|
* @param {UserControllerRestApiListUsersRequest} requestParameters Request parameters.
|
|
772
776
|
* @param {*} [options] Override http request option.
|
|
@@ -354,10 +354,11 @@ var UserControllerRestApiAxiosParamCreator = function (configuration) {
|
|
|
354
354
|
});
|
|
355
355
|
},
|
|
356
356
|
/**
|
|
357
|
-
*
|
|
357
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
358
|
+
* @summary Retrieve the user
|
|
358
359
|
* @param {string} code
|
|
359
360
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
360
|
-
* @param {string} [expand]
|
|
361
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
361
362
|
* @param {*} [options] Override http request option.
|
|
362
363
|
* @throws {RequiredError}
|
|
363
364
|
*/
|
|
@@ -638,7 +639,7 @@ var UserControllerRestApiAxiosParamCreator = function (configuration) {
|
|
|
638
639
|
});
|
|
639
640
|
},
|
|
640
641
|
/**
|
|
641
|
-
* Returns a list of users
|
|
642
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
642
643
|
* @summary List users
|
|
643
644
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
644
645
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -646,7 +647,7 @@ var UserControllerRestApiAxiosParamCreator = function (configuration) {
|
|
|
646
647
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
647
648
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
648
649
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, firstName, lastName</i>
|
|
649
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups<i>
|
|
650
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
650
651
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
651
652
|
* @param {*} [options] Override http request option.
|
|
652
653
|
* @throws {RequiredError}
|
|
@@ -824,10 +825,11 @@ var UserControllerRestApiFp = function (configuration) {
|
|
|
824
825
|
});
|
|
825
826
|
},
|
|
826
827
|
/**
|
|
827
|
-
*
|
|
828
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
829
|
+
* @summary Retrieve the user
|
|
828
830
|
* @param {string} code
|
|
829
831
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
830
|
-
* @param {string} [expand]
|
|
832
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
831
833
|
* @param {*} [options] Override http request option.
|
|
832
834
|
* @throws {RequiredError}
|
|
833
835
|
*/
|
|
@@ -935,7 +937,7 @@ var UserControllerRestApiFp = function (configuration) {
|
|
|
935
937
|
});
|
|
936
938
|
},
|
|
937
939
|
/**
|
|
938
|
-
* Returns a list of users
|
|
940
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
939
941
|
* @summary List users
|
|
940
942
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
941
943
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -943,7 +945,7 @@ var UserControllerRestApiFp = function (configuration) {
|
|
|
943
945
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
944
946
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
945
947
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, firstName, lastName</i>
|
|
946
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups<i>
|
|
948
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
947
949
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
948
950
|
* @param {*} [options] Override http request option.
|
|
949
951
|
* @throws {RequiredError}
|
|
@@ -1025,10 +1027,11 @@ var UserControllerRestApiFactory = function (configuration, basePath, axios) {
|
|
|
1025
1027
|
return localVarFp.enableUsers(enableUsersRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
1026
1028
|
},
|
|
1027
1029
|
/**
|
|
1028
|
-
*
|
|
1030
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
1031
|
+
* @summary Retrieve the user
|
|
1029
1032
|
* @param {string} code
|
|
1030
1033
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1031
|
-
* @param {string} [expand]
|
|
1034
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
1032
1035
|
* @param {*} [options] Override http request option.
|
|
1033
1036
|
* @throws {RequiredError}
|
|
1034
1037
|
*/
|
|
@@ -1086,7 +1089,7 @@ var UserControllerRestApiFactory = function (configuration, basePath, axios) {
|
|
|
1086
1089
|
return localVarFp.listInvites(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
1087
1090
|
},
|
|
1088
1091
|
/**
|
|
1089
|
-
* Returns a list of users
|
|
1092
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
1090
1093
|
* @summary List users
|
|
1091
1094
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1092
1095
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -1094,7 +1097,7 @@ var UserControllerRestApiFactory = function (configuration, basePath, axios) {
|
|
|
1094
1097
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
1095
1098
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
1096
1099
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, firstName, lastName</i>
|
|
1097
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups<i>
|
|
1100
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
1098
1101
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
1099
1102
|
* @param {*} [options] Override http request option.
|
|
1100
1103
|
* @throws {RequiredError}
|
|
@@ -1174,7 +1177,8 @@ var UserControllerRestApi = /** @class */ (function (_super) {
|
|
|
1174
1177
|
return (0, exports.UserControllerRestApiFp)(this.configuration).enableUsers(requestParameters.enableUsersRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1175
1178
|
};
|
|
1176
1179
|
/**
|
|
1177
|
-
*
|
|
1180
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
1181
|
+
* @summary Retrieve the user
|
|
1178
1182
|
* @param {UserControllerRestApiGetUserRequest} requestParameters Request parameters.
|
|
1179
1183
|
* @param {*} [options] Override http request option.
|
|
1180
1184
|
* @throws {RequiredError}
|
|
@@ -1233,7 +1237,7 @@ var UserControllerRestApi = /** @class */ (function (_super) {
|
|
|
1233
1237
|
return (0, exports.UserControllerRestApiFp)(this.configuration).listInvites(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1234
1238
|
};
|
|
1235
1239
|
/**
|
|
1236
|
-
* Returns a list of users
|
|
1240
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
1237
1241
|
* @summary List users
|
|
1238
1242
|
* @param {UserControllerRestApiListUsersRequest} requestParameters Request parameters.
|
|
1239
1243
|
* @param {*} [options] Override http request option.
|
package/dist/api/users-api.d.ts
CHANGED
|
@@ -64,10 +64,11 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
64
64
|
*/
|
|
65
65
|
enableUsers: (enableUsersRequestDto: EnableUsersRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
66
66
|
/**
|
|
67
|
-
*
|
|
67
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
68
|
+
* @summary Retrieve the user
|
|
68
69
|
* @param {string} code
|
|
69
70
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
70
|
-
* @param {string} [expand]
|
|
71
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
71
72
|
* @param {*} [options] Override http request option.
|
|
72
73
|
* @throws {RequiredError}
|
|
73
74
|
*/
|
|
@@ -82,7 +83,7 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
82
83
|
*/
|
|
83
84
|
linkUserWithPartner: (code: string, linkUserWithPartnerRequestDtoRest: LinkUserWithPartnerRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
84
85
|
/**
|
|
85
|
-
* Returns a list of users
|
|
86
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
86
87
|
* @summary List users
|
|
87
88
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
88
89
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -90,7 +91,7 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
90
91
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
91
92
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
92
93
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, firstName, lastName</i>
|
|
93
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups<i>
|
|
94
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
94
95
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
95
96
|
* @param {*} [options] Override http request option.
|
|
96
97
|
* @throws {RequiredError}
|
|
@@ -137,10 +138,11 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
137
138
|
*/
|
|
138
139
|
enableUsers(enableUsersRequestDto: EnableUsersRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EnableUsersResponseClass>>;
|
|
139
140
|
/**
|
|
140
|
-
*
|
|
141
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
142
|
+
* @summary Retrieve the user
|
|
141
143
|
* @param {string} code
|
|
142
144
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
143
|
-
* @param {string} [expand]
|
|
145
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
144
146
|
* @param {*} [options] Override http request option.
|
|
145
147
|
* @throws {RequiredError}
|
|
146
148
|
*/
|
|
@@ -155,7 +157,7 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
155
157
|
*/
|
|
156
158
|
linkUserWithPartner(code: string, linkUserWithPartnerRequestDtoRest: LinkUserWithPartnerRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LinkUserWithPartnerResponseClass>>;
|
|
157
159
|
/**
|
|
158
|
-
* Returns a list of users
|
|
160
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
159
161
|
* @summary List users
|
|
160
162
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
161
163
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -163,7 +165,7 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
163
165
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
164
166
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
165
167
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, firstName, lastName</i>
|
|
166
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups<i>
|
|
168
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
167
169
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
168
170
|
* @param {*} [options] Override http request option.
|
|
169
171
|
* @throws {RequiredError}
|
|
@@ -210,10 +212,11 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
210
212
|
*/
|
|
211
213
|
enableUsers(enableUsersRequestDto: EnableUsersRequestDto, authorization?: string, options?: any): AxiosPromise<EnableUsersResponseClass>;
|
|
212
214
|
/**
|
|
213
|
-
*
|
|
215
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
216
|
+
* @summary Retrieve the user
|
|
214
217
|
* @param {string} code
|
|
215
218
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
216
|
-
* @param {string} [expand]
|
|
219
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
217
220
|
* @param {*} [options] Override http request option.
|
|
218
221
|
* @throws {RequiredError}
|
|
219
222
|
*/
|
|
@@ -228,7 +231,7 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
228
231
|
*/
|
|
229
232
|
linkUserWithPartner(code: string, linkUserWithPartnerRequestDtoRest: LinkUserWithPartnerRequestDtoRest, authorization?: string, options?: any): AxiosPromise<LinkUserWithPartnerResponseClass>;
|
|
230
233
|
/**
|
|
231
|
-
* Returns a list of users
|
|
234
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
232
235
|
* @summary List users
|
|
233
236
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
234
237
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -236,7 +239,7 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
236
239
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
237
240
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
238
241
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, firstName, lastName</i>
|
|
239
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups<i>
|
|
242
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
240
243
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
241
244
|
* @param {*} [options] Override http request option.
|
|
242
245
|
* @throws {RequiredError}
|
|
@@ -344,7 +347,7 @@ export interface UsersApiGetUserRequest {
|
|
|
344
347
|
*/
|
|
345
348
|
readonly authorization?: string;
|
|
346
349
|
/**
|
|
347
|
-
*
|
|
350
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
348
351
|
* @type {string}
|
|
349
352
|
* @memberof UsersApiGetUser
|
|
350
353
|
*/
|
|
@@ -418,7 +421,7 @@ export interface UsersApiListUsersRequest {
|
|
|
418
421
|
*/
|
|
419
422
|
readonly order?: string;
|
|
420
423
|
/**
|
|
421
|
-
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups<i>
|
|
424
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
422
425
|
* @type {string}
|
|
423
426
|
* @memberof UsersApiListUsers
|
|
424
427
|
*/
|
|
@@ -471,7 +474,8 @@ export declare class UsersApi extends BaseAPI {
|
|
|
471
474
|
*/
|
|
472
475
|
enableUsers(requestParameters: UsersApiEnableUsersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EnableUsersResponseClass, any, {}>>;
|
|
473
476
|
/**
|
|
474
|
-
*
|
|
477
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
478
|
+
* @summary Retrieve the user
|
|
475
479
|
* @param {UsersApiGetUserRequest} requestParameters Request parameters.
|
|
476
480
|
* @param {*} [options] Override http request option.
|
|
477
481
|
* @throws {RequiredError}
|
|
@@ -487,7 +491,7 @@ export declare class UsersApi extends BaseAPI {
|
|
|
487
491
|
*/
|
|
488
492
|
linkUserWithPartner(requestParameters: UsersApiLinkUserWithPartnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkUserWithPartnerResponseClass, any, {}>>;
|
|
489
493
|
/**
|
|
490
|
-
* Returns a list of users
|
|
494
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
491
495
|
* @summary List users
|
|
492
496
|
* @param {UsersApiListUsersRequest} requestParameters Request parameters.
|
|
493
497
|
* @param {*} [options] Override http request option.
|
package/dist/api/users-api.js
CHANGED
|
@@ -302,10 +302,11 @@ var UsersApiAxiosParamCreator = function (configuration) {
|
|
|
302
302
|
});
|
|
303
303
|
},
|
|
304
304
|
/**
|
|
305
|
-
*
|
|
305
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
306
|
+
* @summary Retrieve the user
|
|
306
307
|
* @param {string} code
|
|
307
308
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
308
|
-
* @param {string} [expand]
|
|
309
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
309
310
|
* @param {*} [options] Override http request option.
|
|
310
311
|
* @throws {RequiredError}
|
|
311
312
|
*/
|
|
@@ -409,7 +410,7 @@ var UsersApiAxiosParamCreator = function (configuration) {
|
|
|
409
410
|
});
|
|
410
411
|
},
|
|
411
412
|
/**
|
|
412
|
-
* Returns a list of users
|
|
413
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
413
414
|
* @summary List users
|
|
414
415
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
415
416
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -417,7 +418,7 @@ var UsersApiAxiosParamCreator = function (configuration) {
|
|
|
417
418
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
418
419
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
419
420
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, firstName, lastName</i>
|
|
420
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups<i>
|
|
421
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
421
422
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
422
423
|
* @param {*} [options] Override http request option.
|
|
423
424
|
* @throws {RequiredError}
|
|
@@ -574,10 +575,11 @@ var UsersApiFp = function (configuration) {
|
|
|
574
575
|
});
|
|
575
576
|
},
|
|
576
577
|
/**
|
|
577
|
-
*
|
|
578
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
579
|
+
* @summary Retrieve the user
|
|
578
580
|
* @param {string} code
|
|
579
581
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
580
|
-
* @param {string} [expand]
|
|
582
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
581
583
|
* @param {*} [options] Override http request option.
|
|
582
584
|
* @throws {RequiredError}
|
|
583
585
|
*/
|
|
@@ -616,7 +618,7 @@ var UsersApiFp = function (configuration) {
|
|
|
616
618
|
});
|
|
617
619
|
},
|
|
618
620
|
/**
|
|
619
|
-
* Returns a list of users
|
|
621
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
620
622
|
* @summary List users
|
|
621
623
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
622
624
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -624,7 +626,7 @@ var UsersApiFp = function (configuration) {
|
|
|
624
626
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
625
627
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
626
628
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, firstName, lastName</i>
|
|
627
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups<i>
|
|
629
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
628
630
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
629
631
|
* @param {*} [options] Override http request option.
|
|
630
632
|
* @throws {RequiredError}
|
|
@@ -695,10 +697,11 @@ var UsersApiFactory = function (configuration, basePath, axios) {
|
|
|
695
697
|
return localVarFp.enableUsers(enableUsersRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
696
698
|
},
|
|
697
699
|
/**
|
|
698
|
-
*
|
|
700
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
701
|
+
* @summary Retrieve the user
|
|
699
702
|
* @param {string} code
|
|
700
703
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
701
|
-
* @param {string} [expand]
|
|
704
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
702
705
|
* @param {*} [options] Override http request option.
|
|
703
706
|
* @throws {RequiredError}
|
|
704
707
|
*/
|
|
@@ -717,7 +720,7 @@ var UsersApiFactory = function (configuration, basePath, axios) {
|
|
|
717
720
|
return localVarFp.linkUserWithPartner(code, linkUserWithPartnerRequestDtoRest, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
718
721
|
},
|
|
719
722
|
/**
|
|
720
|
-
* Returns a list of users
|
|
723
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
721
724
|
* @summary List users
|
|
722
725
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
723
726
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -725,7 +728,7 @@ var UsersApiFactory = function (configuration, basePath, axios) {
|
|
|
725
728
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
726
729
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
727
730
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, firstName, lastName</i>
|
|
728
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups<i>
|
|
731
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: subscriptions, organizations, userGroups, roles, inheritedRoles<i>
|
|
729
732
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
730
733
|
* @param {*} [options] Override http request option.
|
|
731
734
|
* @throws {RequiredError}
|
|
@@ -793,7 +796,8 @@ var UsersApi = /** @class */ (function (_super) {
|
|
|
793
796
|
return (0, exports.UsersApiFp)(this.configuration).enableUsers(requestParameters.enableUsersRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
794
797
|
};
|
|
795
798
|
/**
|
|
796
|
-
*
|
|
799
|
+
* Returns the user with the given code. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.view\"
|
|
800
|
+
* @summary Retrieve the user
|
|
797
801
|
* @param {UsersApiGetUserRequest} requestParameters Request parameters.
|
|
798
802
|
* @param {*} [options] Override http request option.
|
|
799
803
|
* @throws {RequiredError}
|
|
@@ -815,7 +819,7 @@ var UsersApi = /** @class */ (function (_super) {
|
|
|
815
819
|
return (0, exports.UsersApiFp)(this.configuration).linkUserWithPartner(requestParameters.code, requestParameters.linkUserWithPartnerRequestDtoRest, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
816
820
|
};
|
|
817
821
|
/**
|
|
818
|
-
* Returns a list of users
|
|
822
|
+
* Returns a list of users. expand=roles returns only roles assigned directly to the user and leaves out roles granted by user groups. Use expand=inheritedRoles to get direct and user group roles together, each role once with its sources (DIRECT or GROUP with userGroupCode). **Required Permissions** \"tenant-management.users.list\"
|
|
819
823
|
* @summary List users
|
|
820
824
|
* @param {UsersApiListUsersRequest} requestParameters Request parameters.
|
|
821
825
|
* @param {*} [options] Override http request option.
|