@emilgroup/tenant-sdk 1.36.1-beta.18 → 1.36.1-beta.20
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-group-api.ts +40 -40
- package/dist/api/user-group-api.d.ts +40 -40
- package/dist/api/user-group-api.js +30 -30
- package/dist/models/create-user-group-request-dto.d.ts +1 -1
- package/dist/models/update-user-group-request-dto.d.ts +1 -1
- package/models/create-user-group-request-dto.ts +1 -1
- package/models/update-user-group-request-dto.ts +1 -1
- 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.36.1-beta.
|
|
20
|
+
npm install @emilgroup/tenant-sdk@1.36.1-beta.20 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/tenant-sdk@1.36.1-beta.
|
|
24
|
+
yarn add @emilgroup/tenant-sdk@1.36.1-beta.20
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `UsersApi`.
|
package/api/user-group-api.ts
CHANGED
|
@@ -236,12 +236,12 @@ export const UserGroupApiAxiosParamCreator = function (configuration?: Configura
|
|
|
236
236
|
* undefined **Required Permissions** \"identity-management.user-groups.view\"
|
|
237
237
|
* @param {string} code
|
|
238
238
|
* @param {string} [authorization] Bearer Token
|
|
239
|
-
* @param {number} [pageSize]
|
|
240
|
-
* @param {string} [pageToken]
|
|
241
|
-
* @param {string} [filter] Filter
|
|
239
|
+
* @param {number} [pageSize] Number of items per page.
|
|
240
|
+
* @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
|
|
241
|
+
* @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
|
|
242
242
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
243
|
-
* @param {string} [order]
|
|
244
|
-
* @param {string} [expand]
|
|
243
|
+
* @param {string} [order] Sort the response by allowed columns (see paginate config).
|
|
244
|
+
* @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
|
|
245
245
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
246
246
|
* @param {*} [options] Override http request option.
|
|
247
247
|
* @throws {RequiredError}
|
|
@@ -314,11 +314,11 @@ export const UserGroupApiAxiosParamCreator = function (configuration?: Configura
|
|
|
314
314
|
/**
|
|
315
315
|
* undefined **Required Permissions** \"identity-management.user-groups.view\"
|
|
316
316
|
* @param {string} [authorization] Bearer Token
|
|
317
|
-
* @param {number} [pageSize]
|
|
318
|
-
* @param {string} [pageToken]
|
|
319
|
-
* @param {string} [filter] Filter
|
|
320
|
-
* @param {string} [search]
|
|
321
|
-
* @param {string} [order]
|
|
317
|
+
* @param {number} [pageSize] Number of items per page.
|
|
318
|
+
* @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
|
|
319
|
+
* @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
|
|
320
|
+
* @param {string} [search] Free-text search over searchable columns.
|
|
321
|
+
* @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
|
|
322
322
|
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
323
323
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
324
324
|
* @param {*} [options] Override http request option.
|
|
@@ -545,12 +545,12 @@ export const UserGroupApiFp = function(configuration?: Configuration) {
|
|
|
545
545
|
* undefined **Required Permissions** \"identity-management.user-groups.view\"
|
|
546
546
|
* @param {string} code
|
|
547
547
|
* @param {string} [authorization] Bearer Token
|
|
548
|
-
* @param {number} [pageSize]
|
|
549
|
-
* @param {string} [pageToken]
|
|
550
|
-
* @param {string} [filter] Filter
|
|
548
|
+
* @param {number} [pageSize] Number of items per page.
|
|
549
|
+
* @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
|
|
550
|
+
* @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
|
|
551
551
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
552
|
-
* @param {string} [order]
|
|
553
|
-
* @param {string} [expand]
|
|
552
|
+
* @param {string} [order] Sort the response by allowed columns (see paginate config).
|
|
553
|
+
* @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
|
|
554
554
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
555
555
|
* @param {*} [options] Override http request option.
|
|
556
556
|
* @throws {RequiredError}
|
|
@@ -562,11 +562,11 @@ export const UserGroupApiFp = function(configuration?: Configuration) {
|
|
|
562
562
|
/**
|
|
563
563
|
* undefined **Required Permissions** \"identity-management.user-groups.view\"
|
|
564
564
|
* @param {string} [authorization] Bearer Token
|
|
565
|
-
* @param {number} [pageSize]
|
|
566
|
-
* @param {string} [pageToken]
|
|
567
|
-
* @param {string} [filter] Filter
|
|
568
|
-
* @param {string} [search]
|
|
569
|
-
* @param {string} [order]
|
|
565
|
+
* @param {number} [pageSize] Number of items per page.
|
|
566
|
+
* @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
|
|
567
|
+
* @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
|
|
568
|
+
* @param {string} [search] Free-text search over searchable columns.
|
|
569
|
+
* @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
|
|
570
570
|
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
571
571
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
572
572
|
* @param {*} [options] Override http request option.
|
|
@@ -655,12 +655,12 @@ export const UserGroupApiFactory = function (configuration?: Configuration, base
|
|
|
655
655
|
* undefined **Required Permissions** \"identity-management.user-groups.view\"
|
|
656
656
|
* @param {string} code
|
|
657
657
|
* @param {string} [authorization] Bearer Token
|
|
658
|
-
* @param {number} [pageSize]
|
|
659
|
-
* @param {string} [pageToken]
|
|
660
|
-
* @param {string} [filter] Filter
|
|
658
|
+
* @param {number} [pageSize] Number of items per page.
|
|
659
|
+
* @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
|
|
660
|
+
* @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
|
|
661
661
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
662
|
-
* @param {string} [order]
|
|
663
|
-
* @param {string} [expand]
|
|
662
|
+
* @param {string} [order] Sort the response by allowed columns (see paginate config).
|
|
663
|
+
* @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
|
|
664
664
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
665
665
|
* @param {*} [options] Override http request option.
|
|
666
666
|
* @throws {RequiredError}
|
|
@@ -671,11 +671,11 @@ export const UserGroupApiFactory = function (configuration?: Configuration, base
|
|
|
671
671
|
/**
|
|
672
672
|
* undefined **Required Permissions** \"identity-management.user-groups.view\"
|
|
673
673
|
* @param {string} [authorization] Bearer Token
|
|
674
|
-
* @param {number} [pageSize]
|
|
675
|
-
* @param {string} [pageToken]
|
|
676
|
-
* @param {string} [filter] Filter
|
|
677
|
-
* @param {string} [search]
|
|
678
|
-
* @param {string} [order]
|
|
674
|
+
* @param {number} [pageSize] Number of items per page.
|
|
675
|
+
* @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
|
|
676
|
+
* @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
|
|
677
|
+
* @param {string} [search] Free-text search over searchable columns.
|
|
678
|
+
* @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
|
|
679
679
|
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
680
680
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
681
681
|
* @param {*} [options] Override http request option.
|
|
@@ -821,21 +821,21 @@ export interface UserGroupApiListUserGroupMembersRequest {
|
|
|
821
821
|
readonly authorization?: string
|
|
822
822
|
|
|
823
823
|
/**
|
|
824
|
-
*
|
|
824
|
+
* Number of items per page.
|
|
825
825
|
* @type {number}
|
|
826
826
|
* @memberof UserGroupApiListUserGroupMembers
|
|
827
827
|
*/
|
|
828
828
|
readonly pageSize?: number
|
|
829
829
|
|
|
830
830
|
/**
|
|
831
|
-
*
|
|
831
|
+
* Opaque token for the next page (returned in a previous response).
|
|
832
832
|
* @type {string}
|
|
833
833
|
* @memberof UserGroupApiListUserGroupMembers
|
|
834
834
|
*/
|
|
835
835
|
readonly pageToken?: string
|
|
836
836
|
|
|
837
837
|
/**
|
|
838
|
-
* Filter
|
|
838
|
+
* Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
|
|
839
839
|
* @type {string}
|
|
840
840
|
* @memberof UserGroupApiListUserGroupMembers
|
|
841
841
|
*/
|
|
@@ -849,14 +849,14 @@ export interface UserGroupApiListUserGroupMembersRequest {
|
|
|
849
849
|
readonly search?: string
|
|
850
850
|
|
|
851
851
|
/**
|
|
852
|
-
*
|
|
852
|
+
* Sort the response by allowed columns (see paginate config).
|
|
853
853
|
* @type {string}
|
|
854
854
|
* @memberof UserGroupApiListUserGroupMembers
|
|
855
855
|
*/
|
|
856
856
|
readonly order?: string
|
|
857
857
|
|
|
858
858
|
/**
|
|
859
|
-
*
|
|
859
|
+
* Comma-separated list of related objects to embed in each member (e.g. user details).
|
|
860
860
|
* @type {string}
|
|
861
861
|
* @memberof UserGroupApiListUserGroupMembers
|
|
862
862
|
*/
|
|
@@ -884,35 +884,35 @@ export interface UserGroupApiListUserGroupsRequest {
|
|
|
884
884
|
readonly authorization?: string
|
|
885
885
|
|
|
886
886
|
/**
|
|
887
|
-
*
|
|
887
|
+
* Number of items per page.
|
|
888
888
|
* @type {number}
|
|
889
889
|
* @memberof UserGroupApiListUserGroups
|
|
890
890
|
*/
|
|
891
891
|
readonly pageSize?: number
|
|
892
892
|
|
|
893
893
|
/**
|
|
894
|
-
*
|
|
894
|
+
* Opaque token for the next page (returned in a previous response).
|
|
895
895
|
* @type {string}
|
|
896
896
|
* @memberof UserGroupApiListUserGroups
|
|
897
897
|
*/
|
|
898
898
|
readonly pageToken?: string
|
|
899
899
|
|
|
900
900
|
/**
|
|
901
|
-
* Filter
|
|
901
|
+
* Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
|
|
902
902
|
* @type {string}
|
|
903
903
|
* @memberof UserGroupApiListUserGroups
|
|
904
904
|
*/
|
|
905
905
|
readonly filter?: string
|
|
906
906
|
|
|
907
907
|
/**
|
|
908
|
-
*
|
|
908
|
+
* Free-text search over searchable columns.
|
|
909
909
|
* @type {string}
|
|
910
910
|
* @memberof UserGroupApiListUserGroups
|
|
911
911
|
*/
|
|
912
912
|
readonly search?: string
|
|
913
913
|
|
|
914
914
|
/**
|
|
915
|
-
*
|
|
915
|
+
* Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
|
|
916
916
|
* @type {string}
|
|
917
917
|
* @memberof UserGroupApiListUserGroups
|
|
918
918
|
*/
|
|
@@ -65,12 +65,12 @@ export declare const UserGroupApiAxiosParamCreator: (configuration?: Configurati
|
|
|
65
65
|
* undefined **Required Permissions** \"identity-management.user-groups.view\"
|
|
66
66
|
* @param {string} code
|
|
67
67
|
* @param {string} [authorization] Bearer Token
|
|
68
|
-
* @param {number} [pageSize]
|
|
69
|
-
* @param {string} [pageToken]
|
|
70
|
-
* @param {string} [filter] Filter
|
|
68
|
+
* @param {number} [pageSize] Number of items per page.
|
|
69
|
+
* @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
|
|
70
|
+
* @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
|
|
71
71
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
72
|
-
* @param {string} [order]
|
|
73
|
-
* @param {string} [expand]
|
|
72
|
+
* @param {string} [order] Sort the response by allowed columns (see paginate config).
|
|
73
|
+
* @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
|
|
74
74
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
75
75
|
* @param {*} [options] Override http request option.
|
|
76
76
|
* @throws {RequiredError}
|
|
@@ -79,11 +79,11 @@ export declare const UserGroupApiAxiosParamCreator: (configuration?: Configurati
|
|
|
79
79
|
/**
|
|
80
80
|
* undefined **Required Permissions** \"identity-management.user-groups.view\"
|
|
81
81
|
* @param {string} [authorization] Bearer Token
|
|
82
|
-
* @param {number} [pageSize]
|
|
83
|
-
* @param {string} [pageToken]
|
|
84
|
-
* @param {string} [filter] Filter
|
|
85
|
-
* @param {string} [search]
|
|
86
|
-
* @param {string} [order]
|
|
82
|
+
* @param {number} [pageSize] Number of items per page.
|
|
83
|
+
* @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
|
|
84
|
+
* @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
|
|
85
|
+
* @param {string} [search] Free-text search over searchable columns.
|
|
86
|
+
* @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
|
|
87
87
|
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
88
88
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
89
89
|
* @param {*} [options] Override http request option.
|
|
@@ -151,12 +151,12 @@ export declare const UserGroupApiFp: (configuration?: Configuration) => {
|
|
|
151
151
|
* undefined **Required Permissions** \"identity-management.user-groups.view\"
|
|
152
152
|
* @param {string} code
|
|
153
153
|
* @param {string} [authorization] Bearer Token
|
|
154
|
-
* @param {number} [pageSize]
|
|
155
|
-
* @param {string} [pageToken]
|
|
156
|
-
* @param {string} [filter] Filter
|
|
154
|
+
* @param {number} [pageSize] Number of items per page.
|
|
155
|
+
* @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
|
|
156
|
+
* @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
|
|
157
157
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
158
|
-
* @param {string} [order]
|
|
159
|
-
* @param {string} [expand]
|
|
158
|
+
* @param {string} [order] Sort the response by allowed columns (see paginate config).
|
|
159
|
+
* @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
|
|
160
160
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
161
161
|
* @param {*} [options] Override http request option.
|
|
162
162
|
* @throws {RequiredError}
|
|
@@ -165,11 +165,11 @@ export declare const UserGroupApiFp: (configuration?: Configuration) => {
|
|
|
165
165
|
/**
|
|
166
166
|
* undefined **Required Permissions** \"identity-management.user-groups.view\"
|
|
167
167
|
* @param {string} [authorization] Bearer Token
|
|
168
|
-
* @param {number} [pageSize]
|
|
169
|
-
* @param {string} [pageToken]
|
|
170
|
-
* @param {string} [filter] Filter
|
|
171
|
-
* @param {string} [search]
|
|
172
|
-
* @param {string} [order]
|
|
168
|
+
* @param {number} [pageSize] Number of items per page.
|
|
169
|
+
* @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
|
|
170
|
+
* @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
|
|
171
|
+
* @param {string} [search] Free-text search over searchable columns.
|
|
172
|
+
* @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
|
|
173
173
|
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
174
174
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
175
175
|
* @param {*} [options] Override http request option.
|
|
@@ -237,12 +237,12 @@ export declare const UserGroupApiFactory: (configuration?: Configuration, basePa
|
|
|
237
237
|
* undefined **Required Permissions** \"identity-management.user-groups.view\"
|
|
238
238
|
* @param {string} code
|
|
239
239
|
* @param {string} [authorization] Bearer Token
|
|
240
|
-
* @param {number} [pageSize]
|
|
241
|
-
* @param {string} [pageToken]
|
|
242
|
-
* @param {string} [filter] Filter
|
|
240
|
+
* @param {number} [pageSize] Number of items per page.
|
|
241
|
+
* @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
|
|
242
|
+
* @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
|
|
243
243
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
244
|
-
* @param {string} [order]
|
|
245
|
-
* @param {string} [expand]
|
|
244
|
+
* @param {string} [order] Sort the response by allowed columns (see paginate config).
|
|
245
|
+
* @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
|
|
246
246
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
247
247
|
* @param {*} [options] Override http request option.
|
|
248
248
|
* @throws {RequiredError}
|
|
@@ -251,11 +251,11 @@ export declare const UserGroupApiFactory: (configuration?: Configuration, basePa
|
|
|
251
251
|
/**
|
|
252
252
|
* undefined **Required Permissions** \"identity-management.user-groups.view\"
|
|
253
253
|
* @param {string} [authorization] Bearer Token
|
|
254
|
-
* @param {number} [pageSize]
|
|
255
|
-
* @param {string} [pageToken]
|
|
256
|
-
* @param {string} [filter] Filter
|
|
257
|
-
* @param {string} [search]
|
|
258
|
-
* @param {string} [order]
|
|
254
|
+
* @param {number} [pageSize] Number of items per page.
|
|
255
|
+
* @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
|
|
256
|
+
* @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
|
|
257
|
+
* @param {string} [search] Free-text search over searchable columns.
|
|
258
|
+
* @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
|
|
259
259
|
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
260
260
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
261
261
|
* @param {*} [options] Override http request option.
|
|
@@ -382,19 +382,19 @@ export interface UserGroupApiListUserGroupMembersRequest {
|
|
|
382
382
|
*/
|
|
383
383
|
readonly authorization?: string;
|
|
384
384
|
/**
|
|
385
|
-
*
|
|
385
|
+
* Number of items per page.
|
|
386
386
|
* @type {number}
|
|
387
387
|
* @memberof UserGroupApiListUserGroupMembers
|
|
388
388
|
*/
|
|
389
389
|
readonly pageSize?: number;
|
|
390
390
|
/**
|
|
391
|
-
*
|
|
391
|
+
* Opaque token for the next page (returned in a previous response).
|
|
392
392
|
* @type {string}
|
|
393
393
|
* @memberof UserGroupApiListUserGroupMembers
|
|
394
394
|
*/
|
|
395
395
|
readonly pageToken?: string;
|
|
396
396
|
/**
|
|
397
|
-
* Filter
|
|
397
|
+
* Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
|
|
398
398
|
* @type {string}
|
|
399
399
|
* @memberof UserGroupApiListUserGroupMembers
|
|
400
400
|
*/
|
|
@@ -406,13 +406,13 @@ export interface UserGroupApiListUserGroupMembersRequest {
|
|
|
406
406
|
*/
|
|
407
407
|
readonly search?: string;
|
|
408
408
|
/**
|
|
409
|
-
*
|
|
409
|
+
* Sort the response by allowed columns (see paginate config).
|
|
410
410
|
* @type {string}
|
|
411
411
|
* @memberof UserGroupApiListUserGroupMembers
|
|
412
412
|
*/
|
|
413
413
|
readonly order?: string;
|
|
414
414
|
/**
|
|
415
|
-
*
|
|
415
|
+
* Comma-separated list of related objects to embed in each member (e.g. user details).
|
|
416
416
|
* @type {string}
|
|
417
417
|
* @memberof UserGroupApiListUserGroupMembers
|
|
418
418
|
*/
|
|
@@ -437,31 +437,31 @@ export interface UserGroupApiListUserGroupsRequest {
|
|
|
437
437
|
*/
|
|
438
438
|
readonly authorization?: string;
|
|
439
439
|
/**
|
|
440
|
-
*
|
|
440
|
+
* Number of items per page.
|
|
441
441
|
* @type {number}
|
|
442
442
|
* @memberof UserGroupApiListUserGroups
|
|
443
443
|
*/
|
|
444
444
|
readonly pageSize?: number;
|
|
445
445
|
/**
|
|
446
|
-
*
|
|
446
|
+
* Opaque token for the next page (returned in a previous response).
|
|
447
447
|
* @type {string}
|
|
448
448
|
* @memberof UserGroupApiListUserGroups
|
|
449
449
|
*/
|
|
450
450
|
readonly pageToken?: string;
|
|
451
451
|
/**
|
|
452
|
-
* Filter
|
|
452
|
+
* Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
|
|
453
453
|
* @type {string}
|
|
454
454
|
* @memberof UserGroupApiListUserGroups
|
|
455
455
|
*/
|
|
456
456
|
readonly filter?: string;
|
|
457
457
|
/**
|
|
458
|
-
*
|
|
458
|
+
* Free-text search over searchable columns.
|
|
459
459
|
* @type {string}
|
|
460
460
|
* @memberof UserGroupApiListUserGroups
|
|
461
461
|
*/
|
|
462
462
|
readonly search?: string;
|
|
463
463
|
/**
|
|
464
|
-
*
|
|
464
|
+
* Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
|
|
465
465
|
* @type {string}
|
|
466
466
|
* @memberof UserGroupApiListUserGroups
|
|
467
467
|
*/
|
|
@@ -290,12 +290,12 @@ var UserGroupApiAxiosParamCreator = function (configuration) {
|
|
|
290
290
|
* undefined **Required Permissions** \"identity-management.user-groups.view\"
|
|
291
291
|
* @param {string} code
|
|
292
292
|
* @param {string} [authorization] Bearer Token
|
|
293
|
-
* @param {number} [pageSize]
|
|
294
|
-
* @param {string} [pageToken]
|
|
295
|
-
* @param {string} [filter] Filter
|
|
293
|
+
* @param {number} [pageSize] Number of items per page.
|
|
294
|
+
* @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
|
|
295
|
+
* @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
|
|
296
296
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
297
|
-
* @param {string} [order]
|
|
298
|
-
* @param {string} [expand]
|
|
297
|
+
* @param {string} [order] Sort the response by allowed columns (see paginate config).
|
|
298
|
+
* @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
|
|
299
299
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
300
300
|
* @param {*} [options] Override http request option.
|
|
301
301
|
* @throws {RequiredError}
|
|
@@ -364,11 +364,11 @@ var UserGroupApiAxiosParamCreator = function (configuration) {
|
|
|
364
364
|
/**
|
|
365
365
|
* undefined **Required Permissions** \"identity-management.user-groups.view\"
|
|
366
366
|
* @param {string} [authorization] Bearer Token
|
|
367
|
-
* @param {number} [pageSize]
|
|
368
|
-
* @param {string} [pageToken]
|
|
369
|
-
* @param {string} [filter] Filter
|
|
370
|
-
* @param {string} [search]
|
|
371
|
-
* @param {string} [order]
|
|
367
|
+
* @param {number} [pageSize] Number of items per page.
|
|
368
|
+
* @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
|
|
369
|
+
* @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
|
|
370
|
+
* @param {string} [search] Free-text search over searchable columns.
|
|
371
|
+
* @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
|
|
372
372
|
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
373
373
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
374
374
|
* @param {*} [options] Override http request option.
|
|
@@ -631,12 +631,12 @@ var UserGroupApiFp = function (configuration) {
|
|
|
631
631
|
* undefined **Required Permissions** \"identity-management.user-groups.view\"
|
|
632
632
|
* @param {string} code
|
|
633
633
|
* @param {string} [authorization] Bearer Token
|
|
634
|
-
* @param {number} [pageSize]
|
|
635
|
-
* @param {string} [pageToken]
|
|
636
|
-
* @param {string} [filter] Filter
|
|
634
|
+
* @param {number} [pageSize] Number of items per page.
|
|
635
|
+
* @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
|
|
636
|
+
* @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
|
|
637
637
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
638
|
-
* @param {string} [order]
|
|
639
|
-
* @param {string} [expand]
|
|
638
|
+
* @param {string} [order] Sort the response by allowed columns (see paginate config).
|
|
639
|
+
* @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
|
|
640
640
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
641
641
|
* @param {*} [options] Override http request option.
|
|
642
642
|
* @throws {RequiredError}
|
|
@@ -657,11 +657,11 @@ var UserGroupApiFp = function (configuration) {
|
|
|
657
657
|
/**
|
|
658
658
|
* undefined **Required Permissions** \"identity-management.user-groups.view\"
|
|
659
659
|
* @param {string} [authorization] Bearer Token
|
|
660
|
-
* @param {number} [pageSize]
|
|
661
|
-
* @param {string} [pageToken]
|
|
662
|
-
* @param {string} [filter] Filter
|
|
663
|
-
* @param {string} [search]
|
|
664
|
-
* @param {string} [order]
|
|
660
|
+
* @param {number} [pageSize] Number of items per page.
|
|
661
|
+
* @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
|
|
662
|
+
* @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
|
|
663
|
+
* @param {string} [search] Free-text search over searchable columns.
|
|
664
|
+
* @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
|
|
665
665
|
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
666
666
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
667
667
|
* @param {*} [options] Override http request option.
|
|
@@ -777,12 +777,12 @@ var UserGroupApiFactory = function (configuration, basePath, axios) {
|
|
|
777
777
|
* undefined **Required Permissions** \"identity-management.user-groups.view\"
|
|
778
778
|
* @param {string} code
|
|
779
779
|
* @param {string} [authorization] Bearer Token
|
|
780
|
-
* @param {number} [pageSize]
|
|
781
|
-
* @param {string} [pageToken]
|
|
782
|
-
* @param {string} [filter] Filter
|
|
780
|
+
* @param {number} [pageSize] Number of items per page.
|
|
781
|
+
* @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
|
|
782
|
+
* @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
|
|
783
783
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
784
|
-
* @param {string} [order]
|
|
785
|
-
* @param {string} [expand]
|
|
784
|
+
* @param {string} [order] Sort the response by allowed columns (see paginate config).
|
|
785
|
+
* @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
|
|
786
786
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
787
787
|
* @param {*} [options] Override http request option.
|
|
788
788
|
* @throws {RequiredError}
|
|
@@ -793,11 +793,11 @@ var UserGroupApiFactory = function (configuration, basePath, axios) {
|
|
|
793
793
|
/**
|
|
794
794
|
* undefined **Required Permissions** \"identity-management.user-groups.view\"
|
|
795
795
|
* @param {string} [authorization] Bearer Token
|
|
796
|
-
* @param {number} [pageSize]
|
|
797
|
-
* @param {string} [pageToken]
|
|
798
|
-
* @param {string} [filter] Filter
|
|
799
|
-
* @param {string} [search]
|
|
800
|
-
* @param {string} [order]
|
|
796
|
+
* @param {number} [pageSize] Number of items per page.
|
|
797
|
+
* @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
|
|
798
|
+
* @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
|
|
799
|
+
* @param {string} [search] Free-text search over searchable columns.
|
|
800
|
+
* @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
|
|
801
801
|
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
802
802
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
803
803
|
* @param {*} [options] Override http request option.
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface CreateUserGroupRequestDto {
|
|
18
18
|
/**
|
|
19
|
-
* Human-readable, renameable identifier for the user group. Unique per tenant.
|
|
19
|
+
* Human-readable, renameable identifier for the user group. Unique per tenant. Must match /^[a-z0-9-]+$/.
|
|
20
20
|
* @type {string}
|
|
21
21
|
* @memberof CreateUserGroupRequestDto
|
|
22
22
|
*/
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
*/
|
|
22
22
|
export interface CreateUserGroupRequestDto {
|
|
23
23
|
/**
|
|
24
|
-
* Human-readable, renameable identifier for the user group. Unique per tenant.
|
|
24
|
+
* Human-readable, renameable identifier for the user group. Unique per tenant. Must match /^[a-z0-9-]+$/.
|
|
25
25
|
* @type {string}
|
|
26
26
|
* @memberof CreateUserGroupRequestDto
|
|
27
27
|
*/
|