@flipdish/authorization 0.0.5-rc.1756734017 → 0.0.5-rc.1766099001
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 +218 -103
- package/api.ts +1894 -561
- package/configuration.ts +1 -1
- package/dist/api.d.ts +1248 -482
- package/dist/api.js +1572 -423
- package/dist/configuration.js +1 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -20,7 +20,7 @@ import { BaseAPI } from './base';
|
|
|
20
20
|
*/
|
|
21
21
|
export interface AssignRoleRequestBody {
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
*
|
|
24
24
|
* @type {string}
|
|
25
25
|
* @memberof AssignRoleRequestBody
|
|
26
26
|
*/
|
|
@@ -37,6 +37,12 @@ export interface AssignRoleRequestBody {
|
|
|
37
37
|
* @memberof AssignRoleRequestBody
|
|
38
38
|
*/
|
|
39
39
|
'principal': AuthorizationRequestPrincipal;
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof AssignRoleRequestBody
|
|
44
|
+
*/
|
|
45
|
+
'brandId': string;
|
|
40
46
|
}
|
|
41
47
|
export declare const AssignRoleRequestBodyRoleEnum: {
|
|
42
48
|
readonly OrgViewer: "OrgViewer";
|
|
@@ -134,11 +140,11 @@ export interface AssignRoleSuccessResponse {
|
|
|
134
140
|
export interface AuthenticateAndAuthorizeRequest {
|
|
135
141
|
/**
|
|
136
142
|
* Incoming request headers to be used for authentication
|
|
137
|
-
* @type {{ [key: string]:
|
|
143
|
+
* @type {{ [key: string]: string; }}
|
|
138
144
|
* @memberof AuthenticateAndAuthorizeRequest
|
|
139
145
|
*/
|
|
140
146
|
'headers': {
|
|
141
|
-
[key: string]:
|
|
147
|
+
[key: string]: string;
|
|
142
148
|
};
|
|
143
149
|
/**
|
|
144
150
|
*
|
|
@@ -152,7 +158,18 @@ export interface AuthenticateAndAuthorizeRequest {
|
|
|
152
158
|
* @memberof AuthenticateAndAuthorizeRequest
|
|
153
159
|
*/
|
|
154
160
|
'resource'?: AuthorizationRequestResource;
|
|
161
|
+
/**
|
|
162
|
+
* How to check authorisation - any or all of the actions must be allowed
|
|
163
|
+
* @type {string}
|
|
164
|
+
* @memberof AuthenticateAndAuthorizeRequest
|
|
165
|
+
*/
|
|
166
|
+
'checkMode'?: AuthenticateAndAuthorizeRequestCheckModeEnum;
|
|
155
167
|
}
|
|
168
|
+
export declare const AuthenticateAndAuthorizeRequestCheckModeEnum: {
|
|
169
|
+
readonly Any: "any";
|
|
170
|
+
readonly All: "all";
|
|
171
|
+
};
|
|
172
|
+
export type AuthenticateAndAuthorizeRequestCheckModeEnum = typeof AuthenticateAndAuthorizeRequestCheckModeEnum[keyof typeof AuthenticateAndAuthorizeRequestCheckModeEnum];
|
|
156
173
|
/**
|
|
157
174
|
* Response containing the authentication and authorization decision
|
|
158
175
|
* @export
|
|
@@ -161,10 +178,10 @@ export interface AuthenticateAndAuthorizeRequest {
|
|
|
161
178
|
export interface AuthenticateAndAuthorizeResponse {
|
|
162
179
|
/**
|
|
163
180
|
*
|
|
164
|
-
* @type {
|
|
181
|
+
* @type {AuthenticateAndCheckIsInRoleResponseAuthentication}
|
|
165
182
|
* @memberof AuthenticateAndAuthorizeResponse
|
|
166
183
|
*/
|
|
167
|
-
'authentication':
|
|
184
|
+
'authentication': AuthenticateAndCheckIsInRoleResponseAuthentication;
|
|
168
185
|
/**
|
|
169
186
|
*
|
|
170
187
|
* @type {AuthorizationResponse}
|
|
@@ -175,30 +192,162 @@ export interface AuthenticateAndAuthorizeResponse {
|
|
|
175
192
|
/**
|
|
176
193
|
*
|
|
177
194
|
* @export
|
|
178
|
-
* @interface
|
|
195
|
+
* @interface AuthenticateAndCheckIsInRoleRequest
|
|
196
|
+
*/
|
|
197
|
+
export interface AuthenticateAndCheckIsInRoleRequest {
|
|
198
|
+
/**
|
|
199
|
+
* Incoming request headers to be used for authentication
|
|
200
|
+
* @type {{ [key: string]: string; }}
|
|
201
|
+
* @memberof AuthenticateAndCheckIsInRoleRequest
|
|
202
|
+
*/
|
|
203
|
+
'headers': {
|
|
204
|
+
[key: string]: string;
|
|
205
|
+
};
|
|
206
|
+
/**
|
|
207
|
+
* Array of roles to check if the principal is in
|
|
208
|
+
* @type {Array<RoleNames>}
|
|
209
|
+
* @memberof AuthenticateAndCheckIsInRoleRequest
|
|
210
|
+
*/
|
|
211
|
+
'roles': Array<RoleNames>;
|
|
212
|
+
/**
|
|
213
|
+
*
|
|
214
|
+
* @type {string}
|
|
215
|
+
* @memberof AuthenticateAndCheckIsInRoleRequest
|
|
216
|
+
*/
|
|
217
|
+
'checkMode'?: AuthenticateAndCheckIsInRoleRequestCheckModeEnum;
|
|
218
|
+
}
|
|
219
|
+
export declare const AuthenticateAndCheckIsInRoleRequestCheckModeEnum: {
|
|
220
|
+
readonly Any: "any";
|
|
221
|
+
readonly All: "all";
|
|
222
|
+
};
|
|
223
|
+
export type AuthenticateAndCheckIsInRoleRequestCheckModeEnum = typeof AuthenticateAndCheckIsInRoleRequestCheckModeEnum[keyof typeof AuthenticateAndCheckIsInRoleRequestCheckModeEnum];
|
|
224
|
+
/**
|
|
225
|
+
* Response containing whether the principal is in any/all of the roles
|
|
226
|
+
* @export
|
|
227
|
+
* @interface AuthenticateAndCheckIsInRoleResponse
|
|
228
|
+
*/
|
|
229
|
+
export interface AuthenticateAndCheckIsInRoleResponse {
|
|
230
|
+
/**
|
|
231
|
+
*
|
|
232
|
+
* @type {AuthenticateAndCheckIsInRoleResponseAuthentication}
|
|
233
|
+
* @memberof AuthenticateAndCheckIsInRoleResponse
|
|
234
|
+
*/
|
|
235
|
+
'authentication': AuthenticateAndCheckIsInRoleResponseAuthentication;
|
|
236
|
+
/**
|
|
237
|
+
* result of the check - whether the principal is in any/all of the roles
|
|
238
|
+
* @type {boolean}
|
|
239
|
+
* @memberof AuthenticateAndCheckIsInRoleResponse
|
|
240
|
+
*/
|
|
241
|
+
'authorized': boolean;
|
|
242
|
+
}
|
|
243
|
+
/**
|
|
244
|
+
*
|
|
245
|
+
* @export
|
|
246
|
+
* @interface AuthenticateAndCheckIsInRoleResponseAuthentication
|
|
179
247
|
*/
|
|
180
|
-
export interface
|
|
248
|
+
export interface AuthenticateAndCheckIsInRoleResponseAuthentication {
|
|
181
249
|
/**
|
|
182
250
|
*
|
|
183
251
|
* @type {AuthorizationRequestPrincipal}
|
|
184
|
-
* @memberof
|
|
252
|
+
* @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
|
|
185
253
|
*/
|
|
186
254
|
'principal': AuthorizationRequestPrincipal;
|
|
187
255
|
/**
|
|
188
256
|
* Whether the user is authenticated
|
|
189
257
|
* @type {boolean}
|
|
190
|
-
* @memberof
|
|
258
|
+
* @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
|
|
191
259
|
*/
|
|
192
260
|
'authenticated': boolean;
|
|
193
261
|
/**
|
|
194
262
|
* The reason for the authentication failure
|
|
195
263
|
* @type {string}
|
|
196
|
-
* @memberof
|
|
264
|
+
* @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
|
|
197
265
|
*/
|
|
198
266
|
'reason'?: string;
|
|
199
267
|
}
|
|
200
268
|
/**
|
|
201
|
-
*
|
|
269
|
+
*
|
|
270
|
+
* @export
|
|
271
|
+
* @interface AuthorizationBatchRequest
|
|
272
|
+
*/
|
|
273
|
+
export interface AuthorizationBatchRequest {
|
|
274
|
+
/**
|
|
275
|
+
*
|
|
276
|
+
* @type {AuthorizationRequestPrincipal}
|
|
277
|
+
* @memberof AuthorizationBatchRequest
|
|
278
|
+
*/
|
|
279
|
+
'principal': AuthorizationRequestPrincipal;
|
|
280
|
+
/**
|
|
281
|
+
*
|
|
282
|
+
* @type {Permissions}
|
|
283
|
+
* @memberof AuthorizationBatchRequest
|
|
284
|
+
*/
|
|
285
|
+
'action': Permissions;
|
|
286
|
+
/**
|
|
287
|
+
* Array of resources to check authorisation for
|
|
288
|
+
* @type {Array<AuthorizationRequestResource>}
|
|
289
|
+
* @memberof AuthorizationBatchRequest
|
|
290
|
+
*/
|
|
291
|
+
'resources': Array<AuthorizationRequestResource>;
|
|
292
|
+
}
|
|
293
|
+
/**
|
|
294
|
+
*
|
|
295
|
+
* @export
|
|
296
|
+
* @interface AuthorizationBatchResponse
|
|
297
|
+
*/
|
|
298
|
+
export interface AuthorizationBatchResponse {
|
|
299
|
+
/**
|
|
300
|
+
* Array of allowed resources
|
|
301
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
302
|
+
* @memberof AuthorizationBatchResponse
|
|
303
|
+
*/
|
|
304
|
+
'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
305
|
+
/**
|
|
306
|
+
* Array of denied resources
|
|
307
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
308
|
+
* @memberof AuthorizationBatchResponse
|
|
309
|
+
*/
|
|
310
|
+
'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
311
|
+
}
|
|
312
|
+
/**
|
|
313
|
+
*
|
|
314
|
+
* @export
|
|
315
|
+
* @interface AuthorizationBatchResponseAllowedResourcesInner
|
|
316
|
+
*/
|
|
317
|
+
export interface AuthorizationBatchResponseAllowedResourcesInner {
|
|
318
|
+
/**
|
|
319
|
+
* The authorization decision
|
|
320
|
+
* @type {string}
|
|
321
|
+
* @memberof AuthorizationBatchResponseAllowedResourcesInner
|
|
322
|
+
*/
|
|
323
|
+
'decision': string;
|
|
324
|
+
/**
|
|
325
|
+
* Whether the action is allowed
|
|
326
|
+
* @type {boolean}
|
|
327
|
+
* @memberof AuthorizationBatchResponseAllowedResourcesInner
|
|
328
|
+
*/
|
|
329
|
+
'allowed': boolean;
|
|
330
|
+
/**
|
|
331
|
+
* The policy IDs that were used to make the decision
|
|
332
|
+
* @type {Array<string>}
|
|
333
|
+
* @memberof AuthorizationBatchResponseAllowedResourcesInner
|
|
334
|
+
*/
|
|
335
|
+
'policyIds': Array<string>;
|
|
336
|
+
/**
|
|
337
|
+
*
|
|
338
|
+
* @type {AuthorizationBatchResponseAllowedResourcesInnerResource}
|
|
339
|
+
* @memberof AuthorizationBatchResponseAllowedResourcesInner
|
|
340
|
+
*/
|
|
341
|
+
'resource': AuthorizationBatchResponseAllowedResourcesInnerResource;
|
|
342
|
+
}
|
|
343
|
+
/**
|
|
344
|
+
* @type AuthorizationBatchResponseAllowedResourcesInnerResource
|
|
345
|
+
* Resource that the action was checked for
|
|
346
|
+
* @export
|
|
347
|
+
*/
|
|
348
|
+
export type AuthorizationBatchResponseAllowedResourcesInnerResource = AuthorizationRequestResourceOneOf | AuthorizationRequestResourceOneOf1 | AuthorizationRequestResourceOneOf2 | AuthorizationRequestResourceOneOf3;
|
|
349
|
+
/**
|
|
350
|
+
* 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 the checkMode - any or all of the permissions must be allowed).
|
|
202
351
|
* @export
|
|
203
352
|
* @interface AuthorizationRequest
|
|
204
353
|
*/
|
|
@@ -221,9 +370,20 @@ export interface AuthorizationRequest {
|
|
|
221
370
|
* @memberof AuthorizationRequest
|
|
222
371
|
*/
|
|
223
372
|
'resource'?: AuthorizationRequestResource;
|
|
373
|
+
/**
|
|
374
|
+
* How to check authorisation - any or all of the actions must be allowed
|
|
375
|
+
* @type {string}
|
|
376
|
+
* @memberof AuthorizationRequest
|
|
377
|
+
*/
|
|
378
|
+
'checkMode'?: AuthorizationRequestCheckModeEnum;
|
|
224
379
|
}
|
|
380
|
+
export declare const AuthorizationRequestCheckModeEnum: {
|
|
381
|
+
readonly Any: "any";
|
|
382
|
+
readonly All: "all";
|
|
383
|
+
};
|
|
384
|
+
export type AuthorizationRequestCheckModeEnum = typeof AuthorizationRequestCheckModeEnum[keyof typeof AuthorizationRequestCheckModeEnum];
|
|
225
385
|
/**
|
|
226
|
-
*
|
|
386
|
+
* Permission or array of permissions - note that you still only receive a single allow / deny response (calculated based on the checkMode)
|
|
227
387
|
* @export
|
|
228
388
|
* @interface AuthorizationRequestAction
|
|
229
389
|
*/
|
|
@@ -407,17 +567,203 @@ export interface ErrorResponse {
|
|
|
407
567
|
'message': string;
|
|
408
568
|
}
|
|
409
569
|
/**
|
|
410
|
-
*
|
|
570
|
+
* Feature based role and its permissions
|
|
571
|
+
* @export
|
|
572
|
+
* @interface FeatureBasedRole
|
|
573
|
+
*/
|
|
574
|
+
export interface FeatureBasedRole {
|
|
575
|
+
/**
|
|
576
|
+
* Name of the role
|
|
577
|
+
* @type {string}
|
|
578
|
+
* @memberof FeatureBasedRole
|
|
579
|
+
*/
|
|
580
|
+
'name': string;
|
|
581
|
+
/**
|
|
582
|
+
*
|
|
583
|
+
* @type {Permissions & Array<Permissions>}
|
|
584
|
+
* @memberof FeatureBasedRole
|
|
585
|
+
*/
|
|
586
|
+
'permissions': Permissions & Array<Permissions>;
|
|
587
|
+
}
|
|
588
|
+
/**
|
|
589
|
+
* 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.
|
|
590
|
+
* @export
|
|
591
|
+
* @interface GetAuthorizedBrandsRequest
|
|
592
|
+
*/
|
|
593
|
+
export interface GetAuthorizedBrandsRequest {
|
|
594
|
+
/**
|
|
595
|
+
*
|
|
596
|
+
* @type {GetAuthorizedOrgsRequestPrincipal}
|
|
597
|
+
* @memberof GetAuthorizedBrandsRequest
|
|
598
|
+
*/
|
|
599
|
+
'principal'?: GetAuthorizedOrgsRequestPrincipal;
|
|
600
|
+
/**
|
|
601
|
+
* Incoming request headers to be used for authentication
|
|
602
|
+
* @type {{ [key: string]: string; }}
|
|
603
|
+
* @memberof GetAuthorizedBrandsRequest
|
|
604
|
+
*/
|
|
605
|
+
'headers'?: {
|
|
606
|
+
[key: string]: string;
|
|
607
|
+
};
|
|
608
|
+
/**
|
|
609
|
+
*
|
|
610
|
+
* @type {Permissions}
|
|
611
|
+
* @memberof GetAuthorizedBrandsRequest
|
|
612
|
+
*/
|
|
613
|
+
'action': Permissions;
|
|
614
|
+
}
|
|
615
|
+
/**
|
|
616
|
+
* Response containing the authorized brands
|
|
617
|
+
* @export
|
|
618
|
+
* @interface GetAuthorizedBrandsResponse
|
|
619
|
+
*/
|
|
620
|
+
export interface GetAuthorizedBrandsResponse {
|
|
621
|
+
/**
|
|
622
|
+
* Array of allowed resources
|
|
623
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
624
|
+
* @memberof GetAuthorizedBrandsResponse
|
|
625
|
+
*/
|
|
626
|
+
'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
627
|
+
/**
|
|
628
|
+
* Array of denied resources
|
|
629
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
630
|
+
* @memberof GetAuthorizedBrandsResponse
|
|
631
|
+
*/
|
|
632
|
+
'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
633
|
+
}
|
|
634
|
+
/**
|
|
635
|
+
* Request to get authorized orgs 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.
|
|
636
|
+
* @export
|
|
637
|
+
* @interface GetAuthorizedOrgsRequest
|
|
638
|
+
*/
|
|
639
|
+
export interface GetAuthorizedOrgsRequest {
|
|
640
|
+
/**
|
|
641
|
+
*
|
|
642
|
+
* @type {GetAuthorizedOrgsRequestPrincipal}
|
|
643
|
+
* @memberof GetAuthorizedOrgsRequest
|
|
644
|
+
*/
|
|
645
|
+
'principal'?: GetAuthorizedOrgsRequestPrincipal;
|
|
646
|
+
/**
|
|
647
|
+
* Incoming request headers to be used for authentication
|
|
648
|
+
* @type {{ [key: string]: string; }}
|
|
649
|
+
* @memberof GetAuthorizedOrgsRequest
|
|
650
|
+
*/
|
|
651
|
+
'headers'?: {
|
|
652
|
+
[key: string]: string;
|
|
653
|
+
};
|
|
654
|
+
/**
|
|
655
|
+
*
|
|
656
|
+
* @type {Permissions}
|
|
657
|
+
* @memberof GetAuthorizedOrgsRequest
|
|
658
|
+
*/
|
|
659
|
+
'action': Permissions;
|
|
660
|
+
}
|
|
661
|
+
/**
|
|
662
|
+
* The principal to get authorized entities for
|
|
663
|
+
* @export
|
|
664
|
+
* @interface GetAuthorizedOrgsRequestPrincipal
|
|
665
|
+
*/
|
|
666
|
+
export interface GetAuthorizedOrgsRequestPrincipal {
|
|
667
|
+
/**
|
|
668
|
+
*
|
|
669
|
+
* @type {string}
|
|
670
|
+
* @memberof GetAuthorizedOrgsRequestPrincipal
|
|
671
|
+
*/
|
|
672
|
+
'type': GetAuthorizedOrgsRequestPrincipalTypeEnum;
|
|
673
|
+
/**
|
|
674
|
+
*
|
|
675
|
+
* @type {string}
|
|
676
|
+
* @memberof GetAuthorizedOrgsRequestPrincipal
|
|
677
|
+
*/
|
|
678
|
+
'id': string;
|
|
679
|
+
/**
|
|
680
|
+
*
|
|
681
|
+
* @type {string}
|
|
682
|
+
* @memberof GetAuthorizedOrgsRequestPrincipal
|
|
683
|
+
*/
|
|
684
|
+
'name'?: string;
|
|
685
|
+
/**
|
|
686
|
+
*
|
|
687
|
+
* @type {string}
|
|
688
|
+
* @memberof GetAuthorizedOrgsRequestPrincipal
|
|
689
|
+
*/
|
|
690
|
+
'email'?: string;
|
|
691
|
+
/**
|
|
692
|
+
*
|
|
693
|
+
* @type {string}
|
|
694
|
+
* @memberof GetAuthorizedOrgsRequestPrincipal
|
|
695
|
+
*/
|
|
696
|
+
'phone'?: string;
|
|
697
|
+
}
|
|
698
|
+
export declare const GetAuthorizedOrgsRequestPrincipalTypeEnum: {
|
|
699
|
+
readonly User: "User";
|
|
700
|
+
readonly Automation: "Automation";
|
|
701
|
+
};
|
|
702
|
+
export type GetAuthorizedOrgsRequestPrincipalTypeEnum = typeof GetAuthorizedOrgsRequestPrincipalTypeEnum[keyof typeof GetAuthorizedOrgsRequestPrincipalTypeEnum];
|
|
703
|
+
/**
|
|
704
|
+
* Response containing the authorized orgs
|
|
411
705
|
* @export
|
|
412
|
-
* @interface
|
|
706
|
+
* @interface GetAuthorizedOrgsResponse
|
|
413
707
|
*/
|
|
414
|
-
export interface
|
|
708
|
+
export interface GetAuthorizedOrgsResponse {
|
|
709
|
+
/**
|
|
710
|
+
* Array of allowed resources
|
|
711
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
712
|
+
* @memberof GetAuthorizedOrgsResponse
|
|
713
|
+
*/
|
|
714
|
+
'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
715
|
+
/**
|
|
716
|
+
* Array of denied resources
|
|
717
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
718
|
+
* @memberof GetAuthorizedOrgsResponse
|
|
719
|
+
*/
|
|
720
|
+
'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
721
|
+
}
|
|
722
|
+
/**
|
|
723
|
+
* Request to get authorized properties 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.
|
|
724
|
+
* @export
|
|
725
|
+
* @interface GetAuthorizedPropertiesRequest
|
|
726
|
+
*/
|
|
727
|
+
export interface GetAuthorizedPropertiesRequest {
|
|
415
728
|
/**
|
|
416
729
|
*
|
|
417
|
-
* @type {
|
|
418
|
-
* @memberof
|
|
730
|
+
* @type {GetAuthorizedOrgsRequestPrincipal}
|
|
731
|
+
* @memberof GetAuthorizedPropertiesRequest
|
|
732
|
+
*/
|
|
733
|
+
'principal'?: GetAuthorizedOrgsRequestPrincipal;
|
|
734
|
+
/**
|
|
735
|
+
* Incoming request headers to be used for authentication
|
|
736
|
+
* @type {{ [key: string]: string; }}
|
|
737
|
+
* @memberof GetAuthorizedPropertiesRequest
|
|
738
|
+
*/
|
|
739
|
+
'headers'?: {
|
|
740
|
+
[key: string]: string;
|
|
741
|
+
};
|
|
742
|
+
/**
|
|
743
|
+
*
|
|
744
|
+
* @type {Permissions}
|
|
745
|
+
* @memberof GetAuthorizedPropertiesRequest
|
|
746
|
+
*/
|
|
747
|
+
'action': Permissions;
|
|
748
|
+
}
|
|
749
|
+
/**
|
|
750
|
+
* Response containing the authorized properties
|
|
751
|
+
* @export
|
|
752
|
+
* @interface GetAuthorizedPropertiesResponse
|
|
753
|
+
*/
|
|
754
|
+
export interface GetAuthorizedPropertiesResponse {
|
|
755
|
+
/**
|
|
756
|
+
* Array of allowed resources
|
|
757
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
758
|
+
* @memberof GetAuthorizedPropertiesResponse
|
|
759
|
+
*/
|
|
760
|
+
'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
761
|
+
/**
|
|
762
|
+
* Array of denied resources
|
|
763
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
764
|
+
* @memberof GetAuthorizedPropertiesResponse
|
|
419
765
|
*/
|
|
420
|
-
'
|
|
766
|
+
'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
421
767
|
}
|
|
422
768
|
/**
|
|
423
769
|
* Details for getting roles for a principal
|
|
@@ -464,11 +810,17 @@ export interface GetPrincipalRolesSuccessResponseRolesInner {
|
|
|
464
810
|
*/
|
|
465
811
|
'policyId': string;
|
|
466
812
|
/**
|
|
467
|
-
*
|
|
813
|
+
*
|
|
814
|
+
* @type {GetPrincipalRolesSuccessResponseRolesInnerRoleName}
|
|
815
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
816
|
+
*/
|
|
817
|
+
'roleName': GetPrincipalRolesSuccessResponseRolesInnerRoleName;
|
|
818
|
+
/**
|
|
819
|
+
* Policy type
|
|
468
820
|
* @type {string}
|
|
469
821
|
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
470
822
|
*/
|
|
471
|
-
'
|
|
823
|
+
'policyType': GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum;
|
|
472
824
|
/**
|
|
473
825
|
* Date and time the role was assigned
|
|
474
826
|
* @type {string}
|
|
@@ -486,7 +838,7 @@ export interface GetPrincipalRolesSuccessResponseRolesInner {
|
|
|
486
838
|
* @type {string}
|
|
487
839
|
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
488
840
|
*/
|
|
489
|
-
'resourceType'
|
|
841
|
+
'resourceType'?: GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum;
|
|
490
842
|
/**
|
|
491
843
|
* Organization ID
|
|
492
844
|
* @type {string}
|
|
@@ -511,82 +863,27 @@ export interface GetPrincipalRolesSuccessResponseRolesInner {
|
|
|
511
863
|
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
512
864
|
*/
|
|
513
865
|
'salesChannelId'?: string;
|
|
866
|
+
/**
|
|
867
|
+
* Principal ID this role is assigned to
|
|
868
|
+
* @type {string}
|
|
869
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
870
|
+
*/
|
|
871
|
+
'principalId': string;
|
|
872
|
+
/**
|
|
873
|
+
* Type of principal this role is assigned to
|
|
874
|
+
* @type {string}
|
|
875
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
876
|
+
*/
|
|
877
|
+
'principalType': GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum;
|
|
514
878
|
}
|
|
515
|
-
export declare const
|
|
516
|
-
readonly
|
|
517
|
-
readonly
|
|
518
|
-
readonly
|
|
519
|
-
readonly
|
|
520
|
-
readonly
|
|
521
|
-
readonly BrandAdmin: "BrandAdmin";
|
|
522
|
-
readonly StoreViewer: "StoreViewer";
|
|
523
|
-
readonly StoreEditor: "StoreEditor";
|
|
524
|
-
readonly StoreManager: "StoreManager";
|
|
525
|
-
readonly CustomerViewer: "CustomerViewer";
|
|
526
|
-
readonly CustomerManager: "CustomerManager";
|
|
527
|
-
readonly VoucherViewer: "VoucherViewer";
|
|
528
|
-
readonly VoucherEditor: "VoucherEditor";
|
|
529
|
-
readonly VoucherManager: "VoucherManager";
|
|
530
|
-
readonly VoucherCampaignManager: "VoucherCampaignManager";
|
|
531
|
-
readonly VoucherStatisticsViewer: "VoucherStatisticsViewer";
|
|
532
|
-
readonly AnalyticsViewer: "AnalyticsViewer";
|
|
533
|
-
readonly ReportsViewer: "ReportsViewer";
|
|
534
|
-
readonly FinanceViewer: "FinanceViewer";
|
|
535
|
-
readonly FinanceManager: "FinanceManager";
|
|
536
|
-
readonly TeamViewer: "TeamViewer";
|
|
537
|
-
readonly TeamManager: "TeamManager";
|
|
538
|
-
readonly TeamAdmin: "TeamAdmin";
|
|
539
|
-
readonly TechViewer: "TechViewer";
|
|
540
|
-
readonly TechManager: "TechManager";
|
|
541
|
-
readonly AppStoreViewer: "AppStoreViewer";
|
|
542
|
-
readonly AppStoreManager: "AppStoreManager";
|
|
543
|
-
readonly SalesChannelViewer: "SalesChannelViewer";
|
|
544
|
-
readonly SalesChannelEditor: "SalesChannelEditor";
|
|
545
|
-
readonly SalesChannelManager: "SalesChannelManager";
|
|
546
|
-
readonly DeliveryViewer: "DeliveryViewer";
|
|
547
|
-
readonly DeliveryManager: "DeliveryManager";
|
|
548
|
-
readonly DriverManager: "DriverManager";
|
|
549
|
-
readonly AuditViewer: "AuditViewer";
|
|
550
|
-
readonly AuditManager: "AuditManager";
|
|
551
|
-
readonly AccountsViewer: "AccountsViewer";
|
|
552
|
-
readonly AccountsEditor: "AccountsEditor";
|
|
553
|
-
readonly DocumentExplorerViewer: "DocumentExplorerViewer";
|
|
554
|
-
readonly DocumentExplorerEditor: "DocumentExplorerEditor";
|
|
555
|
-
readonly PayrollViewer: "PayrollViewer";
|
|
556
|
-
readonly PayrollEditor: "PayrollEditor";
|
|
557
|
-
readonly PropertyViewer: "PropertyViewer";
|
|
558
|
-
readonly PropertyManager: "PropertyManager";
|
|
559
|
-
readonly PropertyAdmin: "PropertyAdmin";
|
|
560
|
-
readonly WebsiteContentEditor: "WebsiteContentEditor";
|
|
561
|
-
readonly WebsiteContentViewer: "WebsiteContentViewer";
|
|
562
|
-
readonly WebsiteTechViewer: "WebsiteTechViewer";
|
|
563
|
-
readonly MenuViewer: "MenuViewer";
|
|
564
|
-
readonly MenuEditor: "MenuEditor";
|
|
565
|
-
readonly MenuManager: "MenuManager";
|
|
566
|
-
readonly MenuMetaFieldManager: "MenuMetaFieldManager";
|
|
567
|
-
readonly MenuMetaFieldEditor: "MenuMetaFieldEditor";
|
|
568
|
-
readonly MenuMetaFieldViewer: "MenuMetaFieldViewer";
|
|
569
|
-
readonly StoreDeliveryZoneManager: "StoreDeliveryZoneManager";
|
|
570
|
-
readonly StoreDeliveryZoneEditor: "StoreDeliveryZoneEditor";
|
|
571
|
-
readonly StoreDeliveryZoneViewer: "StoreDeliveryZoneViewer";
|
|
572
|
-
readonly OrderFulfillmentManager: "OrderFulfillmentManager";
|
|
573
|
-
readonly OrderManager: "OrderManager";
|
|
574
|
-
readonly OrderEditor: "OrderEditor";
|
|
575
|
-
readonly OrderViewer: "OrderViewer";
|
|
576
|
-
readonly InventoryManager: "InventoryManager";
|
|
577
|
-
readonly InventoryEditor: "InventoryEditor";
|
|
578
|
-
readonly InventoryViewer: "InventoryViewer";
|
|
579
|
-
readonly PaymentManager: "PaymentManager";
|
|
580
|
-
readonly OnboardingManager: "OnboardingManager";
|
|
581
|
-
readonly FeatureFlagManager: "FeatureFlagManager";
|
|
582
|
-
readonly PropertyOwnerMisc: "PropertyOwnerMisc";
|
|
583
|
-
readonly ManagedOwnerMisc: "ManagedOwnerMisc";
|
|
584
|
-
readonly IntegratorMisc: "IntegratorMisc";
|
|
585
|
-
readonly PropertyManagerMisc: "PropertyManagerMisc";
|
|
586
|
-
readonly FinanceManagerMisc: "FinanceManagerMisc";
|
|
587
|
-
readonly SupportMisc: "SupportMisc";
|
|
879
|
+
export declare const GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum: {
|
|
880
|
+
readonly Main: "Main";
|
|
881
|
+
readonly BrandOverride: "BrandOverride";
|
|
882
|
+
readonly OrgOverride: "OrgOverride";
|
|
883
|
+
readonly Forbidden: "Forbidden";
|
|
884
|
+
readonly NamedRole: "NamedRole";
|
|
588
885
|
};
|
|
589
|
-
export type
|
|
886
|
+
export type GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum];
|
|
590
887
|
export declare const GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum: {
|
|
591
888
|
readonly Property: "Property";
|
|
592
889
|
readonly Org: "Org";
|
|
@@ -594,18 +891,17 @@ export declare const GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum:
|
|
|
594
891
|
readonly SalesChannel: "SalesChannel";
|
|
595
892
|
};
|
|
596
893
|
export type GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum];
|
|
894
|
+
export declare const GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum: {
|
|
895
|
+
readonly User: "User";
|
|
896
|
+
readonly Automation: "Automation";
|
|
897
|
+
};
|
|
898
|
+
export type GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum];
|
|
597
899
|
/**
|
|
598
|
-
*
|
|
900
|
+
* Role name
|
|
599
901
|
* @export
|
|
600
|
-
* @interface
|
|
902
|
+
* @interface GetPrincipalRolesSuccessResponseRolesInnerRoleName
|
|
601
903
|
*/
|
|
602
|
-
export interface
|
|
603
|
-
/**
|
|
604
|
-
* List of roles available and their permissions
|
|
605
|
-
* @type {Array<RolesInner>}
|
|
606
|
-
* @memberof GetRolesSuccessResponse
|
|
607
|
-
*/
|
|
608
|
-
'roles': Array<RolesInner>;
|
|
904
|
+
export interface GetPrincipalRolesSuccessResponseRolesInnerRoleName {
|
|
609
905
|
}
|
|
610
906
|
/**
|
|
611
907
|
* Successful user permissions retrieval response
|
|
@@ -642,10 +938,10 @@ export interface GetUserPermissionsSuccessResponseResourcesValue {
|
|
|
642
938
|
'resourceId': GetUserPermissionsSuccessResponseResourcesValueResourceId;
|
|
643
939
|
/**
|
|
644
940
|
* List of permissions that are assigned to the user for the resource
|
|
645
|
-
* @type {Array<
|
|
941
|
+
* @type {Array<Permissions>}
|
|
646
942
|
* @memberof GetUserPermissionsSuccessResponseResourcesValue
|
|
647
943
|
*/
|
|
648
|
-
'permissions': Array<
|
|
944
|
+
'permissions': Array<Permissions>;
|
|
649
945
|
}
|
|
650
946
|
export declare const GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum: {
|
|
651
947
|
readonly Property: "Property";
|
|
@@ -654,274 +950,204 @@ export declare const GetUserPermissionsSuccessResponseResourcesValueResourceType
|
|
|
654
950
|
readonly SalesChannel: "SalesChannel";
|
|
655
951
|
};
|
|
656
952
|
export type GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum];
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
readonly
|
|
691
|
-
readonly
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
readonly
|
|
747
|
-
readonly
|
|
748
|
-
readonly
|
|
749
|
-
readonly
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
readonly
|
|
754
|
-
readonly
|
|
755
|
-
readonly
|
|
756
|
-
readonly
|
|
757
|
-
readonly
|
|
758
|
-
readonly
|
|
759
|
-
readonly
|
|
760
|
-
readonly
|
|
761
|
-
readonly
|
|
762
|
-
readonly
|
|
763
|
-
readonly
|
|
764
|
-
readonly
|
|
765
|
-
readonly
|
|
766
|
-
readonly
|
|
767
|
-
readonly
|
|
768
|
-
readonly
|
|
769
|
-
readonly
|
|
770
|
-
readonly
|
|
771
|
-
readonly
|
|
772
|
-
readonly
|
|
773
|
-
readonly
|
|
774
|
-
readonly
|
|
775
|
-
readonly
|
|
776
|
-
readonly
|
|
777
|
-
readonly
|
|
778
|
-
readonly
|
|
779
|
-
readonly
|
|
780
|
-
readonly
|
|
781
|
-
readonly
|
|
782
|
-
readonly
|
|
783
|
-
readonly
|
|
784
|
-
readonly
|
|
785
|
-
readonly
|
|
786
|
-
readonly
|
|
787
|
-
readonly
|
|
788
|
-
readonly
|
|
789
|
-
readonly
|
|
790
|
-
readonly
|
|
791
|
-
readonly
|
|
792
|
-
readonly
|
|
793
|
-
readonly
|
|
794
|
-
readonly
|
|
795
|
-
readonly
|
|
796
|
-
readonly
|
|
797
|
-
readonly
|
|
798
|
-
readonly
|
|
799
|
-
readonly
|
|
800
|
-
readonly
|
|
801
|
-
readonly
|
|
802
|
-
readonly
|
|
803
|
-
readonly
|
|
804
|
-
readonly
|
|
805
|
-
readonly
|
|
806
|
-
readonly
|
|
807
|
-
readonly
|
|
808
|
-
readonly
|
|
809
|
-
readonly
|
|
810
|
-
readonly
|
|
811
|
-
readonly
|
|
812
|
-
readonly
|
|
813
|
-
readonly
|
|
814
|
-
readonly
|
|
815
|
-
readonly
|
|
816
|
-
readonly
|
|
817
|
-
readonly
|
|
818
|
-
readonly
|
|
819
|
-
readonly
|
|
820
|
-
readonly
|
|
821
|
-
readonly
|
|
822
|
-
readonly
|
|
823
|
-
readonly
|
|
824
|
-
readonly
|
|
825
|
-
readonly ArchiveSalesChannel: "ArchiveSalesChannel";
|
|
826
|
-
readonly UnarchiveSalesChannel: "UnarchiveSalesChannel";
|
|
827
|
-
readonly PublishSalesChannel: "PublishSalesChannel";
|
|
828
|
-
readonly UnpublishSalesChannel: "UnpublishSalesChannel";
|
|
829
|
-
readonly CloneSalesChannel: "CloneSalesChannel";
|
|
830
|
-
readonly ViewPayGreenWhiteLabelConfiguration: "ViewPayGreenWhiteLabelConfiguration";
|
|
831
|
-
readonly CreatePayGreenWhiteLabelConfiguration: "CreatePayGreenWhiteLabelConfiguration";
|
|
832
|
-
readonly UpdatePayGreenWhiteLabelConfiguration: "UpdatePayGreenWhiteLabelConfiguration";
|
|
833
|
-
readonly UpdatePayGreenStoreConfiguration: "UpdatePayGreenStoreConfiguration";
|
|
834
|
-
readonly ViewSubscriptions: "ViewSubscriptions";
|
|
835
|
-
readonly ViewInvoices: "ViewInvoices";
|
|
836
|
-
readonly EditAccountsBills: "EditAccountsBills";
|
|
837
|
-
readonly ViewAccountsBills: "ViewAccountsBills";
|
|
838
|
-
readonly EditAccountsCategories: "EditAccountsCategories";
|
|
839
|
-
readonly ViewAccountsCategories: "ViewAccountsCategories";
|
|
840
|
-
readonly EditAccountsCreditAccounts: "EditAccountsCreditAccounts";
|
|
841
|
-
readonly ViewAccountsCreditAccounts: "ViewAccountsCreditAccounts";
|
|
842
|
-
readonly EditAccountsCreditBooks: "EditAccountsCreditBooks";
|
|
843
|
-
readonly ViewAccountsCreditBooks: "ViewAccountsCreditBooks";
|
|
844
|
-
readonly EditAccountsExpenses: "EditAccountsExpenses";
|
|
845
|
-
readonly ViewAccountsExpenses: "ViewAccountsExpenses";
|
|
846
|
-
readonly EditAccountsTransactionAccounts: "EditAccountsTransactionAccounts";
|
|
847
|
-
readonly ViewAccountsTransactionAccounts: "ViewAccountsTransactionAccounts";
|
|
848
|
-
readonly EditDocumentExplorer: "EditDocumentExplorer";
|
|
849
|
-
readonly ViewDocumentExplorer: "ViewDocumentExplorer";
|
|
850
|
-
readonly ViewInventoryReports: "ViewInventoryReports";
|
|
851
|
-
readonly EditInventoryPurchaseOrders: "EditInventoryPurchaseOrders";
|
|
852
|
-
readonly ViewInventoryPurchaseOrders: "ViewInventoryPurchaseOrders";
|
|
853
|
-
readonly EditInventoryStockItems: "EditInventoryStockItems";
|
|
854
|
-
readonly ViewInventoryStockItems: "ViewInventoryStockItems";
|
|
855
|
-
readonly EditInventorySupplier: "EditInventorySupplier";
|
|
856
|
-
readonly ViewInventorySupplier: "ViewInventorySupplier";
|
|
857
|
-
readonly EditInventoryTrackingProfiles: "EditInventoryTrackingProfiles";
|
|
858
|
-
readonly ViewInventoryTrackingProfiles: "ViewInventoryTrackingProfiles";
|
|
859
|
-
readonly ViewPayrollReports: "ViewPayrollReports";
|
|
860
|
-
readonly EditPayrollHoliday: "EditPayrollHoliday";
|
|
861
|
-
readonly ViewPayrollHoliday: "ViewPayrollHoliday";
|
|
862
|
-
readonly EditPayrollRota: "EditPayrollRota";
|
|
863
|
-
readonly ViewPayrollRota: "ViewPayrollRota";
|
|
864
|
-
readonly EditPayrollStaff: "EditPayrollStaff";
|
|
865
|
-
readonly ViewPayrollStaff: "ViewPayrollStaff";
|
|
866
|
-
readonly ViewSalesReports: "ViewSalesReports";
|
|
867
|
-
readonly ViewCostReports: "ViewCostReports";
|
|
868
|
-
readonly ViewMenuReports: "ViewMenuReports";
|
|
869
|
-
readonly ViewBrand: "ViewBrand";
|
|
870
|
-
readonly EditBrand: "EditBrand";
|
|
871
|
-
readonly CreateBrand: "CreateBrand";
|
|
872
|
-
readonly TransferBrand: "TransferBrand";
|
|
873
|
-
readonly ViewProperty: "ViewProperty";
|
|
874
|
-
readonly EditProperty: "EditProperty";
|
|
875
|
-
readonly CreateProperty: "CreateProperty";
|
|
876
|
-
readonly ArchiveProperty: "ArchiveProperty";
|
|
877
|
-
readonly ViewEntityFeatureFlags: "ViewEntityFeatureFlags";
|
|
878
|
-
readonly EditEntityFeatureFlags: "EditEntityFeatureFlags";
|
|
879
|
-
readonly CreateOrg: "CreateOrg";
|
|
880
|
-
readonly EditOrg: "EditOrg";
|
|
881
|
-
readonly ViewOrg: "ViewOrg";
|
|
953
|
+
/**
|
|
954
|
+
* ID of the resource the permissions are assigned to
|
|
955
|
+
* @export
|
|
956
|
+
* @interface GetUserPermissionsSuccessResponseResourcesValueResourceId
|
|
957
|
+
*/
|
|
958
|
+
export interface GetUserPermissionsSuccessResponseResourcesValueResourceId {
|
|
959
|
+
}
|
|
960
|
+
/**
|
|
961
|
+
*
|
|
962
|
+
* @export
|
|
963
|
+
* @interface IsInRoleRequest
|
|
964
|
+
*/
|
|
965
|
+
export interface IsInRoleRequest {
|
|
966
|
+
/**
|
|
967
|
+
*
|
|
968
|
+
* @type {AuthorizationRequestPrincipal}
|
|
969
|
+
* @memberof IsInRoleRequest
|
|
970
|
+
*/
|
|
971
|
+
'principal': AuthorizationRequestPrincipal;
|
|
972
|
+
/**
|
|
973
|
+
* Array of roles to check if the principal is in
|
|
974
|
+
* @type {Array<RoleNames>}
|
|
975
|
+
* @memberof IsInRoleRequest
|
|
976
|
+
*/
|
|
977
|
+
'roles': Array<RoleNames>;
|
|
978
|
+
/**
|
|
979
|
+
* How to check authorisation - any or all of the actions must be allowed
|
|
980
|
+
* @type {string}
|
|
981
|
+
* @memberof IsInRoleRequest
|
|
982
|
+
*/
|
|
983
|
+
'checkMode'?: IsInRoleRequestCheckModeEnum;
|
|
984
|
+
}
|
|
985
|
+
export declare const IsInRoleRequestCheckModeEnum: {
|
|
986
|
+
readonly Any: "any";
|
|
987
|
+
readonly All: "all";
|
|
988
|
+
};
|
|
989
|
+
export type IsInRoleRequestCheckModeEnum = typeof IsInRoleRequestCheckModeEnum[keyof typeof IsInRoleRequestCheckModeEnum];
|
|
990
|
+
/**
|
|
991
|
+
* Response containing whether the principal is in any/all of the roles
|
|
992
|
+
* @export
|
|
993
|
+
* @interface IsInRoleResponse
|
|
994
|
+
*/
|
|
995
|
+
export interface IsInRoleResponse {
|
|
996
|
+
/**
|
|
997
|
+
* result of the check - whether the principal is in any/all of the roles
|
|
998
|
+
* @type {boolean}
|
|
999
|
+
* @memberof IsInRoleResponse
|
|
1000
|
+
*/
|
|
1001
|
+
'authorized': boolean;
|
|
1002
|
+
}
|
|
1003
|
+
/**
|
|
1004
|
+
* Successful feature based roles retrieval response
|
|
1005
|
+
* @export
|
|
1006
|
+
* @interface ListFeatureBasedRolesSuccessResponse
|
|
1007
|
+
*/
|
|
1008
|
+
export interface ListFeatureBasedRolesSuccessResponse {
|
|
1009
|
+
/**
|
|
1010
|
+
*
|
|
1011
|
+
* @type {Array<FeatureBasedRole>}
|
|
1012
|
+
* @memberof ListFeatureBasedRolesSuccessResponse
|
|
1013
|
+
*/
|
|
1014
|
+
'roles': Array<FeatureBasedRole>;
|
|
1015
|
+
}
|
|
1016
|
+
/**
|
|
1017
|
+
*
|
|
1018
|
+
* @export
|
|
1019
|
+
* @interface ListOrgRolesSuccessResponseValueValue
|
|
1020
|
+
*/
|
|
1021
|
+
export interface ListOrgRolesSuccessResponseValueValue {
|
|
1022
|
+
/**
|
|
1023
|
+
* Type of resource the permissions are assigned to
|
|
1024
|
+
* @type {string}
|
|
1025
|
+
* @memberof ListOrgRolesSuccessResponseValueValue
|
|
1026
|
+
*/
|
|
1027
|
+
'resourceType': ListOrgRolesSuccessResponseValueValueResourceTypeEnum;
|
|
1028
|
+
/**
|
|
1029
|
+
*
|
|
1030
|
+
* @type {GetUserPermissionsSuccessResponseResourcesValueResourceId}
|
|
1031
|
+
* @memberof ListOrgRolesSuccessResponseValueValue
|
|
1032
|
+
*/
|
|
1033
|
+
'resourceId': GetUserPermissionsSuccessResponseResourcesValueResourceId;
|
|
1034
|
+
/**
|
|
1035
|
+
* List of roles that are assigned to the user for the resource
|
|
1036
|
+
* @type {Array<string>}
|
|
1037
|
+
* @memberof ListOrgRolesSuccessResponseValueValue
|
|
1038
|
+
*/
|
|
1039
|
+
'roles': Array<ListOrgRolesSuccessResponseValueValueRolesEnum>;
|
|
1040
|
+
}
|
|
1041
|
+
export declare const ListOrgRolesSuccessResponseValueValueResourceTypeEnum: {
|
|
1042
|
+
readonly Property: "Property";
|
|
1043
|
+
readonly Org: "Org";
|
|
1044
|
+
readonly Brand: "Brand";
|
|
1045
|
+
readonly SalesChannel: "SalesChannel";
|
|
1046
|
+
};
|
|
1047
|
+
export type ListOrgRolesSuccessResponseValueValueResourceTypeEnum = typeof ListOrgRolesSuccessResponseValueValueResourceTypeEnum[keyof typeof ListOrgRolesSuccessResponseValueValueResourceTypeEnum];
|
|
1048
|
+
export declare const ListOrgRolesSuccessResponseValueValueRolesEnum: {
|
|
1049
|
+
readonly OrgViewer: "OrgViewer";
|
|
1050
|
+
readonly OrgManager: "OrgManager";
|
|
1051
|
+
readonly OrgAdmin: "OrgAdmin";
|
|
1052
|
+
readonly BrandViewer: "BrandViewer";
|
|
1053
|
+
readonly BrandManager: "BrandManager";
|
|
1054
|
+
readonly BrandAdmin: "BrandAdmin";
|
|
1055
|
+
readonly StoreViewer: "StoreViewer";
|
|
1056
|
+
readonly StoreEditor: "StoreEditor";
|
|
1057
|
+
readonly StoreManager: "StoreManager";
|
|
1058
|
+
readonly CustomerViewer: "CustomerViewer";
|
|
1059
|
+
readonly CustomerManager: "CustomerManager";
|
|
1060
|
+
readonly VoucherViewer: "VoucherViewer";
|
|
1061
|
+
readonly VoucherEditor: "VoucherEditor";
|
|
1062
|
+
readonly VoucherManager: "VoucherManager";
|
|
1063
|
+
readonly VoucherCampaignManager: "VoucherCampaignManager";
|
|
1064
|
+
readonly VoucherStatisticsViewer: "VoucherStatisticsViewer";
|
|
1065
|
+
readonly AnalyticsViewer: "AnalyticsViewer";
|
|
1066
|
+
readonly ReportsViewer: "ReportsViewer";
|
|
1067
|
+
readonly FinanceViewer: "FinanceViewer";
|
|
1068
|
+
readonly FinanceManager: "FinanceManager";
|
|
1069
|
+
readonly TeamViewer: "TeamViewer";
|
|
1070
|
+
readonly TeamManager: "TeamManager";
|
|
1071
|
+
readonly TeamAdmin: "TeamAdmin";
|
|
1072
|
+
readonly TechViewer: "TechViewer";
|
|
1073
|
+
readonly TechManager: "TechManager";
|
|
1074
|
+
readonly AppStoreViewer: "AppStoreViewer";
|
|
1075
|
+
readonly AppStoreManager: "AppStoreManager";
|
|
1076
|
+
readonly SalesChannelViewer: "SalesChannelViewer";
|
|
1077
|
+
readonly SalesChannelEditor: "SalesChannelEditor";
|
|
1078
|
+
readonly SalesChannelManager: "SalesChannelManager";
|
|
1079
|
+
readonly DeliveryViewer: "DeliveryViewer";
|
|
1080
|
+
readonly DeliveryManager: "DeliveryManager";
|
|
1081
|
+
readonly DriverManager: "DriverManager";
|
|
1082
|
+
readonly AuditViewer: "AuditViewer";
|
|
1083
|
+
readonly AuditManager: "AuditManager";
|
|
1084
|
+
readonly AccountsViewer: "AccountsViewer";
|
|
1085
|
+
readonly AccountsEditor: "AccountsEditor";
|
|
1086
|
+
readonly DocumentExplorerViewer: "DocumentExplorerViewer";
|
|
1087
|
+
readonly DocumentExplorerEditor: "DocumentExplorerEditor";
|
|
1088
|
+
readonly PayrollViewer: "PayrollViewer";
|
|
1089
|
+
readonly PayrollEditor: "PayrollEditor";
|
|
1090
|
+
readonly PropertyViewer: "PropertyViewer";
|
|
1091
|
+
readonly PropertyManager: "PropertyManager";
|
|
1092
|
+
readonly PropertyAdmin: "PropertyAdmin";
|
|
1093
|
+
readonly WebsiteContentEditor: "WebsiteContentEditor";
|
|
1094
|
+
readonly WebsiteContentViewer: "WebsiteContentViewer";
|
|
1095
|
+
readonly WebsiteTechViewer: "WebsiteTechViewer";
|
|
1096
|
+
readonly MenuViewer: "MenuViewer";
|
|
1097
|
+
readonly MenuEditor: "MenuEditor";
|
|
1098
|
+
readonly MenuManager: "MenuManager";
|
|
1099
|
+
readonly MenuMetaFieldManager: "MenuMetaFieldManager";
|
|
1100
|
+
readonly MenuMetaFieldEditor: "MenuMetaFieldEditor";
|
|
1101
|
+
readonly MenuMetaFieldViewer: "MenuMetaFieldViewer";
|
|
1102
|
+
readonly StoreDeliveryZoneManager: "StoreDeliveryZoneManager";
|
|
1103
|
+
readonly StoreDeliveryZoneEditor: "StoreDeliveryZoneEditor";
|
|
1104
|
+
readonly StoreDeliveryZoneViewer: "StoreDeliveryZoneViewer";
|
|
1105
|
+
readonly OrderFulfillmentManager: "OrderFulfillmentManager";
|
|
1106
|
+
readonly OrderManager: "OrderManager";
|
|
1107
|
+
readonly OrderEditor: "OrderEditor";
|
|
1108
|
+
readonly OrderViewer: "OrderViewer";
|
|
1109
|
+
readonly InventoryManager: "InventoryManager";
|
|
1110
|
+
readonly InventoryEditor: "InventoryEditor";
|
|
1111
|
+
readonly InventoryViewer: "InventoryViewer";
|
|
1112
|
+
readonly PaymentManager: "PaymentManager";
|
|
1113
|
+
readonly OnboardingManager: "OnboardingManager";
|
|
1114
|
+
readonly FeatureFlagManager: "FeatureFlagManager";
|
|
1115
|
+
readonly PropertyOwnerMisc: "PropertyOwnerMisc";
|
|
1116
|
+
readonly ManagedOwnerMisc: "ManagedOwnerMisc";
|
|
1117
|
+
readonly IntegratorMisc: "IntegratorMisc";
|
|
1118
|
+
readonly PropertyManagerMisc: "PropertyManagerMisc";
|
|
1119
|
+
readonly FinanceManagerMisc: "FinanceManagerMisc";
|
|
1120
|
+
readonly SupportMisc: "SupportMisc";
|
|
882
1121
|
};
|
|
883
|
-
export type
|
|
1122
|
+
export type ListOrgRolesSuccessResponseValueValueRolesEnum = typeof ListOrgRolesSuccessResponseValueValueRolesEnum[keyof typeof ListOrgRolesSuccessResponseValueValueRolesEnum];
|
|
884
1123
|
/**
|
|
885
|
-
*
|
|
886
|
-
* @export
|
|
887
|
-
* @interface GetUserPermissionsSuccessResponseResourcesValueResourceId
|
|
888
|
-
*/
|
|
889
|
-
export interface GetUserPermissionsSuccessResponseResourcesValueResourceId {
|
|
890
|
-
}
|
|
891
|
-
/**
|
|
892
|
-
*
|
|
1124
|
+
* Successful permissions retrieval response
|
|
893
1125
|
* @export
|
|
894
|
-
* @interface
|
|
1126
|
+
* @interface ListPermissionsSuccessResponse
|
|
895
1127
|
*/
|
|
896
|
-
export interface
|
|
1128
|
+
export interface ListPermissionsSuccessResponse {
|
|
897
1129
|
/**
|
|
898
1130
|
*
|
|
899
|
-
* @type {
|
|
900
|
-
* @memberof
|
|
1131
|
+
* @type {Permissions & Array<Permissions>}
|
|
1132
|
+
* @memberof ListPermissionsSuccessResponse
|
|
901
1133
|
*/
|
|
902
|
-
'
|
|
1134
|
+
'permissions': Permissions & Array<Permissions>;
|
|
903
1135
|
}
|
|
904
1136
|
/**
|
|
905
|
-
*
|
|
1137
|
+
* Successful roles retrieval response
|
|
906
1138
|
* @export
|
|
907
|
-
* @interface
|
|
1139
|
+
* @interface ListRolesSuccessResponse
|
|
908
1140
|
*/
|
|
909
|
-
export interface
|
|
910
|
-
/**
|
|
911
|
-
*
|
|
912
|
-
* @type {string}
|
|
913
|
-
* @memberof PathParams
|
|
914
|
-
*/
|
|
915
|
-
'orgId': string;
|
|
1141
|
+
export interface ListRolesSuccessResponse {
|
|
916
1142
|
/**
|
|
917
|
-
*
|
|
918
|
-
* @type {
|
|
919
|
-
* @memberof
|
|
1143
|
+
* List of named roles
|
|
1144
|
+
* @type {Array<RoleNames>}
|
|
1145
|
+
* @memberof ListRolesSuccessResponse
|
|
920
1146
|
*/
|
|
921
|
-
'
|
|
1147
|
+
'roles': Array<RoleNames>;
|
|
922
1148
|
}
|
|
923
1149
|
/**
|
|
924
|
-
*
|
|
1150
|
+
* Permissions
|
|
925
1151
|
* @export
|
|
926
1152
|
* @enum {string}
|
|
927
1153
|
*/
|
|
@@ -1150,8 +1376,31 @@ export declare const Permissions: {
|
|
|
1150
1376
|
readonly CreateOrg: "CreateOrg";
|
|
1151
1377
|
readonly EditOrg: "EditOrg";
|
|
1152
1378
|
readonly ViewOrg: "ViewOrg";
|
|
1379
|
+
readonly ViewWebhooks: "ViewWebhooks";
|
|
1380
|
+
readonly EditWebhooks: "EditWebhooks";
|
|
1381
|
+
readonly RoleAdmin: "RoleAdmin";
|
|
1382
|
+
readonly RoleFactory: "RoleFactory";
|
|
1153
1383
|
};
|
|
1154
1384
|
export type Permissions = typeof Permissions[keyof typeof Permissions];
|
|
1385
|
+
/**
|
|
1386
|
+
* Principals in org
|
|
1387
|
+
* @export
|
|
1388
|
+
* @interface PrincipalsInOrgResponse
|
|
1389
|
+
*/
|
|
1390
|
+
export interface PrincipalsInOrgResponse {
|
|
1391
|
+
/**
|
|
1392
|
+
*
|
|
1393
|
+
* @type {string}
|
|
1394
|
+
* @memberof PrincipalsInOrgResponse
|
|
1395
|
+
*/
|
|
1396
|
+
'orgId': string;
|
|
1397
|
+
/**
|
|
1398
|
+
* List of principals in org
|
|
1399
|
+
* @type {Array<AuthorizationRequestPrincipal>}
|
|
1400
|
+
* @memberof PrincipalsInOrgResponse
|
|
1401
|
+
*/
|
|
1402
|
+
'principals': Array<AuthorizationRequestPrincipal>;
|
|
1403
|
+
}
|
|
1155
1404
|
/**
|
|
1156
1405
|
* Details for revoking a forbidden role from a principal
|
|
1157
1406
|
* @export
|
|
@@ -1187,7 +1436,7 @@ export type RevokeForbiddenRoleRequestBodyCompensatingRoleEnum = typeof RevokeFo
|
|
|
1187
1436
|
*/
|
|
1188
1437
|
export interface RevokeRoleRequestBody {
|
|
1189
1438
|
/**
|
|
1190
|
-
*
|
|
1439
|
+
*
|
|
1191
1440
|
* @type {string}
|
|
1192
1441
|
* @memberof RevokeRoleRequestBody
|
|
1193
1442
|
*/
|
|
@@ -1300,24 +1549,15 @@ export interface RevokeRoleSuccessResponse {
|
|
|
1300
1549
|
'message': string;
|
|
1301
1550
|
}
|
|
1302
1551
|
/**
|
|
1303
|
-
*
|
|
1552
|
+
* Role names
|
|
1304
1553
|
* @export
|
|
1305
|
-
* @
|
|
1554
|
+
* @enum {string}
|
|
1306
1555
|
*/
|
|
1307
|
-
export
|
|
1308
|
-
|
|
1309
|
-
|
|
1310
|
-
|
|
1311
|
-
|
|
1312
|
-
*/
|
|
1313
|
-
'name': string;
|
|
1314
|
-
/**
|
|
1315
|
-
*
|
|
1316
|
-
* @type {Permissions & Array<string>}
|
|
1317
|
-
* @memberof RolesInner
|
|
1318
|
-
*/
|
|
1319
|
-
'permissions': Permissions & Array<string>;
|
|
1320
|
-
}
|
|
1556
|
+
export declare const RoleNames: {
|
|
1557
|
+
readonly Admin: "Admin";
|
|
1558
|
+
readonly Factory: "Factory";
|
|
1559
|
+
};
|
|
1560
|
+
export type RoleNames = typeof RoleNames[keyof typeof RoleNames];
|
|
1321
1561
|
/**
|
|
1322
1562
|
*
|
|
1323
1563
|
* @export
|
|
@@ -1345,210 +1585,587 @@ export interface ValidationErrorsInner {
|
|
|
1345
1585
|
export interface ValidationErrorsInnerPathInner {
|
|
1346
1586
|
}
|
|
1347
1587
|
/**
|
|
1348
|
-
* AuthenticationApi - axios parameter creator
|
|
1588
|
+
* AuthenticationApi - axios parameter creator
|
|
1589
|
+
* @export
|
|
1590
|
+
*/
|
|
1591
|
+
export declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1592
|
+
/**
|
|
1593
|
+
* Authenticate and authorize a user to perform an action
|
|
1594
|
+
* @summary Authenticate and authorize Request
|
|
1595
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
1596
|
+
* @param {*} [options] Override http request option.
|
|
1597
|
+
* @throws {RequiredError}
|
|
1598
|
+
*/
|
|
1599
|
+
authenticateAndAuthorize: (authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1600
|
+
};
|
|
1601
|
+
/**
|
|
1602
|
+
* AuthenticationApi - functional programming interface
|
|
1603
|
+
* @export
|
|
1604
|
+
*/
|
|
1605
|
+
export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
1606
|
+
/**
|
|
1607
|
+
* Authenticate and authorize a user to perform an action
|
|
1608
|
+
* @summary Authenticate and authorize Request
|
|
1609
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
1610
|
+
* @param {*} [options] Override http request option.
|
|
1611
|
+
* @throws {RequiredError}
|
|
1612
|
+
*/
|
|
1613
|
+
authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>>;
|
|
1614
|
+
};
|
|
1615
|
+
/**
|
|
1616
|
+
* AuthenticationApi - factory interface
|
|
1617
|
+
* @export
|
|
1618
|
+
*/
|
|
1619
|
+
export declare const AuthenticationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1620
|
+
/**
|
|
1621
|
+
* Authenticate and authorize a user to perform an action
|
|
1622
|
+
* @summary Authenticate and authorize Request
|
|
1623
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
1624
|
+
* @param {*} [options] Override http request option.
|
|
1625
|
+
* @throws {RequiredError}
|
|
1626
|
+
*/
|
|
1627
|
+
authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse>;
|
|
1628
|
+
};
|
|
1629
|
+
/**
|
|
1630
|
+
* AuthenticationApi - object-oriented interface
|
|
1631
|
+
* @export
|
|
1632
|
+
* @class AuthenticationApi
|
|
1633
|
+
* @extends {BaseAPI}
|
|
1634
|
+
*/
|
|
1635
|
+
export declare class AuthenticationApi extends BaseAPI {
|
|
1636
|
+
/**
|
|
1637
|
+
* Authenticate and authorize a user to perform an action
|
|
1638
|
+
* @summary Authenticate and authorize Request
|
|
1639
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
1640
|
+
* @param {*} [options] Override http request option.
|
|
1641
|
+
* @throws {RequiredError}
|
|
1642
|
+
* @memberof AuthenticationApi
|
|
1643
|
+
*/
|
|
1644
|
+
authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndAuthorizeResponse, any, {}>>;
|
|
1645
|
+
}
|
|
1646
|
+
/**
|
|
1647
|
+
* AuthorizationApi - axios parameter creator
|
|
1648
|
+
* @export
|
|
1649
|
+
*/
|
|
1650
|
+
export declare const AuthorizationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1651
|
+
/**
|
|
1652
|
+
* Authenticate and authorize a user to perform an action
|
|
1653
|
+
* @summary Authenticate and authorize Request
|
|
1654
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
1655
|
+
* @param {*} [options] Override http request option.
|
|
1656
|
+
* @throws {RequiredError}
|
|
1657
|
+
*/
|
|
1658
|
+
authenticateAndAuthorize: (authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1659
|
+
/**
|
|
1660
|
+
* Authenticate and check if a user is in any/all of the roles
|
|
1661
|
+
* @summary Authenticate and Check Is In Role
|
|
1662
|
+
* @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
|
|
1663
|
+
* @param {*} [options] Override http request option.
|
|
1664
|
+
* @throws {RequiredError}
|
|
1665
|
+
*/
|
|
1666
|
+
authenticateAndCheckIsInRole: (authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1667
|
+
/**
|
|
1668
|
+
* Check if a user is authorized to perform an action
|
|
1669
|
+
* @summary Authorize Request
|
|
1670
|
+
* @param {AuthorizationRequest} [authorizationRequest]
|
|
1671
|
+
* @param {*} [options] Override http request option.
|
|
1672
|
+
* @throws {RequiredError}
|
|
1673
|
+
*/
|
|
1674
|
+
authorize: (authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1675
|
+
/**
|
|
1676
|
+
* Check if a user is authorized to perform an action on multiple resources
|
|
1677
|
+
* @summary Authorize Batch Request
|
|
1678
|
+
* @param {AuthorizationBatchRequest} [authorizationBatchRequest]
|
|
1679
|
+
* @param {*} [options] Override http request option.
|
|
1680
|
+
* @throws {RequiredError}
|
|
1681
|
+
*/
|
|
1682
|
+
authorizeBatch: (authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1683
|
+
/**
|
|
1684
|
+
* Check if a user is in any/all of the roles
|
|
1685
|
+
* @summary Check Is In Role
|
|
1686
|
+
* @param {IsInRoleRequest} [isInRoleRequest]
|
|
1687
|
+
* @param {*} [options] Override http request option.
|
|
1688
|
+
* @throws {RequiredError}
|
|
1689
|
+
*/
|
|
1690
|
+
checkIsInRole: (isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1691
|
+
};
|
|
1692
|
+
/**
|
|
1693
|
+
* AuthorizationApi - functional programming interface
|
|
1694
|
+
* @export
|
|
1695
|
+
*/
|
|
1696
|
+
export declare const AuthorizationApiFp: (configuration?: Configuration) => {
|
|
1697
|
+
/**
|
|
1698
|
+
* Authenticate and authorize a user to perform an action
|
|
1699
|
+
* @summary Authenticate and authorize Request
|
|
1700
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
1701
|
+
* @param {*} [options] Override http request option.
|
|
1702
|
+
* @throws {RequiredError}
|
|
1703
|
+
*/
|
|
1704
|
+
authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>>;
|
|
1705
|
+
/**
|
|
1706
|
+
* Authenticate and check if a user is in any/all of the roles
|
|
1707
|
+
* @summary Authenticate and Check Is In Role
|
|
1708
|
+
* @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
|
|
1709
|
+
* @param {*} [options] Override http request option.
|
|
1710
|
+
* @throws {RequiredError}
|
|
1711
|
+
*/
|
|
1712
|
+
authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndCheckIsInRoleResponse>>;
|
|
1713
|
+
/**
|
|
1714
|
+
* Check if a user is authorized to perform an action
|
|
1715
|
+
* @summary Authorize Request
|
|
1716
|
+
* @param {AuthorizationRequest} [authorizationRequest]
|
|
1717
|
+
* @param {*} [options] Override http request option.
|
|
1718
|
+
* @throws {RequiredError}
|
|
1719
|
+
*/
|
|
1720
|
+
authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizationResponse>>;
|
|
1721
|
+
/**
|
|
1722
|
+
* Check if a user is authorized to perform an action on multiple resources
|
|
1723
|
+
* @summary Authorize Batch Request
|
|
1724
|
+
* @param {AuthorizationBatchRequest} [authorizationBatchRequest]
|
|
1725
|
+
* @param {*} [options] Override http request option.
|
|
1726
|
+
* @throws {RequiredError}
|
|
1727
|
+
*/
|
|
1728
|
+
authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizationBatchResponse>>;
|
|
1729
|
+
/**
|
|
1730
|
+
* Check if a user is in any/all of the roles
|
|
1731
|
+
* @summary Check Is In Role
|
|
1732
|
+
* @param {IsInRoleRequest} [isInRoleRequest]
|
|
1733
|
+
* @param {*} [options] Override http request option.
|
|
1734
|
+
* @throws {RequiredError}
|
|
1735
|
+
*/
|
|
1736
|
+
checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IsInRoleResponse>>;
|
|
1737
|
+
};
|
|
1738
|
+
/**
|
|
1739
|
+
* AuthorizationApi - factory interface
|
|
1740
|
+
* @export
|
|
1741
|
+
*/
|
|
1742
|
+
export declare const AuthorizationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1743
|
+
/**
|
|
1744
|
+
* Authenticate and authorize a user to perform an action
|
|
1745
|
+
* @summary Authenticate and authorize Request
|
|
1746
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
1747
|
+
* @param {*} [options] Override http request option.
|
|
1748
|
+
* @throws {RequiredError}
|
|
1749
|
+
*/
|
|
1750
|
+
authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse>;
|
|
1751
|
+
/**
|
|
1752
|
+
* Authenticate and check if a user is in any/all of the roles
|
|
1753
|
+
* @summary Authenticate and Check Is In Role
|
|
1754
|
+
* @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
|
|
1755
|
+
* @param {*} [options] Override http request option.
|
|
1756
|
+
* @throws {RequiredError}
|
|
1757
|
+
*/
|
|
1758
|
+
authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndCheckIsInRoleResponse>;
|
|
1759
|
+
/**
|
|
1760
|
+
* Check if a user is authorized to perform an action
|
|
1761
|
+
* @summary Authorize Request
|
|
1762
|
+
* @param {AuthorizationRequest} [authorizationRequest]
|
|
1763
|
+
* @param {*} [options] Override http request option.
|
|
1764
|
+
* @throws {RequiredError}
|
|
1765
|
+
*/
|
|
1766
|
+
authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthorizationResponse>;
|
|
1767
|
+
/**
|
|
1768
|
+
* Check if a user is authorized to perform an action on multiple resources
|
|
1769
|
+
* @summary Authorize Batch Request
|
|
1770
|
+
* @param {AuthorizationBatchRequest} [authorizationBatchRequest]
|
|
1771
|
+
* @param {*} [options] Override http request option.
|
|
1772
|
+
* @throws {RequiredError}
|
|
1773
|
+
*/
|
|
1774
|
+
authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthorizationBatchResponse>;
|
|
1775
|
+
/**
|
|
1776
|
+
* Check if a user is in any/all of the roles
|
|
1777
|
+
* @summary Check Is In Role
|
|
1778
|
+
* @param {IsInRoleRequest} [isInRoleRequest]
|
|
1779
|
+
* @param {*} [options] Override http request option.
|
|
1780
|
+
* @throws {RequiredError}
|
|
1781
|
+
*/
|
|
1782
|
+
checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<IsInRoleResponse>;
|
|
1783
|
+
};
|
|
1784
|
+
/**
|
|
1785
|
+
* AuthorizationApi - object-oriented interface
|
|
1786
|
+
* @export
|
|
1787
|
+
* @class AuthorizationApi
|
|
1788
|
+
* @extends {BaseAPI}
|
|
1789
|
+
*/
|
|
1790
|
+
export declare class AuthorizationApi extends BaseAPI {
|
|
1791
|
+
/**
|
|
1792
|
+
* Authenticate and authorize a user to perform an action
|
|
1793
|
+
* @summary Authenticate and authorize Request
|
|
1794
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
1795
|
+
* @param {*} [options] Override http request option.
|
|
1796
|
+
* @throws {RequiredError}
|
|
1797
|
+
* @memberof AuthorizationApi
|
|
1798
|
+
*/
|
|
1799
|
+
authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndAuthorizeResponse, any, {}>>;
|
|
1800
|
+
/**
|
|
1801
|
+
* Authenticate and check if a user is in any/all of the roles
|
|
1802
|
+
* @summary Authenticate and Check Is In Role
|
|
1803
|
+
* @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
|
|
1804
|
+
* @param {*} [options] Override http request option.
|
|
1805
|
+
* @throws {RequiredError}
|
|
1806
|
+
* @memberof AuthorizationApi
|
|
1807
|
+
*/
|
|
1808
|
+
authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndCheckIsInRoleResponse, any, {}>>;
|
|
1809
|
+
/**
|
|
1810
|
+
* Check if a user is authorized to perform an action
|
|
1811
|
+
* @summary Authorize Request
|
|
1812
|
+
* @param {AuthorizationRequest} [authorizationRequest]
|
|
1813
|
+
* @param {*} [options] Override http request option.
|
|
1814
|
+
* @throws {RequiredError}
|
|
1815
|
+
* @memberof AuthorizationApi
|
|
1816
|
+
*/
|
|
1817
|
+
authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthorizationResponse, any, {}>>;
|
|
1818
|
+
/**
|
|
1819
|
+
* Check if a user is authorized to perform an action on multiple resources
|
|
1820
|
+
* @summary Authorize Batch Request
|
|
1821
|
+
* @param {AuthorizationBatchRequest} [authorizationBatchRequest]
|
|
1822
|
+
* @param {*} [options] Override http request option.
|
|
1823
|
+
* @throws {RequiredError}
|
|
1824
|
+
* @memberof AuthorizationApi
|
|
1825
|
+
*/
|
|
1826
|
+
authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthorizationBatchResponse, any, {}>>;
|
|
1827
|
+
/**
|
|
1828
|
+
* Check if a user is in any/all of the roles
|
|
1829
|
+
* @summary Check Is In Role
|
|
1830
|
+
* @param {IsInRoleRequest} [isInRoleRequest]
|
|
1831
|
+
* @param {*} [options] Override http request option.
|
|
1832
|
+
* @throws {RequiredError}
|
|
1833
|
+
* @memberof AuthorizationApi
|
|
1834
|
+
*/
|
|
1835
|
+
checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IsInRoleResponse, any, {}>>;
|
|
1836
|
+
}
|
|
1837
|
+
/**
|
|
1838
|
+
* AuthorizedEntitiesApi - axios parameter creator
|
|
1349
1839
|
* @export
|
|
1350
1840
|
*/
|
|
1351
|
-
export declare const
|
|
1841
|
+
export declare const AuthorizedEntitiesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1352
1842
|
/**
|
|
1353
|
-
*
|
|
1354
|
-
* @summary
|
|
1355
|
-
* @param {
|
|
1843
|
+
* Get the authorized brands for a given org
|
|
1844
|
+
* @summary Get Authorized Brands
|
|
1845
|
+
* @param {string} orgId
|
|
1846
|
+
* @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
|
|
1847
|
+
* @param {*} [options] Override http request option.
|
|
1848
|
+
* @throws {RequiredError}
|
|
1849
|
+
*/
|
|
1850
|
+
getAuthorizedBrands: (orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1851
|
+
/**
|
|
1852
|
+
* Get the authorized orgs for a given principal
|
|
1853
|
+
* @summary Get Authorized Orgs
|
|
1854
|
+
* @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
|
|
1855
|
+
* @param {*} [options] Override http request option.
|
|
1856
|
+
* @throws {RequiredError}
|
|
1857
|
+
*/
|
|
1858
|
+
getAuthorizedOrgs: (getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1859
|
+
/**
|
|
1860
|
+
* Get the authorized properties for a given org
|
|
1861
|
+
* @summary Get Authorized Properties
|
|
1862
|
+
* @param {string} orgId
|
|
1863
|
+
* @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
|
|
1356
1864
|
* @param {*} [options] Override http request option.
|
|
1357
1865
|
* @throws {RequiredError}
|
|
1358
1866
|
*/
|
|
1359
|
-
|
|
1867
|
+
getAuthorizedProperties: (orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1360
1868
|
};
|
|
1361
1869
|
/**
|
|
1362
|
-
*
|
|
1870
|
+
* AuthorizedEntitiesApi - functional programming interface
|
|
1363
1871
|
* @export
|
|
1364
1872
|
*/
|
|
1365
|
-
export declare const
|
|
1873
|
+
export declare const AuthorizedEntitiesApiFp: (configuration?: Configuration) => {
|
|
1366
1874
|
/**
|
|
1367
|
-
*
|
|
1368
|
-
* @summary
|
|
1369
|
-
* @param {
|
|
1875
|
+
* Get the authorized brands for a given org
|
|
1876
|
+
* @summary Get Authorized Brands
|
|
1877
|
+
* @param {string} orgId
|
|
1878
|
+
* @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
|
|
1879
|
+
* @param {*} [options] Override http request option.
|
|
1880
|
+
* @throws {RequiredError}
|
|
1881
|
+
*/
|
|
1882
|
+
getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedBrandsResponse>>;
|
|
1883
|
+
/**
|
|
1884
|
+
* Get the authorized orgs for a given principal
|
|
1885
|
+
* @summary Get Authorized Orgs
|
|
1886
|
+
* @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
|
|
1887
|
+
* @param {*} [options] Override http request option.
|
|
1888
|
+
* @throws {RequiredError}
|
|
1889
|
+
*/
|
|
1890
|
+
getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedOrgsResponse>>;
|
|
1891
|
+
/**
|
|
1892
|
+
* Get the authorized properties for a given org
|
|
1893
|
+
* @summary Get Authorized Properties
|
|
1894
|
+
* @param {string} orgId
|
|
1895
|
+
* @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
|
|
1370
1896
|
* @param {*} [options] Override http request option.
|
|
1371
1897
|
* @throws {RequiredError}
|
|
1372
1898
|
*/
|
|
1373
|
-
|
|
1899
|
+
getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedPropertiesResponse>>;
|
|
1374
1900
|
};
|
|
1375
1901
|
/**
|
|
1376
|
-
*
|
|
1902
|
+
* AuthorizedEntitiesApi - factory interface
|
|
1377
1903
|
* @export
|
|
1378
1904
|
*/
|
|
1379
|
-
export declare const
|
|
1905
|
+
export declare const AuthorizedEntitiesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1380
1906
|
/**
|
|
1381
|
-
*
|
|
1382
|
-
* @summary
|
|
1383
|
-
* @param {
|
|
1907
|
+
* Get the authorized brands for a given org
|
|
1908
|
+
* @summary Get Authorized Brands
|
|
1909
|
+
* @param {string} orgId
|
|
1910
|
+
* @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
|
|
1911
|
+
* @param {*} [options] Override http request option.
|
|
1912
|
+
* @throws {RequiredError}
|
|
1913
|
+
*/
|
|
1914
|
+
getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedBrandsResponse>;
|
|
1915
|
+
/**
|
|
1916
|
+
* Get the authorized orgs for a given principal
|
|
1917
|
+
* @summary Get Authorized Orgs
|
|
1918
|
+
* @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
|
|
1919
|
+
* @param {*} [options] Override http request option.
|
|
1920
|
+
* @throws {RequiredError}
|
|
1921
|
+
*/
|
|
1922
|
+
getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedOrgsResponse>;
|
|
1923
|
+
/**
|
|
1924
|
+
* Get the authorized properties for a given org
|
|
1925
|
+
* @summary Get Authorized Properties
|
|
1926
|
+
* @param {string} orgId
|
|
1927
|
+
* @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
|
|
1384
1928
|
* @param {*} [options] Override http request option.
|
|
1385
1929
|
* @throws {RequiredError}
|
|
1386
1930
|
*/
|
|
1387
|
-
|
|
1931
|
+
getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedPropertiesResponse>;
|
|
1388
1932
|
};
|
|
1389
1933
|
/**
|
|
1390
|
-
*
|
|
1934
|
+
* AuthorizedEntitiesApi - object-oriented interface
|
|
1391
1935
|
* @export
|
|
1392
|
-
* @class
|
|
1936
|
+
* @class AuthorizedEntitiesApi
|
|
1393
1937
|
* @extends {BaseAPI}
|
|
1394
1938
|
*/
|
|
1395
|
-
export declare class
|
|
1939
|
+
export declare class AuthorizedEntitiesApi extends BaseAPI {
|
|
1396
1940
|
/**
|
|
1397
|
-
*
|
|
1398
|
-
* @summary
|
|
1399
|
-
* @param {
|
|
1941
|
+
* Get the authorized brands for a given org
|
|
1942
|
+
* @summary Get Authorized Brands
|
|
1943
|
+
* @param {string} orgId
|
|
1944
|
+
* @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
|
|
1400
1945
|
* @param {*} [options] Override http request option.
|
|
1401
1946
|
* @throws {RequiredError}
|
|
1402
|
-
* @memberof
|
|
1947
|
+
* @memberof AuthorizedEntitiesApi
|
|
1948
|
+
*/
|
|
1949
|
+
getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAuthorizedBrandsResponse, any, {}>>;
|
|
1950
|
+
/**
|
|
1951
|
+
* Get the authorized orgs for a given principal
|
|
1952
|
+
* @summary Get Authorized Orgs
|
|
1953
|
+
* @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
|
|
1954
|
+
* @param {*} [options] Override http request option.
|
|
1955
|
+
* @throws {RequiredError}
|
|
1956
|
+
* @memberof AuthorizedEntitiesApi
|
|
1957
|
+
*/
|
|
1958
|
+
getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAuthorizedOrgsResponse, any, {}>>;
|
|
1959
|
+
/**
|
|
1960
|
+
* Get the authorized properties for a given org
|
|
1961
|
+
* @summary Get Authorized Properties
|
|
1962
|
+
* @param {string} orgId
|
|
1963
|
+
* @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
|
|
1964
|
+
* @param {*} [options] Override http request option.
|
|
1965
|
+
* @throws {RequiredError}
|
|
1966
|
+
* @memberof AuthorizedEntitiesApi
|
|
1403
1967
|
*/
|
|
1404
|
-
|
|
1968
|
+
getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAuthorizedPropertiesResponse, any, {}>>;
|
|
1405
1969
|
}
|
|
1406
1970
|
/**
|
|
1407
|
-
*
|
|
1971
|
+
* ConfigurationDataApi - axios parameter creator
|
|
1408
1972
|
* @export
|
|
1409
1973
|
*/
|
|
1410
|
-
export declare const
|
|
1974
|
+
export declare const ConfigurationDataApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1411
1975
|
/**
|
|
1412
|
-
*
|
|
1413
|
-
* @summary
|
|
1414
|
-
* @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
|
|
1976
|
+
* List the available feature based roles
|
|
1977
|
+
* @summary List Feature Based Roles
|
|
1415
1978
|
* @param {*} [options] Override http request option.
|
|
1416
1979
|
* @throws {RequiredError}
|
|
1417
1980
|
*/
|
|
1418
|
-
|
|
1981
|
+
configListFeatureBasedRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1419
1982
|
/**
|
|
1420
|
-
*
|
|
1421
|
-
* @summary
|
|
1422
|
-
* @param {AuthorizationRequest} [authorizationRequest]
|
|
1983
|
+
* List the available permissions
|
|
1984
|
+
* @summary List Permissions
|
|
1423
1985
|
* @param {*} [options] Override http request option.
|
|
1424
1986
|
* @throws {RequiredError}
|
|
1425
1987
|
*/
|
|
1426
|
-
|
|
1427
|
-
};
|
|
1428
|
-
/**
|
|
1429
|
-
* AuthorizationApi - functional programming interface
|
|
1430
|
-
* @export
|
|
1431
|
-
*/
|
|
1432
|
-
export declare const AuthorizationApiFp: (configuration?: Configuration) => {
|
|
1988
|
+
configListPermissions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1433
1989
|
/**
|
|
1434
|
-
*
|
|
1435
|
-
* @summary
|
|
1436
|
-
* @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
|
|
1990
|
+
* List the available roles
|
|
1991
|
+
* @summary List Roles
|
|
1437
1992
|
* @param {*} [options] Override http request option.
|
|
1438
1993
|
* @throws {RequiredError}
|
|
1439
1994
|
*/
|
|
1440
|
-
|
|
1995
|
+
configListRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1441
1996
|
/**
|
|
1442
|
-
*
|
|
1443
|
-
* @summary
|
|
1444
|
-
* @param {AuthorizationRequest} [authorizationRequest]
|
|
1997
|
+
* List the available feature based roles
|
|
1998
|
+
* @summary List Feature Based Roles
|
|
1445
1999
|
* @param {*} [options] Override http request option.
|
|
1446
2000
|
* @throws {RequiredError}
|
|
1447
2001
|
*/
|
|
1448
|
-
|
|
1449
|
-
};
|
|
1450
|
-
/**
|
|
1451
|
-
* AuthorizationApi - factory interface
|
|
1452
|
-
* @export
|
|
1453
|
-
*/
|
|
1454
|
-
export declare const AuthorizationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2002
|
+
listFeatureBasedRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1455
2003
|
/**
|
|
1456
|
-
*
|
|
1457
|
-
* @summary
|
|
1458
|
-
* @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
|
|
2004
|
+
* List the available permissions
|
|
2005
|
+
* @summary List Permissions
|
|
1459
2006
|
* @param {*} [options] Override http request option.
|
|
1460
2007
|
* @throws {RequiredError}
|
|
1461
2008
|
*/
|
|
1462
|
-
|
|
2009
|
+
listPermissions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1463
2010
|
/**
|
|
1464
|
-
*
|
|
1465
|
-
* @summary
|
|
1466
|
-
* @param {AuthorizationRequest} [authorizationRequest]
|
|
2011
|
+
* List the available roles
|
|
2012
|
+
* @summary List Roles
|
|
1467
2013
|
* @param {*} [options] Override http request option.
|
|
1468
2014
|
* @throws {RequiredError}
|
|
1469
2015
|
*/
|
|
1470
|
-
|
|
2016
|
+
listRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1471
2017
|
};
|
|
1472
2018
|
/**
|
|
1473
|
-
*
|
|
2019
|
+
* ConfigurationDataApi - functional programming interface
|
|
1474
2020
|
* @export
|
|
1475
|
-
* @class AuthorizationApi
|
|
1476
|
-
* @extends {BaseAPI}
|
|
1477
2021
|
*/
|
|
1478
|
-
export declare
|
|
2022
|
+
export declare const ConfigurationDataApiFp: (configuration?: Configuration) => {
|
|
1479
2023
|
/**
|
|
1480
|
-
*
|
|
1481
|
-
* @summary
|
|
1482
|
-
* @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
|
|
2024
|
+
* List the available feature based roles
|
|
2025
|
+
* @summary List Feature Based Roles
|
|
1483
2026
|
* @param {*} [options] Override http request option.
|
|
1484
2027
|
* @throws {RequiredError}
|
|
1485
|
-
* @memberof AuthorizationApi
|
|
1486
2028
|
*/
|
|
1487
|
-
|
|
2029
|
+
configListFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFeatureBasedRolesSuccessResponse>>;
|
|
1488
2030
|
/**
|
|
1489
|
-
*
|
|
1490
|
-
* @summary
|
|
1491
|
-
* @param {AuthorizationRequest} [authorizationRequest]
|
|
2031
|
+
* List the available permissions
|
|
2032
|
+
* @summary List Permissions
|
|
1492
2033
|
* @param {*} [options] Override http request option.
|
|
1493
2034
|
* @throws {RequiredError}
|
|
1494
|
-
* @memberof AuthorizationApi
|
|
1495
2035
|
*/
|
|
1496
|
-
|
|
1497
|
-
|
|
1498
|
-
|
|
1499
|
-
|
|
1500
|
-
*
|
|
1501
|
-
|
|
1502
|
-
|
|
2036
|
+
configListPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPermissionsSuccessResponse>>;
|
|
2037
|
+
/**
|
|
2038
|
+
* List the available roles
|
|
2039
|
+
* @summary List Roles
|
|
2040
|
+
* @param {*} [options] Override http request option.
|
|
2041
|
+
* @throws {RequiredError}
|
|
2042
|
+
*/
|
|
2043
|
+
configListRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesSuccessResponse>>;
|
|
2044
|
+
/**
|
|
2045
|
+
* List the available feature based roles
|
|
2046
|
+
* @summary List Feature Based Roles
|
|
2047
|
+
* @param {*} [options] Override http request option.
|
|
2048
|
+
* @throws {RequiredError}
|
|
2049
|
+
*/
|
|
2050
|
+
listFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFeatureBasedRolesSuccessResponse>>;
|
|
1503
2051
|
/**
|
|
1504
2052
|
* List the available permissions
|
|
1505
2053
|
* @summary List Permissions
|
|
1506
2054
|
* @param {*} [options] Override http request option.
|
|
1507
2055
|
* @throws {RequiredError}
|
|
1508
2056
|
*/
|
|
1509
|
-
listPermissions
|
|
2057
|
+
listPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPermissionsSuccessResponse>>;
|
|
2058
|
+
/**
|
|
2059
|
+
* List the available roles
|
|
2060
|
+
* @summary List Roles
|
|
2061
|
+
* @param {*} [options] Override http request option.
|
|
2062
|
+
* @throws {RequiredError}
|
|
2063
|
+
*/
|
|
2064
|
+
listRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesSuccessResponse>>;
|
|
1510
2065
|
};
|
|
1511
2066
|
/**
|
|
1512
|
-
*
|
|
2067
|
+
* ConfigurationDataApi - factory interface
|
|
1513
2068
|
* @export
|
|
1514
2069
|
*/
|
|
1515
|
-
export declare const
|
|
2070
|
+
export declare const ConfigurationDataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2071
|
+
/**
|
|
2072
|
+
* List the available feature based roles
|
|
2073
|
+
* @summary List Feature Based Roles
|
|
2074
|
+
* @param {*} [options] Override http request option.
|
|
2075
|
+
* @throws {RequiredError}
|
|
2076
|
+
*/
|
|
2077
|
+
configListFeatureBasedRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListFeatureBasedRolesSuccessResponse>;
|
|
1516
2078
|
/**
|
|
1517
2079
|
* List the available permissions
|
|
1518
2080
|
* @summary List Permissions
|
|
1519
2081
|
* @param {*} [options] Override http request option.
|
|
1520
2082
|
* @throws {RequiredError}
|
|
1521
2083
|
*/
|
|
1522
|
-
|
|
1523
|
-
|
|
1524
|
-
|
|
1525
|
-
|
|
1526
|
-
*
|
|
1527
|
-
|
|
1528
|
-
|
|
2084
|
+
configListPermissions(options?: RawAxiosRequestConfig): AxiosPromise<ListPermissionsSuccessResponse>;
|
|
2085
|
+
/**
|
|
2086
|
+
* List the available roles
|
|
2087
|
+
* @summary List Roles
|
|
2088
|
+
* @param {*} [options] Override http request option.
|
|
2089
|
+
* @throws {RequiredError}
|
|
2090
|
+
*/
|
|
2091
|
+
configListRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListRolesSuccessResponse>;
|
|
2092
|
+
/**
|
|
2093
|
+
* List the available feature based roles
|
|
2094
|
+
* @summary List Feature Based Roles
|
|
2095
|
+
* @param {*} [options] Override http request option.
|
|
2096
|
+
* @throws {RequiredError}
|
|
2097
|
+
*/
|
|
2098
|
+
listFeatureBasedRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListFeatureBasedRolesSuccessResponse>;
|
|
1529
2099
|
/**
|
|
1530
2100
|
* List the available permissions
|
|
1531
2101
|
* @summary List Permissions
|
|
1532
2102
|
* @param {*} [options] Override http request option.
|
|
1533
2103
|
* @throws {RequiredError}
|
|
1534
2104
|
*/
|
|
1535
|
-
listPermissions(options?: RawAxiosRequestConfig): AxiosPromise<
|
|
2105
|
+
listPermissions(options?: RawAxiosRequestConfig): AxiosPromise<ListPermissionsSuccessResponse>;
|
|
2106
|
+
/**
|
|
2107
|
+
* List the available roles
|
|
2108
|
+
* @summary List Roles
|
|
2109
|
+
* @param {*} [options] Override http request option.
|
|
2110
|
+
* @throws {RequiredError}
|
|
2111
|
+
*/
|
|
2112
|
+
listRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListRolesSuccessResponse>;
|
|
1536
2113
|
};
|
|
1537
2114
|
/**
|
|
1538
|
-
*
|
|
2115
|
+
* ConfigurationDataApi - object-oriented interface
|
|
1539
2116
|
* @export
|
|
1540
|
-
* @class
|
|
2117
|
+
* @class ConfigurationDataApi
|
|
1541
2118
|
* @extends {BaseAPI}
|
|
1542
2119
|
*/
|
|
1543
|
-
export declare class
|
|
2120
|
+
export declare class ConfigurationDataApi extends BaseAPI {
|
|
2121
|
+
/**
|
|
2122
|
+
* List the available feature based roles
|
|
2123
|
+
* @summary List Feature Based Roles
|
|
2124
|
+
* @param {*} [options] Override http request option.
|
|
2125
|
+
* @throws {RequiredError}
|
|
2126
|
+
* @memberof ConfigurationDataApi
|
|
2127
|
+
*/
|
|
2128
|
+
configListFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFeatureBasedRolesSuccessResponse, any, {}>>;
|
|
2129
|
+
/**
|
|
2130
|
+
* List the available permissions
|
|
2131
|
+
* @summary List Permissions
|
|
2132
|
+
* @param {*} [options] Override http request option.
|
|
2133
|
+
* @throws {RequiredError}
|
|
2134
|
+
* @memberof ConfigurationDataApi
|
|
2135
|
+
*/
|
|
2136
|
+
configListPermissions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPermissionsSuccessResponse, any, {}>>;
|
|
2137
|
+
/**
|
|
2138
|
+
* List the available roles
|
|
2139
|
+
* @summary List Roles
|
|
2140
|
+
* @param {*} [options] Override http request option.
|
|
2141
|
+
* @throws {RequiredError}
|
|
2142
|
+
* @memberof ConfigurationDataApi
|
|
2143
|
+
*/
|
|
2144
|
+
configListRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRolesSuccessResponse, any, {}>>;
|
|
2145
|
+
/**
|
|
2146
|
+
* List the available feature based roles
|
|
2147
|
+
* @summary List Feature Based Roles
|
|
2148
|
+
* @param {*} [options] Override http request option.
|
|
2149
|
+
* @throws {RequiredError}
|
|
2150
|
+
* @memberof ConfigurationDataApi
|
|
2151
|
+
*/
|
|
2152
|
+
listFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFeatureBasedRolesSuccessResponse, any, {}>>;
|
|
1544
2153
|
/**
|
|
1545
2154
|
* List the available permissions
|
|
1546
2155
|
* @summary List Permissions
|
|
1547
2156
|
* @param {*} [options] Override http request option.
|
|
1548
2157
|
* @throws {RequiredError}
|
|
1549
|
-
* @memberof
|
|
2158
|
+
* @memberof ConfigurationDataApi
|
|
2159
|
+
*/
|
|
2160
|
+
listPermissions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPermissionsSuccessResponse, any, {}>>;
|
|
2161
|
+
/**
|
|
2162
|
+
* List the available roles
|
|
2163
|
+
* @summary List Roles
|
|
2164
|
+
* @param {*} [options] Override http request option.
|
|
2165
|
+
* @throws {RequiredError}
|
|
2166
|
+
* @memberof ConfigurationDataApi
|
|
1550
2167
|
*/
|
|
1551
|
-
|
|
2168
|
+
listRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRolesSuccessResponse, any, {}>>;
|
|
1552
2169
|
}
|
|
1553
2170
|
/**
|
|
1554
2171
|
* RoleAssignmentApi - axios parameter creator
|
|
@@ -1692,7 +2309,7 @@ export declare class RoleAssignmentApi extends BaseAPI {
|
|
|
1692
2309
|
* @throws {RequiredError}
|
|
1693
2310
|
* @memberof RoleAssignmentApi
|
|
1694
2311
|
*/
|
|
1695
|
-
assignRoleToPrincipal(orgId: string, assignRoleRequestBody?: AssignRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AssignRoleSuccessResponse, any>>;
|
|
2312
|
+
assignRoleToPrincipal(orgId: string, assignRoleRequestBody?: AssignRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AssignRoleSuccessResponse, any, {}>>;
|
|
1696
2313
|
/**
|
|
1697
2314
|
* Get the active roles for a given principal
|
|
1698
2315
|
* @summary Get Principal Roles
|
|
@@ -1702,7 +2319,7 @@ export declare class RoleAssignmentApi extends BaseAPI {
|
|
|
1702
2319
|
* @throws {RequiredError}
|
|
1703
2320
|
* @memberof RoleAssignmentApi
|
|
1704
2321
|
*/
|
|
1705
|
-
getPrincipalRoles(orgId: string, getPrincipalRolesRequestBody?: GetPrincipalRolesRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPrincipalRolesSuccessResponse, any>>;
|
|
2322
|
+
getPrincipalRoles(orgId: string, getPrincipalRolesRequestBody?: GetPrincipalRolesRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPrincipalRolesSuccessResponse, any, {}>>;
|
|
1706
2323
|
/**
|
|
1707
2324
|
* Revokes a forbidden role from a given principal (user, group, etc.)
|
|
1708
2325
|
* @summary Revoke Forbidden Role from Principal
|
|
@@ -1712,7 +2329,7 @@ export declare class RoleAssignmentApi extends BaseAPI {
|
|
|
1712
2329
|
* @throws {RequiredError}
|
|
1713
2330
|
* @memberof RoleAssignmentApi
|
|
1714
2331
|
*/
|
|
1715
|
-
revokeForbiddenRoleFromPrincipal(orgId: string, revokeForbiddenRoleRequestBody?: RevokeForbiddenRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeRoleSuccessResponse, any>>;
|
|
2332
|
+
revokeForbiddenRoleFromPrincipal(orgId: string, revokeForbiddenRoleRequestBody?: RevokeForbiddenRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeRoleSuccessResponse, any, {}>>;
|
|
1716
2333
|
/**
|
|
1717
2334
|
* Revokes a specified role from a given principal (user, group, etc.)
|
|
1718
2335
|
* @summary Revoke Role from Principal
|
|
@@ -1722,13 +2339,88 @@ export declare class RoleAssignmentApi extends BaseAPI {
|
|
|
1722
2339
|
* @throws {RequiredError}
|
|
1723
2340
|
* @memberof RoleAssignmentApi
|
|
1724
2341
|
*/
|
|
1725
|
-
revokeRoleFromPrincipal(orgId: string, revokeRoleRequestBody?: RevokeRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeRoleSuccessResponse, any>>;
|
|
2342
|
+
revokeRoleFromPrincipal(orgId: string, revokeRoleRequestBody?: RevokeRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeRoleSuccessResponse, any, {}>>;
|
|
2343
|
+
}
|
|
2344
|
+
/**
|
|
2345
|
+
* UserManagementApi - axios parameter creator
|
|
2346
|
+
* @export
|
|
2347
|
+
*/
|
|
2348
|
+
export declare const UserManagementApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2349
|
+
/**
|
|
2350
|
+
* List the users in a given org
|
|
2351
|
+
* @summary List Users in Org
|
|
2352
|
+
* @param {string} orgId
|
|
2353
|
+
* @param {*} [options] Override http request option.
|
|
2354
|
+
* @throws {RequiredError}
|
|
2355
|
+
*/
|
|
2356
|
+
listUsersInOrg: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2357
|
+
};
|
|
2358
|
+
/**
|
|
2359
|
+
* UserManagementApi - functional programming interface
|
|
2360
|
+
* @export
|
|
2361
|
+
*/
|
|
2362
|
+
export declare const UserManagementApiFp: (configuration?: Configuration) => {
|
|
2363
|
+
/**
|
|
2364
|
+
* List the users in a given org
|
|
2365
|
+
* @summary List Users in Org
|
|
2366
|
+
* @param {string} orgId
|
|
2367
|
+
* @param {*} [options] Override http request option.
|
|
2368
|
+
* @throws {RequiredError}
|
|
2369
|
+
*/
|
|
2370
|
+
listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PrincipalsInOrgResponse>>;
|
|
2371
|
+
};
|
|
2372
|
+
/**
|
|
2373
|
+
* UserManagementApi - factory interface
|
|
2374
|
+
* @export
|
|
2375
|
+
*/
|
|
2376
|
+
export declare const UserManagementApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2377
|
+
/**
|
|
2378
|
+
* List the users in a given org
|
|
2379
|
+
* @summary List Users in Org
|
|
2380
|
+
* @param {string} orgId
|
|
2381
|
+
* @param {*} [options] Override http request option.
|
|
2382
|
+
* @throws {RequiredError}
|
|
2383
|
+
*/
|
|
2384
|
+
listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<PrincipalsInOrgResponse>;
|
|
2385
|
+
};
|
|
2386
|
+
/**
|
|
2387
|
+
* UserManagementApi - object-oriented interface
|
|
2388
|
+
* @export
|
|
2389
|
+
* @class UserManagementApi
|
|
2390
|
+
* @extends {BaseAPI}
|
|
2391
|
+
*/
|
|
2392
|
+
export declare class UserManagementApi extends BaseAPI {
|
|
2393
|
+
/**
|
|
2394
|
+
* List the users in a given org
|
|
2395
|
+
* @summary List Users in Org
|
|
2396
|
+
* @param {string} orgId
|
|
2397
|
+
* @param {*} [options] Override http request option.
|
|
2398
|
+
* @throws {RequiredError}
|
|
2399
|
+
* @memberof UserManagementApi
|
|
2400
|
+
*/
|
|
2401
|
+
listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PrincipalsInOrgResponse, any, {}>>;
|
|
1726
2402
|
}
|
|
1727
2403
|
/**
|
|
1728
2404
|
* UserPermissionsApi - axios parameter creator
|
|
1729
2405
|
* @export
|
|
1730
2406
|
*/
|
|
1731
2407
|
export declare const UserPermissionsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2408
|
+
/**
|
|
2409
|
+
* List the available permissions for the current user
|
|
2410
|
+
* @summary List Org Permissions
|
|
2411
|
+
* @param {string} orgId
|
|
2412
|
+
* @param {*} [options] Override http request option.
|
|
2413
|
+
* @throws {RequiredError}
|
|
2414
|
+
*/
|
|
2415
|
+
listOrgPermissions: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2416
|
+
/**
|
|
2417
|
+
* List the available roles for the current user
|
|
2418
|
+
* @summary List Org Roles
|
|
2419
|
+
* @param {string} orgId
|
|
2420
|
+
* @param {*} [options] Override http request option.
|
|
2421
|
+
* @throws {RequiredError}
|
|
2422
|
+
*/
|
|
2423
|
+
listOrgRoles: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1732
2424
|
/**
|
|
1733
2425
|
* List the available permissions for the current user
|
|
1734
2426
|
* @summary List Own Permissions
|
|
@@ -1752,6 +2444,30 @@ export declare const UserPermissionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
1752
2444
|
* @export
|
|
1753
2445
|
*/
|
|
1754
2446
|
export declare const UserPermissionsApiFp: (configuration?: Configuration) => {
|
|
2447
|
+
/**
|
|
2448
|
+
* List the available permissions for the current user
|
|
2449
|
+
* @summary List Org Permissions
|
|
2450
|
+
* @param {string} orgId
|
|
2451
|
+
* @param {*} [options] Override http request option.
|
|
2452
|
+
* @throws {RequiredError}
|
|
2453
|
+
*/
|
|
2454
|
+
listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
2455
|
+
[key: string]: {
|
|
2456
|
+
[key: string]: GetUserPermissionsSuccessResponseResourcesValue;
|
|
2457
|
+
};
|
|
2458
|
+
}>>;
|
|
2459
|
+
/**
|
|
2460
|
+
* List the available roles for the current user
|
|
2461
|
+
* @summary List Org Roles
|
|
2462
|
+
* @param {string} orgId
|
|
2463
|
+
* @param {*} [options] Override http request option.
|
|
2464
|
+
* @throws {RequiredError}
|
|
2465
|
+
*/
|
|
2466
|
+
listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
2467
|
+
[key: string]: {
|
|
2468
|
+
[key: string]: ListOrgRolesSuccessResponseValueValue;
|
|
2469
|
+
};
|
|
2470
|
+
}>>;
|
|
1755
2471
|
/**
|
|
1756
2472
|
* List the available permissions for the current user
|
|
1757
2473
|
* @summary List Own Permissions
|
|
@@ -1775,6 +2491,30 @@ export declare const UserPermissionsApiFp: (configuration?: Configuration) => {
|
|
|
1775
2491
|
* @export
|
|
1776
2492
|
*/
|
|
1777
2493
|
export declare const UserPermissionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2494
|
+
/**
|
|
2495
|
+
* List the available permissions for the current user
|
|
2496
|
+
* @summary List Org Permissions
|
|
2497
|
+
* @param {string} orgId
|
|
2498
|
+
* @param {*} [options] Override http request option.
|
|
2499
|
+
* @throws {RequiredError}
|
|
2500
|
+
*/
|
|
2501
|
+
listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
2502
|
+
[key: string]: {
|
|
2503
|
+
[key: string]: GetUserPermissionsSuccessResponseResourcesValue;
|
|
2504
|
+
};
|
|
2505
|
+
}>;
|
|
2506
|
+
/**
|
|
2507
|
+
* List the available roles for the current user
|
|
2508
|
+
* @summary List Org Roles
|
|
2509
|
+
* @param {string} orgId
|
|
2510
|
+
* @param {*} [options] Override http request option.
|
|
2511
|
+
* @throws {RequiredError}
|
|
2512
|
+
*/
|
|
2513
|
+
listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
2514
|
+
[key: string]: {
|
|
2515
|
+
[key: string]: ListOrgRolesSuccessResponseValueValue;
|
|
2516
|
+
};
|
|
2517
|
+
}>;
|
|
1778
2518
|
/**
|
|
1779
2519
|
* List the available permissions for the current user
|
|
1780
2520
|
* @summary List Own Permissions
|
|
@@ -1800,6 +2540,32 @@ export declare const UserPermissionsApiFactory: (configuration?: Configuration,
|
|
|
1800
2540
|
* @extends {BaseAPI}
|
|
1801
2541
|
*/
|
|
1802
2542
|
export declare class UserPermissionsApi extends BaseAPI {
|
|
2543
|
+
/**
|
|
2544
|
+
* List the available permissions for the current user
|
|
2545
|
+
* @summary List Org Permissions
|
|
2546
|
+
* @param {string} orgId
|
|
2547
|
+
* @param {*} [options] Override http request option.
|
|
2548
|
+
* @throws {RequiredError}
|
|
2549
|
+
* @memberof UserPermissionsApi
|
|
2550
|
+
*/
|
|
2551
|
+
listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
2552
|
+
[key: string]: {
|
|
2553
|
+
[key: string]: GetUserPermissionsSuccessResponseResourcesValue;
|
|
2554
|
+
};
|
|
2555
|
+
}, any, {}>>;
|
|
2556
|
+
/**
|
|
2557
|
+
* List the available roles for the current user
|
|
2558
|
+
* @summary List Org Roles
|
|
2559
|
+
* @param {string} orgId
|
|
2560
|
+
* @param {*} [options] Override http request option.
|
|
2561
|
+
* @throws {RequiredError}
|
|
2562
|
+
* @memberof UserPermissionsApi
|
|
2563
|
+
*/
|
|
2564
|
+
listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
2565
|
+
[key: string]: {
|
|
2566
|
+
[key: string]: ListOrgRolesSuccessResponseValueValue;
|
|
2567
|
+
};
|
|
2568
|
+
}, any, {}>>;
|
|
1803
2569
|
/**
|
|
1804
2570
|
* List the available permissions for the current user
|
|
1805
2571
|
* @summary List Own Permissions
|
|
@@ -1808,7 +2574,7 @@ export declare class UserPermissionsApi extends BaseAPI {
|
|
|
1808
2574
|
* @throws {RequiredError}
|
|
1809
2575
|
* @memberof UserPermissionsApi
|
|
1810
2576
|
*/
|
|
1811
|
-
listOwnPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any>>;
|
|
2577
|
+
listOwnPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any, {}>>;
|
|
1812
2578
|
/**
|
|
1813
2579
|
* List the available permissions for a given user
|
|
1814
2580
|
* @summary List User Permissions
|
|
@@ -1818,5 +2584,5 @@ export declare class UserPermissionsApi extends BaseAPI {
|
|
|
1818
2584
|
* @throws {RequiredError}
|
|
1819
2585
|
* @memberof UserPermissionsApi
|
|
1820
2586
|
*/
|
|
1821
|
-
listUserPermissions(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any>>;
|
|
2587
|
+
listUserPermissions(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any, {}>>;
|
|
1822
2588
|
}
|