@flipdish/authorization 0.2.7-rc.1763978242 → 0.2.11-rc.1764849351

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/dist/api.d.ts CHANGED
@@ -133,18 +133,18 @@ export interface AssignRoleSuccessResponse {
133
133
  'message': string;
134
134
  }
135
135
  /**
136
- *
136
+ * Request to check if a user is authorized to perform an action(s). If you pass in an array of permissions, you will receive a single allow / deny response (based on an AND of the result for each permission). For a granular response to multiple permissions, call the /authorize/batch endpoint.
137
137
  * @export
138
138
  * @interface AuthenticateAndAuthorizeRequest
139
139
  */
140
140
  export interface AuthenticateAndAuthorizeRequest {
141
141
  /**
142
142
  * Incoming request headers to be used for authentication
143
- * @type {{ [key: string]: any; }}
143
+ * @type {{ [key: string]: string; }}
144
144
  * @memberof AuthenticateAndAuthorizeRequest
145
145
  */
146
146
  'headers': {
147
- [key: string]: any;
147
+ [key: string]: string;
148
148
  };
149
149
  /**
150
150
  *
@@ -167,10 +167,10 @@ export interface AuthenticateAndAuthorizeRequest {
167
167
  export interface AuthenticateAndAuthorizeResponse {
168
168
  /**
169
169
  *
170
- * @type {AuthenticateAndAuthorizeResponseAuthentication}
170
+ * @type {AuthenticateAndCheckIsInRoleResponseAuthentication}
171
171
  * @memberof AuthenticateAndAuthorizeResponse
172
172
  */
173
- 'authentication': AuthenticateAndAuthorizeResponseAuthentication;
173
+ 'authentication': AuthenticateAndCheckIsInRoleResponseAuthentication;
174
174
  /**
175
175
  *
176
176
  * @type {AuthorizationResponse}
@@ -181,25 +181,81 @@ export interface AuthenticateAndAuthorizeResponse {
181
181
  /**
182
182
  *
183
183
  * @export
184
- * @interface AuthenticateAndAuthorizeResponseAuthentication
184
+ * @interface AuthenticateAndCheckIsInRoleRequest
185
+ */
186
+ export interface AuthenticateAndCheckIsInRoleRequest {
187
+ /**
188
+ * Incoming request headers to be used for authentication
189
+ * @type {{ [key: string]: string; }}
190
+ * @memberof AuthenticateAndCheckIsInRoleRequest
191
+ */
192
+ 'headers': {
193
+ [key: string]: string;
194
+ };
195
+ /**
196
+ * Array of roles to check if the principal is in
197
+ * @type {Array<string>}
198
+ * @memberof AuthenticateAndCheckIsInRoleRequest
199
+ */
200
+ 'roles': Array<AuthenticateAndCheckIsInRoleRequestRolesEnum>;
201
+ /**
202
+ * How to check if the principal is in any/all of the roles
203
+ * @type {string}
204
+ * @memberof AuthenticateAndCheckIsInRoleRequest
205
+ */
206
+ 'checkMode'?: AuthenticateAndCheckIsInRoleRequestCheckModeEnum;
207
+ }
208
+ export declare const AuthenticateAndCheckIsInRoleRequestRolesEnum: {
209
+ readonly Admin: "Admin";
210
+ readonly Factory: "Factory";
211
+ };
212
+ export type AuthenticateAndCheckIsInRoleRequestRolesEnum = typeof AuthenticateAndCheckIsInRoleRequestRolesEnum[keyof typeof AuthenticateAndCheckIsInRoleRequestRolesEnum];
213
+ export declare const AuthenticateAndCheckIsInRoleRequestCheckModeEnum: {
214
+ readonly Any: "any";
215
+ readonly All: "all";
216
+ };
217
+ export type AuthenticateAndCheckIsInRoleRequestCheckModeEnum = typeof AuthenticateAndCheckIsInRoleRequestCheckModeEnum[keyof typeof AuthenticateAndCheckIsInRoleRequestCheckModeEnum];
218
+ /**
219
+ * Response containing whether the principal is in any/all of the roles
220
+ * @export
221
+ * @interface AuthenticateAndCheckIsInRoleResponse
185
222
  */
186
- export interface AuthenticateAndAuthorizeResponseAuthentication {
223
+ export interface AuthenticateAndCheckIsInRoleResponse {
224
+ /**
225
+ *
226
+ * @type {AuthenticateAndCheckIsInRoleResponseAuthentication}
227
+ * @memberof AuthenticateAndCheckIsInRoleResponse
228
+ */
229
+ 'authentication': AuthenticateAndCheckIsInRoleResponseAuthentication;
230
+ /**
231
+ * result of the check - whether the principal is in any/all of the roles
232
+ * @type {boolean}
233
+ * @memberof AuthenticateAndCheckIsInRoleResponse
234
+ */
235
+ 'authorized': boolean;
236
+ }
237
+ /**
238
+ *
239
+ * @export
240
+ * @interface AuthenticateAndCheckIsInRoleResponseAuthentication
241
+ */
242
+ export interface AuthenticateAndCheckIsInRoleResponseAuthentication {
187
243
  /**
188
244
  *
189
245
  * @type {AuthorizationRequestPrincipal}
190
- * @memberof AuthenticateAndAuthorizeResponseAuthentication
246
+ * @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
191
247
  */
192
248
  'principal': AuthorizationRequestPrincipal;
193
249
  /**
194
250
  * Whether the user is authenticated
195
251
  * @type {boolean}
196
- * @memberof AuthenticateAndAuthorizeResponseAuthentication
252
+ * @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
197
253
  */
198
254
  'authenticated': boolean;
199
255
  /**
200
256
  * The reason for the authentication failure
201
257
  * @type {string}
202
- * @memberof AuthenticateAndAuthorizeResponseAuthentication
258
+ * @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
203
259
  */
204
260
  'reason'?: string;
205
261
  }
@@ -234,12 +290,6 @@ export interface AuthorizationBatchRequest {
234
290
  * @interface AuthorizationBatchResponse
235
291
  */
236
292
  export interface AuthorizationBatchResponse {
237
- /**
238
- *
239
- * @type {AuthorizationBatchResponseRequest}
240
- * @memberof AuthorizationBatchResponse
241
- */
242
- 'request': AuthorizationBatchResponseRequest;
243
293
  /**
244
294
  * Array of allowed resources
245
295
  * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
@@ -290,25 +340,6 @@ export interface AuthorizationBatchResponseAllowedResourcesInner {
290
340
  * @export
291
341
  */
292
342
  export type AuthorizationBatchResponseAllowedResourcesInnerResource = AuthorizationRequestResourceOneOf | AuthorizationRequestResourceOneOf1 | AuthorizationRequestResourceOneOf2 | AuthorizationRequestResourceOneOf3;
293
- /**
294
- * The request that was checked
295
- * @export
296
- * @interface AuthorizationBatchResponseRequest
297
- */
298
- export interface AuthorizationBatchResponseRequest {
299
- /**
300
- *
301
- * @type {AuthorizationRequestPrincipal}
302
- * @memberof AuthorizationBatchResponseRequest
303
- */
304
- 'principal': AuthorizationRequestPrincipal;
305
- /**
306
- *
307
- * @type {AuthorizationRequestAction}
308
- * @memberof AuthorizationBatchResponseRequest
309
- */
310
- 'action': AuthorizationRequestAction;
311
- }
312
343
  /**
313
344
  * Request to check if a user is authorized to perform an action(s). If you pass in an array of permissions, you will receive a single allow / deny response (based on an AND of the result for each permission).
314
345
  * @export
@@ -486,12 +517,6 @@ export type AuthorizationRequestResourceOneOf3TypeEnum = typeof AuthorizationReq
486
517
  * @interface AuthorizationResponse
487
518
  */
488
519
  export interface AuthorizationResponse {
489
- /**
490
- *
491
- * @type {AuthorizationRequest}
492
- * @memberof AuthorizationResponse
493
- */
494
- 'request': AuthorizationRequest;
495
520
  /**
496
521
  * Whether the action is allowed
497
522
  * @type {boolean}
@@ -524,6 +549,25 @@ export interface ErrorResponse {
524
549
  */
525
550
  'message': string;
526
551
  }
552
+ /**
553
+ * Feature based role and its permissions
554
+ * @export
555
+ * @interface FeatureBasedRole
556
+ */
557
+ export interface FeatureBasedRole {
558
+ /**
559
+ * Name of the role
560
+ * @type {string}
561
+ * @memberof FeatureBasedRole
562
+ */
563
+ 'name': string;
564
+ /**
565
+ *
566
+ * @type {Permissions & Array<string>}
567
+ * @memberof FeatureBasedRole
568
+ */
569
+ 'permissions': Permissions & Array<string>;
570
+ }
527
571
  /**
528
572
  * Request to get authorized brands for a principal or the authenticated user based on the headers. Either principal or headers must be provided, but not both. If both are provided, the principal will be used.
529
573
  * @export
@@ -538,11 +582,11 @@ export interface GetAuthorizedBrandsRequest {
538
582
  'principal'?: GetAuthorizedOrgsRequestPrincipal;
539
583
  /**
540
584
  * Incoming request headers to be used for authentication
541
- * @type {{ [key: string]: any; }}
585
+ * @type {{ [key: string]: string; }}
542
586
  * @memberof GetAuthorizedBrandsRequest
543
587
  */
544
588
  'headers'?: {
545
- [key: string]: any;
589
+ [key: string]: string;
546
590
  };
547
591
  /**
548
592
  * The action to check authorisation for
@@ -778,6 +822,8 @@ export declare const GetAuthorizedBrandsRequestActionEnum: {
778
822
  readonly ViewOrg: "ViewOrg";
779
823
  readonly ViewWebhooks: "ViewWebhooks";
780
824
  readonly EditWebhooks: "EditWebhooks";
825
+ readonly RoleAdmin: "RoleAdmin";
826
+ readonly RoleFactory: "RoleFactory";
781
827
  };
782
828
  export type GetAuthorizedBrandsRequestActionEnum = typeof GetAuthorizedBrandsRequestActionEnum[keyof typeof GetAuthorizedBrandsRequestActionEnum];
783
829
  /**
@@ -786,12 +832,6 @@ export type GetAuthorizedBrandsRequestActionEnum = typeof GetAuthorizedBrandsReq
786
832
  * @interface GetAuthorizedBrandsResponse
787
833
  */
788
834
  export interface GetAuthorizedBrandsResponse {
789
- /**
790
- *
791
- * @type {AuthorizationBatchResponseRequest}
792
- * @memberof GetAuthorizedBrandsResponse
793
- */
794
- 'request': AuthorizationBatchResponseRequest;
795
835
  /**
796
836
  * Array of allowed resources
797
837
  * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
@@ -819,11 +859,11 @@ export interface GetAuthorizedOrgsRequest {
819
859
  'principal'?: GetAuthorizedOrgsRequestPrincipal;
820
860
  /**
821
861
  * Incoming request headers to be used for authentication
822
- * @type {{ [key: string]: any; }}
862
+ * @type {{ [key: string]: string; }}
823
863
  * @memberof GetAuthorizedOrgsRequest
824
864
  */
825
865
  'headers'?: {
826
- [key: string]: any;
866
+ [key: string]: string;
827
867
  };
828
868
  /**
829
869
  * The action to check authorisation for
@@ -1059,6 +1099,8 @@ export declare const GetAuthorizedOrgsRequestActionEnum: {
1059
1099
  readonly ViewOrg: "ViewOrg";
1060
1100
  readonly ViewWebhooks: "ViewWebhooks";
1061
1101
  readonly EditWebhooks: "EditWebhooks";
1102
+ readonly RoleAdmin: "RoleAdmin";
1103
+ readonly RoleFactory: "RoleFactory";
1062
1104
  };
1063
1105
  export type GetAuthorizedOrgsRequestActionEnum = typeof GetAuthorizedOrgsRequestActionEnum[keyof typeof GetAuthorizedOrgsRequestActionEnum];
1064
1106
  /**
@@ -1109,12 +1151,6 @@ export type GetAuthorizedOrgsRequestPrincipalTypeEnum = typeof GetAuthorizedOrgs
1109
1151
  * @interface GetAuthorizedOrgsResponse
1110
1152
  */
1111
1153
  export interface GetAuthorizedOrgsResponse {
1112
- /**
1113
- *
1114
- * @type {AuthorizationBatchResponseRequest}
1115
- * @memberof GetAuthorizedOrgsResponse
1116
- */
1117
- 'request': AuthorizationBatchResponseRequest;
1118
1154
  /**
1119
1155
  * Array of allowed resources
1120
1156
  * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
@@ -1142,11 +1178,11 @@ export interface GetAuthorizedPropertiesRequest {
1142
1178
  'principal'?: GetAuthorizedOrgsRequestPrincipal;
1143
1179
  /**
1144
1180
  * Incoming request headers to be used for authentication
1145
- * @type {{ [key: string]: any; }}
1181
+ * @type {{ [key: string]: string; }}
1146
1182
  * @memberof GetAuthorizedPropertiesRequest
1147
1183
  */
1148
1184
  'headers'?: {
1149
- [key: string]: any;
1185
+ [key: string]: string;
1150
1186
  };
1151
1187
  /**
1152
1188
  * The action to check authorisation for
@@ -1382,6 +1418,8 @@ export declare const GetAuthorizedPropertiesRequestActionEnum: {
1382
1418
  readonly ViewOrg: "ViewOrg";
1383
1419
  readonly ViewWebhooks: "ViewWebhooks";
1384
1420
  readonly EditWebhooks: "EditWebhooks";
1421
+ readonly RoleAdmin: "RoleAdmin";
1422
+ readonly RoleFactory: "RoleFactory";
1385
1423
  };
1386
1424
  export type GetAuthorizedPropertiesRequestActionEnum = typeof GetAuthorizedPropertiesRequestActionEnum[keyof typeof GetAuthorizedPropertiesRequestActionEnum];
1387
1425
  /**
@@ -1390,12 +1428,6 @@ export type GetAuthorizedPropertiesRequestActionEnum = typeof GetAuthorizedPrope
1390
1428
  * @interface GetAuthorizedPropertiesResponse
1391
1429
  */
1392
1430
  export interface GetAuthorizedPropertiesResponse {
1393
- /**
1394
- *
1395
- * @type {AuthorizationBatchResponseRequest}
1396
- * @memberof GetAuthorizedPropertiesResponse
1397
- */
1398
- 'request': AuthorizationBatchResponseRequest;
1399
1431
  /**
1400
1432
  * Array of allowed resources
1401
1433
  * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
@@ -1409,19 +1441,6 @@ export interface GetAuthorizedPropertiesResponse {
1409
1441
  */
1410
1442
  'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
1411
1443
  }
1412
- /**
1413
- * Successful permissions retrieval response
1414
- * @export
1415
- * @interface GetPermissionsSuccessResponse
1416
- */
1417
- export interface GetPermissionsSuccessResponse {
1418
- /**
1419
- *
1420
- * @type {Permissions & Array<string>}
1421
- * @memberof GetPermissionsSuccessResponse
1422
- */
1423
- 'permissions': Permissions & Array<string>;
1424
- }
1425
1444
  /**
1426
1445
  * Details for getting roles for a principal
1427
1446
  * @export
@@ -1495,7 +1514,7 @@ export interface GetPrincipalRolesSuccessResponseRolesInner {
1495
1514
  * @type {string}
1496
1515
  * @memberof GetPrincipalRolesSuccessResponseRolesInner
1497
1516
  */
1498
- 'resourceType': GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum;
1517
+ 'resourceType'?: GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum;
1499
1518
  /**
1500
1519
  * Organization ID
1501
1520
  * @type {string}
@@ -1538,6 +1557,7 @@ export declare const GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum: {
1538
1557
  readonly BrandOverride: "BrandOverride";
1539
1558
  readonly OrgOverride: "OrgOverride";
1540
1559
  readonly Forbidden: "Forbidden";
1560
+ readonly NamedRole: "NamedRole";
1541
1561
  };
1542
1562
  export type GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum];
1543
1563
  export declare const GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum: {
@@ -1559,19 +1579,6 @@ export type GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum = typeof
1559
1579
  */
1560
1580
  export interface GetPrincipalRolesSuccessResponseRolesInnerRoleName {
1561
1581
  }
1562
- /**
1563
- * Successful roles retrieval response
1564
- * @export
1565
- * @interface GetRolesSuccessResponse
1566
- */
1567
- export interface GetRolesSuccessResponse {
1568
- /**
1569
- * List of roles available and their permissions
1570
- * @type {Array<RolesInner>}
1571
- * @memberof GetRolesSuccessResponse
1572
- */
1573
- 'roles': Array<RolesInner>;
1574
- }
1575
1582
  /**
1576
1583
  * Successful user permissions retrieval response
1577
1584
  * @export
@@ -1846,6 +1853,8 @@ export declare const GetUserPermissionsSuccessResponseResourcesValuePermissionsE
1846
1853
  readonly ViewOrg: "ViewOrg";
1847
1854
  readonly ViewWebhooks: "ViewWebhooks";
1848
1855
  readonly EditWebhooks: "EditWebhooks";
1856
+ readonly RoleAdmin: "RoleAdmin";
1857
+ readonly RoleFactory: "RoleFactory";
1849
1858
  };
1850
1859
  export type GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum = typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum];
1851
1860
  /**
@@ -1855,6 +1864,67 @@ export type GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum = typ
1855
1864
  */
1856
1865
  export interface GetUserPermissionsSuccessResponseResourcesValueResourceId {
1857
1866
  }
1867
+ /**
1868
+ *
1869
+ * @export
1870
+ * @interface IsInRoleRequest
1871
+ */
1872
+ export interface IsInRoleRequest {
1873
+ /**
1874
+ *
1875
+ * @type {AuthorizationRequestPrincipal}
1876
+ * @memberof IsInRoleRequest
1877
+ */
1878
+ 'principal': AuthorizationRequestPrincipal;
1879
+ /**
1880
+ * Array of roles to check if the principal is in
1881
+ * @type {Array<string>}
1882
+ * @memberof IsInRoleRequest
1883
+ */
1884
+ 'roles': Array<IsInRoleRequestRolesEnum>;
1885
+ /**
1886
+ * How to check if the principal is in any/all of the roles
1887
+ * @type {string}
1888
+ * @memberof IsInRoleRequest
1889
+ */
1890
+ 'checkMode'?: IsInRoleRequestCheckModeEnum;
1891
+ }
1892
+ export declare const IsInRoleRequestRolesEnum: {
1893
+ readonly Admin: "Admin";
1894
+ readonly Factory: "Factory";
1895
+ };
1896
+ export type IsInRoleRequestRolesEnum = typeof IsInRoleRequestRolesEnum[keyof typeof IsInRoleRequestRolesEnum];
1897
+ export declare const IsInRoleRequestCheckModeEnum: {
1898
+ readonly Any: "any";
1899
+ readonly All: "all";
1900
+ };
1901
+ export type IsInRoleRequestCheckModeEnum = typeof IsInRoleRequestCheckModeEnum[keyof typeof IsInRoleRequestCheckModeEnum];
1902
+ /**
1903
+ * Response containing whether the principal is in any/all of the roles
1904
+ * @export
1905
+ * @interface IsInRoleResponse
1906
+ */
1907
+ export interface IsInRoleResponse {
1908
+ /**
1909
+ * result of the check - whether the principal is in any/all of the roles
1910
+ * @type {boolean}
1911
+ * @memberof IsInRoleResponse
1912
+ */
1913
+ 'authorized': boolean;
1914
+ }
1915
+ /**
1916
+ * Successful feature based roles retrieval response
1917
+ * @export
1918
+ * @interface ListFeatureBasedRolesSuccessResponse
1919
+ */
1920
+ export interface ListFeatureBasedRolesSuccessResponse {
1921
+ /**
1922
+ *
1923
+ * @type {Array<FeatureBasedRole>}
1924
+ * @memberof ListFeatureBasedRolesSuccessResponse
1925
+ */
1926
+ 'roles': Array<FeatureBasedRole>;
1927
+ }
1858
1928
  /**
1859
1929
  *
1860
1930
  * @export
@@ -1963,37 +2033,36 @@ export declare const ListOrgRolesSuccessResponseValueValueRolesEnum: {
1963
2033
  };
1964
2034
  export type ListOrgRolesSuccessResponseValueValueRolesEnum = typeof ListOrgRolesSuccessResponseValueValueRolesEnum[keyof typeof ListOrgRolesSuccessResponseValueValueRolesEnum];
1965
2035
  /**
1966
- *
2036
+ * Successful permissions retrieval response
1967
2037
  * @export
1968
- * @interface OrgPathParam
2038
+ * @interface ListPermissionsSuccessResponse
1969
2039
  */
1970
- export interface OrgPathParam {
2040
+ export interface ListPermissionsSuccessResponse {
1971
2041
  /**
1972
2042
  *
1973
- * @type {string}
1974
- * @memberof OrgPathParam
2043
+ * @type {Permissions & Array<string>}
2044
+ * @memberof ListPermissionsSuccessResponse
1975
2045
  */
1976
- 'orgId': string;
2046
+ 'permissions': Permissions & Array<string>;
1977
2047
  }
1978
2048
  /**
1979
- *
2049
+ * Successful roles retrieval response
1980
2050
  * @export
1981
- * @interface PathParams
2051
+ * @interface ListRolesSuccessResponse
1982
2052
  */
1983
- export interface PathParams {
1984
- /**
1985
- *
1986
- * @type {string}
1987
- * @memberof PathParams
1988
- */
1989
- 'orgId': string;
2053
+ export interface ListRolesSuccessResponse {
1990
2054
  /**
1991
- *
1992
- * @type {string}
1993
- * @memberof PathParams
2055
+ * List of named roles
2056
+ * @type {Array<string>}
2057
+ * @memberof ListRolesSuccessResponse
1994
2058
  */
1995
- 'userId': string;
2059
+ 'roles': Array<ListRolesSuccessResponseRolesEnum>;
1996
2060
  }
2061
+ export declare const ListRolesSuccessResponseRolesEnum: {
2062
+ readonly Admin: "Admin";
2063
+ readonly Factory: "Factory";
2064
+ };
2065
+ export type ListRolesSuccessResponseRolesEnum = typeof ListRolesSuccessResponseRolesEnum[keyof typeof ListRolesSuccessResponseRolesEnum];
1997
2066
  /**
1998
2067
  *
1999
2068
  * @export
@@ -2226,6 +2295,8 @@ export declare const Permissions: {
2226
2295
  readonly ViewOrg: "ViewOrg";
2227
2296
  readonly ViewWebhooks: "ViewWebhooks";
2228
2297
  readonly EditWebhooks: "EditWebhooks";
2298
+ readonly RoleAdmin: "RoleAdmin";
2299
+ readonly RoleFactory: "RoleFactory";
2229
2300
  };
2230
2301
  export type Permissions = typeof Permissions[keyof typeof Permissions];
2231
2302
  /**
@@ -2375,25 +2446,6 @@ export interface RevokeRoleSuccessResponse {
2375
2446
  */
2376
2447
  'message': string;
2377
2448
  }
2378
- /**
2379
- *
2380
- * @export
2381
- * @interface RolesInner
2382
- */
2383
- export interface RolesInner {
2384
- /**
2385
- * Name of the role
2386
- * @type {string}
2387
- * @memberof RolesInner
2388
- */
2389
- 'name': string;
2390
- /**
2391
- *
2392
- * @type {Permissions & Array<string>}
2393
- * @memberof RolesInner
2394
- */
2395
- 'permissions': Permissions & Array<string>;
2396
- }
2397
2449
  /**
2398
2450
  *
2399
2451
  * @export
@@ -2492,6 +2544,14 @@ export declare const AuthorizationApiAxiosParamCreator: (configuration?: Configu
2492
2544
  * @throws {RequiredError}
2493
2545
  */
2494
2546
  authenticateAndAuthorize: (authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2547
+ /**
2548
+ * Authenticate and check if a user is in any/all of the roles
2549
+ * @summary Authenticate and Check Is In Role
2550
+ * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
2551
+ * @param {*} [options] Override http request option.
2552
+ * @throws {RequiredError}
2553
+ */
2554
+ authenticateAndCheckIsInRole: (authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2495
2555
  /**
2496
2556
  * Check if a user is authorized to perform an action
2497
2557
  * @summary Authorize Request
@@ -2508,6 +2568,14 @@ export declare const AuthorizationApiAxiosParamCreator: (configuration?: Configu
2508
2568
  * @throws {RequiredError}
2509
2569
  */
2510
2570
  authorizeBatch: (authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2571
+ /**
2572
+ * Check if a user is in any/all of the roles
2573
+ * @summary Check Is In Role
2574
+ * @param {IsInRoleRequest} [isInRoleRequest]
2575
+ * @param {*} [options] Override http request option.
2576
+ * @throws {RequiredError}
2577
+ */
2578
+ checkIsInRole: (isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2511
2579
  };
2512
2580
  /**
2513
2581
  * AuthorizationApi - functional programming interface
@@ -2522,6 +2590,14 @@ export declare const AuthorizationApiFp: (configuration?: Configuration) => {
2522
2590
  * @throws {RequiredError}
2523
2591
  */
2524
2592
  authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>>;
2593
+ /**
2594
+ * Authenticate and check if a user is in any/all of the roles
2595
+ * @summary Authenticate and Check Is In Role
2596
+ * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
2597
+ * @param {*} [options] Override http request option.
2598
+ * @throws {RequiredError}
2599
+ */
2600
+ authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndCheckIsInRoleResponse>>;
2525
2601
  /**
2526
2602
  * Check if a user is authorized to perform an action
2527
2603
  * @summary Authorize Request
@@ -2538,6 +2614,14 @@ export declare const AuthorizationApiFp: (configuration?: Configuration) => {
2538
2614
  * @throws {RequiredError}
2539
2615
  */
2540
2616
  authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizationBatchResponse>>;
2617
+ /**
2618
+ * Check if a user is in any/all of the roles
2619
+ * @summary Check Is In Role
2620
+ * @param {IsInRoleRequest} [isInRoleRequest]
2621
+ * @param {*} [options] Override http request option.
2622
+ * @throws {RequiredError}
2623
+ */
2624
+ checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IsInRoleResponse>>;
2541
2625
  };
2542
2626
  /**
2543
2627
  * AuthorizationApi - factory interface
@@ -2552,6 +2636,14 @@ export declare const AuthorizationApiFactory: (configuration?: Configuration, ba
2552
2636
  * @throws {RequiredError}
2553
2637
  */
2554
2638
  authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse>;
2639
+ /**
2640
+ * Authenticate and check if a user is in any/all of the roles
2641
+ * @summary Authenticate and Check Is In Role
2642
+ * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
2643
+ * @param {*} [options] Override http request option.
2644
+ * @throws {RequiredError}
2645
+ */
2646
+ authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndCheckIsInRoleResponse>;
2555
2647
  /**
2556
2648
  * Check if a user is authorized to perform an action
2557
2649
  * @summary Authorize Request
@@ -2568,6 +2660,14 @@ export declare const AuthorizationApiFactory: (configuration?: Configuration, ba
2568
2660
  * @throws {RequiredError}
2569
2661
  */
2570
2662
  authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthorizationBatchResponse>;
2663
+ /**
2664
+ * Check if a user is in any/all of the roles
2665
+ * @summary Check Is In Role
2666
+ * @param {IsInRoleRequest} [isInRoleRequest]
2667
+ * @param {*} [options] Override http request option.
2668
+ * @throws {RequiredError}
2669
+ */
2670
+ checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<IsInRoleResponse>;
2571
2671
  };
2572
2672
  /**
2573
2673
  * AuthorizationApi - object-oriented interface
@@ -2585,6 +2685,15 @@ export declare class AuthorizationApi extends BaseAPI {
2585
2685
  * @memberof AuthorizationApi
2586
2686
  */
2587
2687
  authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndAuthorizeResponse, any, {}>>;
2688
+ /**
2689
+ * Authenticate and check if a user is in any/all of the roles
2690
+ * @summary Authenticate and Check Is In Role
2691
+ * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
2692
+ * @param {*} [options] Override http request option.
2693
+ * @throws {RequiredError}
2694
+ * @memberof AuthorizationApi
2695
+ */
2696
+ authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndCheckIsInRoleResponse, any, {}>>;
2588
2697
  /**
2589
2698
  * Check if a user is authorized to perform an action
2590
2699
  * @summary Authorize Request
@@ -2603,6 +2712,15 @@ export declare class AuthorizationApi extends BaseAPI {
2603
2712
  * @memberof AuthorizationApi
2604
2713
  */
2605
2714
  authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthorizationBatchResponse, any, {}>>;
2715
+ /**
2716
+ * Check if a user is in any/all of the roles
2717
+ * @summary Check Is In Role
2718
+ * @param {IsInRoleRequest} [isInRoleRequest]
2719
+ * @param {*} [options] Override http request option.
2720
+ * @throws {RequiredError}
2721
+ * @memberof AuthorizationApi
2722
+ */
2723
+ checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IsInRoleResponse, any, {}>>;
2606
2724
  }
2607
2725
  /**
2608
2726
  * AuthorizedEntitiesApi - axios parameter creator
@@ -2738,10 +2856,38 @@ export declare class AuthorizedEntitiesApi extends BaseAPI {
2738
2856
  getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAuthorizedPropertiesResponse, any, {}>>;
2739
2857
  }
2740
2858
  /**
2741
- * PermissionsApi - axios parameter creator
2859
+ * ConfigurationDataApi - axios parameter creator
2742
2860
  * @export
2743
2861
  */
2744
- export declare const PermissionsApiAxiosParamCreator: (configuration?: Configuration) => {
2862
+ export declare const ConfigurationDataApiAxiosParamCreator: (configuration?: Configuration) => {
2863
+ /**
2864
+ * List the available feature based roles
2865
+ * @summary List Feature Based Roles
2866
+ * @param {*} [options] Override http request option.
2867
+ * @throws {RequiredError}
2868
+ */
2869
+ configListFeatureBasedRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2870
+ /**
2871
+ * List the available permissions
2872
+ * @summary List Permissions
2873
+ * @param {*} [options] Override http request option.
2874
+ * @throws {RequiredError}
2875
+ */
2876
+ configListPermissions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2877
+ /**
2878
+ * List the available roles
2879
+ * @summary List Roles
2880
+ * @param {*} [options] Override http request option.
2881
+ * @throws {RequiredError}
2882
+ */
2883
+ configListRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2884
+ /**
2885
+ * List the available feature based roles
2886
+ * @summary List Feature Based Roles
2887
+ * @param {*} [options] Override http request option.
2888
+ * @throws {RequiredError}
2889
+ */
2890
+ listFeatureBasedRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2745
2891
  /**
2746
2892
  * List the available permissions
2747
2893
  * @summary List Permissions
@@ -2749,48 +2895,165 @@ export declare const PermissionsApiAxiosParamCreator: (configuration?: Configura
2749
2895
  * @throws {RequiredError}
2750
2896
  */
2751
2897
  listPermissions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2898
+ /**
2899
+ * List the available roles
2900
+ * @summary List Roles
2901
+ * @param {*} [options] Override http request option.
2902
+ * @throws {RequiredError}
2903
+ */
2904
+ listRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2752
2905
  };
2753
2906
  /**
2754
- * PermissionsApi - functional programming interface
2907
+ * ConfigurationDataApi - functional programming interface
2755
2908
  * @export
2756
2909
  */
2757
- export declare const PermissionsApiFp: (configuration?: Configuration) => {
2910
+ export declare const ConfigurationDataApiFp: (configuration?: Configuration) => {
2911
+ /**
2912
+ * List the available feature based roles
2913
+ * @summary List Feature Based Roles
2914
+ * @param {*} [options] Override http request option.
2915
+ * @throws {RequiredError}
2916
+ */
2917
+ configListFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFeatureBasedRolesSuccessResponse>>;
2758
2918
  /**
2759
2919
  * List the available permissions
2760
2920
  * @summary List Permissions
2761
2921
  * @param {*} [options] Override http request option.
2762
2922
  * @throws {RequiredError}
2763
2923
  */
2764
- listPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPermissionsSuccessResponse>>;
2924
+ configListPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPermissionsSuccessResponse>>;
2925
+ /**
2926
+ * List the available roles
2927
+ * @summary List Roles
2928
+ * @param {*} [options] Override http request option.
2929
+ * @throws {RequiredError}
2930
+ */
2931
+ configListRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesSuccessResponse>>;
2932
+ /**
2933
+ * List the available feature based roles
2934
+ * @summary List Feature Based Roles
2935
+ * @param {*} [options] Override http request option.
2936
+ * @throws {RequiredError}
2937
+ */
2938
+ listFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFeatureBasedRolesSuccessResponse>>;
2939
+ /**
2940
+ * List the available permissions
2941
+ * @summary List Permissions
2942
+ * @param {*} [options] Override http request option.
2943
+ * @throws {RequiredError}
2944
+ */
2945
+ listPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPermissionsSuccessResponse>>;
2946
+ /**
2947
+ * List the available roles
2948
+ * @summary List Roles
2949
+ * @param {*} [options] Override http request option.
2950
+ * @throws {RequiredError}
2951
+ */
2952
+ listRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesSuccessResponse>>;
2765
2953
  };
2766
2954
  /**
2767
- * PermissionsApi - factory interface
2955
+ * ConfigurationDataApi - factory interface
2768
2956
  * @export
2769
2957
  */
2770
- export declare const PermissionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2958
+ export declare const ConfigurationDataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2959
+ /**
2960
+ * List the available feature based roles
2961
+ * @summary List Feature Based Roles
2962
+ * @param {*} [options] Override http request option.
2963
+ * @throws {RequiredError}
2964
+ */
2965
+ configListFeatureBasedRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListFeatureBasedRolesSuccessResponse>;
2771
2966
  /**
2772
2967
  * List the available permissions
2773
2968
  * @summary List Permissions
2774
2969
  * @param {*} [options] Override http request option.
2775
2970
  * @throws {RequiredError}
2776
2971
  */
2777
- listPermissions(options?: RawAxiosRequestConfig): AxiosPromise<GetPermissionsSuccessResponse>;
2972
+ configListPermissions(options?: RawAxiosRequestConfig): AxiosPromise<ListPermissionsSuccessResponse>;
2973
+ /**
2974
+ * List the available roles
2975
+ * @summary List Roles
2976
+ * @param {*} [options] Override http request option.
2977
+ * @throws {RequiredError}
2978
+ */
2979
+ configListRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListRolesSuccessResponse>;
2980
+ /**
2981
+ * List the available feature based roles
2982
+ * @summary List Feature Based Roles
2983
+ * @param {*} [options] Override http request option.
2984
+ * @throws {RequiredError}
2985
+ */
2986
+ listFeatureBasedRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListFeatureBasedRolesSuccessResponse>;
2987
+ /**
2988
+ * List the available permissions
2989
+ * @summary List Permissions
2990
+ * @param {*} [options] Override http request option.
2991
+ * @throws {RequiredError}
2992
+ */
2993
+ listPermissions(options?: RawAxiosRequestConfig): AxiosPromise<ListPermissionsSuccessResponse>;
2994
+ /**
2995
+ * List the available roles
2996
+ * @summary List Roles
2997
+ * @param {*} [options] Override http request option.
2998
+ * @throws {RequiredError}
2999
+ */
3000
+ listRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListRolesSuccessResponse>;
2778
3001
  };
2779
3002
  /**
2780
- * PermissionsApi - object-oriented interface
3003
+ * ConfigurationDataApi - object-oriented interface
2781
3004
  * @export
2782
- * @class PermissionsApi
3005
+ * @class ConfigurationDataApi
2783
3006
  * @extends {BaseAPI}
2784
3007
  */
2785
- export declare class PermissionsApi extends BaseAPI {
3008
+ export declare class ConfigurationDataApi extends BaseAPI {
3009
+ /**
3010
+ * List the available feature based roles
3011
+ * @summary List Feature Based Roles
3012
+ * @param {*} [options] Override http request option.
3013
+ * @throws {RequiredError}
3014
+ * @memberof ConfigurationDataApi
3015
+ */
3016
+ configListFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFeatureBasedRolesSuccessResponse, any, {}>>;
3017
+ /**
3018
+ * List the available permissions
3019
+ * @summary List Permissions
3020
+ * @param {*} [options] Override http request option.
3021
+ * @throws {RequiredError}
3022
+ * @memberof ConfigurationDataApi
3023
+ */
3024
+ configListPermissions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPermissionsSuccessResponse, any, {}>>;
3025
+ /**
3026
+ * List the available roles
3027
+ * @summary List Roles
3028
+ * @param {*} [options] Override http request option.
3029
+ * @throws {RequiredError}
3030
+ * @memberof ConfigurationDataApi
3031
+ */
3032
+ configListRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRolesSuccessResponse, any, {}>>;
3033
+ /**
3034
+ * List the available feature based roles
3035
+ * @summary List Feature Based Roles
3036
+ * @param {*} [options] Override http request option.
3037
+ * @throws {RequiredError}
3038
+ * @memberof ConfigurationDataApi
3039
+ */
3040
+ listFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFeatureBasedRolesSuccessResponse, any, {}>>;
2786
3041
  /**
2787
3042
  * List the available permissions
2788
3043
  * @summary List Permissions
2789
3044
  * @param {*} [options] Override http request option.
2790
3045
  * @throws {RequiredError}
2791
- * @memberof PermissionsApi
3046
+ * @memberof ConfigurationDataApi
3047
+ */
3048
+ listPermissions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPermissionsSuccessResponse, any, {}>>;
3049
+ /**
3050
+ * List the available roles
3051
+ * @summary List Roles
3052
+ * @param {*} [options] Override http request option.
3053
+ * @throws {RequiredError}
3054
+ * @memberof ConfigurationDataApi
2792
3055
  */
2793
- listPermissions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPermissionsSuccessResponse, any, {}>>;
3056
+ listRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRolesSuccessResponse, any, {}>>;
2794
3057
  }
2795
3058
  /**
2796
3059
  * RoleAssignmentApi - axios parameter creator