@flipdish/authorization 0.0.3 → 0.0.4-rc.1766093992
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +1 -0
- package/README.md +216 -101
- package/api.ts +2031 -653
- package/configuration.ts +1 -1
- package/dist/api.d.ts +1222 -407
- package/dist/api.js +1604 -391
- package/dist/common.d.ts +1 -1
- package/dist/common.js +2 -2
- package/dist/configuration.js +1 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -133,18 +133,18 @@ export interface AssignRoleSuccessResponse {
|
|
|
133
133
|
'message': string;
|
|
134
134
|
}
|
|
135
135
|
/**
|
|
136
|
-
*
|
|
136
|
+
* Request to check if a user is authorized to perform an action(s). If you pass in an array of permissions, you will receive a single allow / deny response (based on an AND of the result for each permission). For a granular response to multiple permissions, call the /authorize/batch endpoint.
|
|
137
137
|
* @export
|
|
138
138
|
* @interface AuthenticateAndAuthorizeRequest
|
|
139
139
|
*/
|
|
140
140
|
export interface AuthenticateAndAuthorizeRequest {
|
|
141
141
|
/**
|
|
142
142
|
* Incoming request headers to be used for authentication
|
|
143
|
-
* @type {{ [key: string]:
|
|
143
|
+
* @type {{ [key: string]: string; }}
|
|
144
144
|
* @memberof AuthenticateAndAuthorizeRequest
|
|
145
145
|
*/
|
|
146
146
|
'headers': {
|
|
147
|
-
[key: string]:
|
|
147
|
+
[key: string]: string;
|
|
148
148
|
};
|
|
149
149
|
/**
|
|
150
150
|
*
|
|
@@ -158,7 +158,18 @@ export interface AuthenticateAndAuthorizeRequest {
|
|
|
158
158
|
* @memberof AuthenticateAndAuthorizeRequest
|
|
159
159
|
*/
|
|
160
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;
|
|
161
167
|
}
|
|
168
|
+
export declare const AuthenticateAndAuthorizeRequestCheckModeEnum: {
|
|
169
|
+
readonly Any: "any";
|
|
170
|
+
readonly All: "all";
|
|
171
|
+
};
|
|
172
|
+
export type AuthenticateAndAuthorizeRequestCheckModeEnum = typeof AuthenticateAndAuthorizeRequestCheckModeEnum[keyof typeof AuthenticateAndAuthorizeRequestCheckModeEnum];
|
|
162
173
|
/**
|
|
163
174
|
* Response containing the authentication and authorization decision
|
|
164
175
|
* @export
|
|
@@ -167,10 +178,10 @@ export interface AuthenticateAndAuthorizeRequest {
|
|
|
167
178
|
export interface AuthenticateAndAuthorizeResponse {
|
|
168
179
|
/**
|
|
169
180
|
*
|
|
170
|
-
* @type {
|
|
181
|
+
* @type {AuthenticateAndCheckIsInRoleResponseAuthentication}
|
|
171
182
|
* @memberof AuthenticateAndAuthorizeResponse
|
|
172
183
|
*/
|
|
173
|
-
'authentication':
|
|
184
|
+
'authentication': AuthenticateAndCheckIsInRoleResponseAuthentication;
|
|
174
185
|
/**
|
|
175
186
|
*
|
|
176
187
|
* @type {AuthorizationResponse}
|
|
@@ -181,30 +192,162 @@ export interface AuthenticateAndAuthorizeResponse {
|
|
|
181
192
|
/**
|
|
182
193
|
*
|
|
183
194
|
* @export
|
|
184
|
-
* @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
|
|
185
247
|
*/
|
|
186
|
-
export interface
|
|
248
|
+
export interface AuthenticateAndCheckIsInRoleResponseAuthentication {
|
|
187
249
|
/**
|
|
188
250
|
*
|
|
189
251
|
* @type {AuthorizationRequestPrincipal}
|
|
190
|
-
* @memberof
|
|
252
|
+
* @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
|
|
191
253
|
*/
|
|
192
254
|
'principal': AuthorizationRequestPrincipal;
|
|
193
255
|
/**
|
|
194
256
|
* Whether the user is authenticated
|
|
195
257
|
* @type {boolean}
|
|
196
|
-
* @memberof
|
|
258
|
+
* @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
|
|
197
259
|
*/
|
|
198
260
|
'authenticated': boolean;
|
|
199
261
|
/**
|
|
200
262
|
* The reason for the authentication failure
|
|
201
263
|
* @type {string}
|
|
202
|
-
* @memberof
|
|
264
|
+
* @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
|
|
203
265
|
*/
|
|
204
266
|
'reason'?: string;
|
|
205
267
|
}
|
|
206
268
|
/**
|
|
207
|
-
*
|
|
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).
|
|
208
351
|
* @export
|
|
209
352
|
* @interface AuthorizationRequest
|
|
210
353
|
*/
|
|
@@ -227,9 +370,20 @@ export interface AuthorizationRequest {
|
|
|
227
370
|
* @memberof AuthorizationRequest
|
|
228
371
|
*/
|
|
229
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;
|
|
230
379
|
}
|
|
380
|
+
export declare const AuthorizationRequestCheckModeEnum: {
|
|
381
|
+
readonly Any: "any";
|
|
382
|
+
readonly All: "all";
|
|
383
|
+
};
|
|
384
|
+
export type AuthorizationRequestCheckModeEnum = typeof AuthorizationRequestCheckModeEnum[keyof typeof AuthorizationRequestCheckModeEnum];
|
|
231
385
|
/**
|
|
232
|
-
*
|
|
386
|
+
* Permission or array of permissions - note that you still only receive a single allow / deny response (calculated based on the checkMode)
|
|
233
387
|
* @export
|
|
234
388
|
* @interface AuthorizationRequestAction
|
|
235
389
|
*/
|
|
@@ -413,17 +567,203 @@ export interface ErrorResponse {
|
|
|
413
567
|
'message': string;
|
|
414
568
|
}
|
|
415
569
|
/**
|
|
416
|
-
*
|
|
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
|
|
705
|
+
* @export
|
|
706
|
+
* @interface GetAuthorizedOrgsResponse
|
|
707
|
+
*/
|
|
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.
|
|
417
724
|
* @export
|
|
418
|
-
* @interface
|
|
725
|
+
* @interface GetAuthorizedPropertiesRequest
|
|
419
726
|
*/
|
|
420
|
-
export interface
|
|
727
|
+
export interface GetAuthorizedPropertiesRequest {
|
|
728
|
+
/**
|
|
729
|
+
*
|
|
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
|
+
};
|
|
421
742
|
/**
|
|
422
743
|
*
|
|
423
|
-
* @type {Permissions
|
|
424
|
-
* @memberof
|
|
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
|
|
425
759
|
*/
|
|
426
|
-
'
|
|
760
|
+
'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
761
|
+
/**
|
|
762
|
+
* Array of denied resources
|
|
763
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
764
|
+
* @memberof GetAuthorizedPropertiesResponse
|
|
765
|
+
*/
|
|
766
|
+
'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
427
767
|
}
|
|
428
768
|
/**
|
|
429
769
|
* Details for getting roles for a principal
|
|
@@ -498,7 +838,7 @@ export interface GetPrincipalRolesSuccessResponseRolesInner {
|
|
|
498
838
|
* @type {string}
|
|
499
839
|
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
500
840
|
*/
|
|
501
|
-
'resourceType'
|
|
841
|
+
'resourceType'?: GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum;
|
|
502
842
|
/**
|
|
503
843
|
* Organization ID
|
|
504
844
|
* @type {string}
|
|
@@ -523,12 +863,25 @@ export interface GetPrincipalRolesSuccessResponseRolesInner {
|
|
|
523
863
|
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
524
864
|
*/
|
|
525
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;
|
|
526
878
|
}
|
|
527
879
|
export declare const GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum: {
|
|
528
880
|
readonly Main: "Main";
|
|
529
881
|
readonly BrandOverride: "BrandOverride";
|
|
530
882
|
readonly OrgOverride: "OrgOverride";
|
|
531
883
|
readonly Forbidden: "Forbidden";
|
|
884
|
+
readonly NamedRole: "NamedRole";
|
|
532
885
|
};
|
|
533
886
|
export type GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum];
|
|
534
887
|
export declare const GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum: {
|
|
@@ -538,6 +891,11 @@ export declare const GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum:
|
|
|
538
891
|
readonly SalesChannel: "SalesChannel";
|
|
539
892
|
};
|
|
540
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];
|
|
541
899
|
/**
|
|
542
900
|
* Role name
|
|
543
901
|
* @export
|
|
@@ -545,19 +903,6 @@ export type GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum = typeof
|
|
|
545
903
|
*/
|
|
546
904
|
export interface GetPrincipalRolesSuccessResponseRolesInnerRoleName {
|
|
547
905
|
}
|
|
548
|
-
/**
|
|
549
|
-
* Successful roles retrieval response
|
|
550
|
-
* @export
|
|
551
|
-
* @interface GetRolesSuccessResponse
|
|
552
|
-
*/
|
|
553
|
-
export interface GetRolesSuccessResponse {
|
|
554
|
-
/**
|
|
555
|
-
* List of roles available and their permissions
|
|
556
|
-
* @type {Array<RolesInner>}
|
|
557
|
-
* @memberof GetRolesSuccessResponse
|
|
558
|
-
*/
|
|
559
|
-
'roles': Array<RolesInner>;
|
|
560
|
-
}
|
|
561
906
|
/**
|
|
562
907
|
* Successful user permissions retrieval response
|
|
563
908
|
* @export
|
|
@@ -593,10 +938,10 @@ export interface GetUserPermissionsSuccessResponseResourcesValue {
|
|
|
593
938
|
'resourceId': GetUserPermissionsSuccessResponseResourcesValueResourceId;
|
|
594
939
|
/**
|
|
595
940
|
* List of permissions that are assigned to the user for the resource
|
|
596
|
-
* @type {Array<
|
|
941
|
+
* @type {Array<Permissions>}
|
|
597
942
|
* @memberof GetUserPermissionsSuccessResponseResourcesValue
|
|
598
943
|
*/
|
|
599
|
-
'permissions': Array<
|
|
944
|
+
'permissions': Array<Permissions>;
|
|
600
945
|
}
|
|
601
946
|
export declare const GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum: {
|
|
602
947
|
readonly Property: "Property";
|
|
@@ -605,274 +950,204 @@ export declare const GetUserPermissionsSuccessResponseResourcesValueResourceType
|
|
|
605
950
|
readonly SalesChannel: "SalesChannel";
|
|
606
951
|
};
|
|
607
952
|
export type GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum];
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
readonly
|
|
642
|
-
readonly
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
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
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
readonly
|
|
698
|
-
readonly
|
|
699
|
-
readonly
|
|
700
|
-
readonly
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
readonly
|
|
705
|
-
readonly
|
|
706
|
-
readonly
|
|
707
|
-
readonly
|
|
708
|
-
readonly
|
|
709
|
-
readonly
|
|
710
|
-
readonly
|
|
711
|
-
readonly
|
|
712
|
-
readonly
|
|
713
|
-
readonly
|
|
714
|
-
readonly
|
|
715
|
-
readonly
|
|
716
|
-
readonly
|
|
717
|
-
readonly
|
|
718
|
-
readonly
|
|
719
|
-
readonly
|
|
720
|
-
readonly
|
|
721
|
-
readonly
|
|
722
|
-
readonly
|
|
723
|
-
readonly
|
|
724
|
-
readonly
|
|
725
|
-
readonly
|
|
726
|
-
readonly
|
|
727
|
-
readonly
|
|
728
|
-
readonly
|
|
729
|
-
readonly
|
|
730
|
-
readonly
|
|
731
|
-
readonly
|
|
732
|
-
readonly
|
|
733
|
-
readonly
|
|
734
|
-
readonly
|
|
735
|
-
readonly
|
|
736
|
-
readonly
|
|
737
|
-
readonly
|
|
738
|
-
readonly
|
|
739
|
-
readonly
|
|
740
|
-
readonly
|
|
741
|
-
readonly
|
|
742
|
-
readonly
|
|
743
|
-
readonly
|
|
744
|
-
readonly
|
|
745
|
-
readonly
|
|
746
|
-
readonly
|
|
747
|
-
readonly
|
|
748
|
-
readonly
|
|
749
|
-
readonly
|
|
750
|
-
readonly
|
|
751
|
-
readonly
|
|
752
|
-
readonly
|
|
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 ArchiveSalesChannel: "ArchiveSalesChannel";
|
|
777
|
-
readonly UnarchiveSalesChannel: "UnarchiveSalesChannel";
|
|
778
|
-
readonly PublishSalesChannel: "PublishSalesChannel";
|
|
779
|
-
readonly UnpublishSalesChannel: "UnpublishSalesChannel";
|
|
780
|
-
readonly CloneSalesChannel: "CloneSalesChannel";
|
|
781
|
-
readonly ViewPayGreenWhiteLabelConfiguration: "ViewPayGreenWhiteLabelConfiguration";
|
|
782
|
-
readonly CreatePayGreenWhiteLabelConfiguration: "CreatePayGreenWhiteLabelConfiguration";
|
|
783
|
-
readonly UpdatePayGreenWhiteLabelConfiguration: "UpdatePayGreenWhiteLabelConfiguration";
|
|
784
|
-
readonly UpdatePayGreenStoreConfiguration: "UpdatePayGreenStoreConfiguration";
|
|
785
|
-
readonly ViewSubscriptions: "ViewSubscriptions";
|
|
786
|
-
readonly ViewInvoices: "ViewInvoices";
|
|
787
|
-
readonly EditAccountsBills: "EditAccountsBills";
|
|
788
|
-
readonly ViewAccountsBills: "ViewAccountsBills";
|
|
789
|
-
readonly EditAccountsCategories: "EditAccountsCategories";
|
|
790
|
-
readonly ViewAccountsCategories: "ViewAccountsCategories";
|
|
791
|
-
readonly EditAccountsCreditAccounts: "EditAccountsCreditAccounts";
|
|
792
|
-
readonly ViewAccountsCreditAccounts: "ViewAccountsCreditAccounts";
|
|
793
|
-
readonly EditAccountsCreditBooks: "EditAccountsCreditBooks";
|
|
794
|
-
readonly ViewAccountsCreditBooks: "ViewAccountsCreditBooks";
|
|
795
|
-
readonly EditAccountsExpenses: "EditAccountsExpenses";
|
|
796
|
-
readonly ViewAccountsExpenses: "ViewAccountsExpenses";
|
|
797
|
-
readonly EditAccountsTransactionAccounts: "EditAccountsTransactionAccounts";
|
|
798
|
-
readonly ViewAccountsTransactionAccounts: "ViewAccountsTransactionAccounts";
|
|
799
|
-
readonly EditDocumentExplorer: "EditDocumentExplorer";
|
|
800
|
-
readonly ViewDocumentExplorer: "ViewDocumentExplorer";
|
|
801
|
-
readonly ViewInventoryReports: "ViewInventoryReports";
|
|
802
|
-
readonly EditInventoryPurchaseOrders: "EditInventoryPurchaseOrders";
|
|
803
|
-
readonly ViewInventoryPurchaseOrders: "ViewInventoryPurchaseOrders";
|
|
804
|
-
readonly EditInventoryStockItems: "EditInventoryStockItems";
|
|
805
|
-
readonly ViewInventoryStockItems: "ViewInventoryStockItems";
|
|
806
|
-
readonly EditInventorySupplier: "EditInventorySupplier";
|
|
807
|
-
readonly ViewInventorySupplier: "ViewInventorySupplier";
|
|
808
|
-
readonly EditInventoryTrackingProfiles: "EditInventoryTrackingProfiles";
|
|
809
|
-
readonly ViewInventoryTrackingProfiles: "ViewInventoryTrackingProfiles";
|
|
810
|
-
readonly ViewPayrollReports: "ViewPayrollReports";
|
|
811
|
-
readonly EditPayrollHoliday: "EditPayrollHoliday";
|
|
812
|
-
readonly ViewPayrollHoliday: "ViewPayrollHoliday";
|
|
813
|
-
readonly EditPayrollRota: "EditPayrollRota";
|
|
814
|
-
readonly ViewPayrollRota: "ViewPayrollRota";
|
|
815
|
-
readonly EditPayrollStaff: "EditPayrollStaff";
|
|
816
|
-
readonly ViewPayrollStaff: "ViewPayrollStaff";
|
|
817
|
-
readonly ViewSalesReports: "ViewSalesReports";
|
|
818
|
-
readonly ViewCostReports: "ViewCostReports";
|
|
819
|
-
readonly ViewMenuReports: "ViewMenuReports";
|
|
820
|
-
readonly ViewBrand: "ViewBrand";
|
|
821
|
-
readonly EditBrand: "EditBrand";
|
|
822
|
-
readonly CreateBrand: "CreateBrand";
|
|
823
|
-
readonly TransferBrand: "TransferBrand";
|
|
824
|
-
readonly ViewProperty: "ViewProperty";
|
|
825
|
-
readonly EditProperty: "EditProperty";
|
|
826
|
-
readonly CreateProperty: "CreateProperty";
|
|
827
|
-
readonly ArchiveProperty: "ArchiveProperty";
|
|
828
|
-
readonly ViewEntityFeatureFlags: "ViewEntityFeatureFlags";
|
|
829
|
-
readonly EditEntityFeatureFlags: "EditEntityFeatureFlags";
|
|
830
|
-
readonly CreateOrg: "CreateOrg";
|
|
831
|
-
readonly EditOrg: "EditOrg";
|
|
832
|
-
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";
|
|
833
1121
|
};
|
|
834
|
-
export type
|
|
835
|
-
/**
|
|
836
|
-
* ID of the resource the permissions are assigned to
|
|
837
|
-
* @export
|
|
838
|
-
* @interface GetUserPermissionsSuccessResponseResourcesValueResourceId
|
|
839
|
-
*/
|
|
840
|
-
export interface GetUserPermissionsSuccessResponseResourcesValueResourceId {
|
|
841
|
-
}
|
|
1122
|
+
export type ListOrgRolesSuccessResponseValueValueRolesEnum = typeof ListOrgRolesSuccessResponseValueValueRolesEnum[keyof typeof ListOrgRolesSuccessResponseValueValueRolesEnum];
|
|
842
1123
|
/**
|
|
843
|
-
*
|
|
1124
|
+
* Successful permissions retrieval response
|
|
844
1125
|
* @export
|
|
845
|
-
* @interface
|
|
1126
|
+
* @interface ListPermissionsSuccessResponse
|
|
846
1127
|
*/
|
|
847
|
-
export interface
|
|
1128
|
+
export interface ListPermissionsSuccessResponse {
|
|
848
1129
|
/**
|
|
849
1130
|
*
|
|
850
|
-
* @type {
|
|
851
|
-
* @memberof
|
|
1131
|
+
* @type {Permissions & Array<Permissions>}
|
|
1132
|
+
* @memberof ListPermissionsSuccessResponse
|
|
852
1133
|
*/
|
|
853
|
-
'
|
|
1134
|
+
'permissions': Permissions & Array<Permissions>;
|
|
854
1135
|
}
|
|
855
1136
|
/**
|
|
856
|
-
*
|
|
1137
|
+
* Successful roles retrieval response
|
|
857
1138
|
* @export
|
|
858
|
-
* @interface
|
|
1139
|
+
* @interface ListRolesSuccessResponse
|
|
859
1140
|
*/
|
|
860
|
-
export interface
|
|
861
|
-
/**
|
|
862
|
-
*
|
|
863
|
-
* @type {string}
|
|
864
|
-
* @memberof PathParams
|
|
865
|
-
*/
|
|
866
|
-
'orgId': string;
|
|
1141
|
+
export interface ListRolesSuccessResponse {
|
|
867
1142
|
/**
|
|
868
|
-
*
|
|
869
|
-
* @type {
|
|
870
|
-
* @memberof
|
|
1143
|
+
* List of named roles
|
|
1144
|
+
* @type {Array<RoleNames>}
|
|
1145
|
+
* @memberof ListRolesSuccessResponse
|
|
871
1146
|
*/
|
|
872
|
-
'
|
|
1147
|
+
'roles': Array<RoleNames>;
|
|
873
1148
|
}
|
|
874
1149
|
/**
|
|
875
|
-
*
|
|
1150
|
+
* Permissions
|
|
876
1151
|
* @export
|
|
877
1152
|
* @enum {string}
|
|
878
1153
|
*/
|
|
@@ -1101,8 +1376,31 @@ export declare const Permissions: {
|
|
|
1101
1376
|
readonly CreateOrg: "CreateOrg";
|
|
1102
1377
|
readonly EditOrg: "EditOrg";
|
|
1103
1378
|
readonly ViewOrg: "ViewOrg";
|
|
1379
|
+
readonly ViewWebhooks: "ViewWebhooks";
|
|
1380
|
+
readonly EditWebhooks: "EditWebhooks";
|
|
1381
|
+
readonly RoleAdmin: "RoleAdmin";
|
|
1382
|
+
readonly RoleFactory: "RoleFactory";
|
|
1104
1383
|
};
|
|
1105
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
|
+
}
|
|
1106
1404
|
/**
|
|
1107
1405
|
* Details for revoking a forbidden role from a principal
|
|
1108
1406
|
* @export
|
|
@@ -1251,24 +1549,15 @@ export interface RevokeRoleSuccessResponse {
|
|
|
1251
1549
|
'message': string;
|
|
1252
1550
|
}
|
|
1253
1551
|
/**
|
|
1254
|
-
*
|
|
1552
|
+
* Role names
|
|
1255
1553
|
* @export
|
|
1256
|
-
* @
|
|
1554
|
+
* @enum {string}
|
|
1257
1555
|
*/
|
|
1258
|
-
export
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
|
-
*/
|
|
1264
|
-
'name': string;
|
|
1265
|
-
/**
|
|
1266
|
-
*
|
|
1267
|
-
* @type {Permissions & Array<string>}
|
|
1268
|
-
* @memberof RolesInner
|
|
1269
|
-
*/
|
|
1270
|
-
'permissions': Permissions & Array<string>;
|
|
1271
|
-
}
|
|
1556
|
+
export declare const RoleNames: {
|
|
1557
|
+
readonly Admin: "Admin";
|
|
1558
|
+
readonly Factory: "Factory";
|
|
1559
|
+
};
|
|
1560
|
+
export type RoleNames = typeof RoleNames[keyof typeof RoleNames];
|
|
1272
1561
|
/**
|
|
1273
1562
|
*
|
|
1274
1563
|
* @export
|
|
@@ -1301,205 +1590,582 @@ export interface ValidationErrorsInnerPathInner {
|
|
|
1301
1590
|
*/
|
|
1302
1591
|
export declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1303
1592
|
/**
|
|
1304
|
-
* Authenticate and authorize a user to perform an action
|
|
1305
|
-
* @summary Authenticate and authorize Request
|
|
1306
|
-
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
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
|
|
1839
|
+
* @export
|
|
1840
|
+
*/
|
|
1841
|
+
export declare const AuthorizedEntitiesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1842
|
+
/**
|
|
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]
|
|
1307
1864
|
* @param {*} [options] Override http request option.
|
|
1308
1865
|
* @throws {RequiredError}
|
|
1309
1866
|
*/
|
|
1310
|
-
|
|
1867
|
+
getAuthorizedProperties: (orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1311
1868
|
};
|
|
1312
1869
|
/**
|
|
1313
|
-
*
|
|
1870
|
+
* AuthorizedEntitiesApi - functional programming interface
|
|
1314
1871
|
* @export
|
|
1315
1872
|
*/
|
|
1316
|
-
export declare const
|
|
1873
|
+
export declare const AuthorizedEntitiesApiFp: (configuration?: Configuration) => {
|
|
1317
1874
|
/**
|
|
1318
|
-
*
|
|
1319
|
-
* @summary
|
|
1320
|
-
* @param {
|
|
1875
|
+
* Get the authorized brands for a given org
|
|
1876
|
+
* @summary Get Authorized Brands
|
|
1877
|
+
* @param {string} orgId
|
|
1878
|
+
* @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
|
|
1321
1879
|
* @param {*} [options] Override http request option.
|
|
1322
1880
|
* @throws {RequiredError}
|
|
1323
1881
|
*/
|
|
1324
|
-
|
|
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]
|
|
1896
|
+
* @param {*} [options] Override http request option.
|
|
1897
|
+
* @throws {RequiredError}
|
|
1898
|
+
*/
|
|
1899
|
+
getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedPropertiesResponse>>;
|
|
1325
1900
|
};
|
|
1326
1901
|
/**
|
|
1327
|
-
*
|
|
1902
|
+
* AuthorizedEntitiesApi - factory interface
|
|
1328
1903
|
* @export
|
|
1329
1904
|
*/
|
|
1330
|
-
export declare const
|
|
1905
|
+
export declare const AuthorizedEntitiesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1331
1906
|
/**
|
|
1332
|
-
*
|
|
1333
|
-
* @summary
|
|
1334
|
-
* @param {
|
|
1907
|
+
* Get the authorized brands for a given org
|
|
1908
|
+
* @summary Get Authorized Brands
|
|
1909
|
+
* @param {string} orgId
|
|
1910
|
+
* @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
|
|
1335
1911
|
* @param {*} [options] Override http request option.
|
|
1336
1912
|
* @throws {RequiredError}
|
|
1337
1913
|
*/
|
|
1338
|
-
|
|
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]
|
|
1928
|
+
* @param {*} [options] Override http request option.
|
|
1929
|
+
* @throws {RequiredError}
|
|
1930
|
+
*/
|
|
1931
|
+
getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedPropertiesResponse>;
|
|
1339
1932
|
};
|
|
1340
1933
|
/**
|
|
1341
|
-
*
|
|
1934
|
+
* AuthorizedEntitiesApi - object-oriented interface
|
|
1342
1935
|
* @export
|
|
1343
|
-
* @class
|
|
1936
|
+
* @class AuthorizedEntitiesApi
|
|
1344
1937
|
* @extends {BaseAPI}
|
|
1345
1938
|
*/
|
|
1346
|
-
export declare class
|
|
1939
|
+
export declare class AuthorizedEntitiesApi extends BaseAPI {
|
|
1347
1940
|
/**
|
|
1348
|
-
*
|
|
1349
|
-
* @summary
|
|
1350
|
-
* @param {
|
|
1941
|
+
* Get the authorized brands for a given org
|
|
1942
|
+
* @summary Get Authorized Brands
|
|
1943
|
+
* @param {string} orgId
|
|
1944
|
+
* @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
|
|
1351
1945
|
* @param {*} [options] Override http request option.
|
|
1352
1946
|
* @throws {RequiredError}
|
|
1353
|
-
* @memberof
|
|
1947
|
+
* @memberof AuthorizedEntitiesApi
|
|
1354
1948
|
*/
|
|
1355
|
-
|
|
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
|
|
1967
|
+
*/
|
|
1968
|
+
getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAuthorizedPropertiesResponse, any, {}>>;
|
|
1356
1969
|
}
|
|
1357
1970
|
/**
|
|
1358
|
-
*
|
|
1971
|
+
* ConfigurationDataApi - axios parameter creator
|
|
1359
1972
|
* @export
|
|
1360
1973
|
*/
|
|
1361
|
-
export declare const
|
|
1974
|
+
export declare const ConfigurationDataApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1362
1975
|
/**
|
|
1363
|
-
*
|
|
1364
|
-
* @summary
|
|
1365
|
-
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
1976
|
+
* List the available feature based roles
|
|
1977
|
+
* @summary List Feature Based Roles
|
|
1366
1978
|
* @param {*} [options] Override http request option.
|
|
1367
1979
|
* @throws {RequiredError}
|
|
1368
1980
|
*/
|
|
1369
|
-
|
|
1981
|
+
configListFeatureBasedRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1370
1982
|
/**
|
|
1371
|
-
*
|
|
1372
|
-
* @summary
|
|
1373
|
-
* @param {AuthorizationRequest} [authorizationRequest]
|
|
1983
|
+
* List the available permissions
|
|
1984
|
+
* @summary List Permissions
|
|
1374
1985
|
* @param {*} [options] Override http request option.
|
|
1375
1986
|
* @throws {RequiredError}
|
|
1376
1987
|
*/
|
|
1377
|
-
|
|
1378
|
-
};
|
|
1379
|
-
/**
|
|
1380
|
-
* AuthorizationApi - functional programming interface
|
|
1381
|
-
* @export
|
|
1382
|
-
*/
|
|
1383
|
-
export declare const AuthorizationApiFp: (configuration?: Configuration) => {
|
|
1988
|
+
configListPermissions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1384
1989
|
/**
|
|
1385
|
-
*
|
|
1386
|
-
* @summary
|
|
1387
|
-
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
1990
|
+
* List the available roles
|
|
1991
|
+
* @summary List Roles
|
|
1388
1992
|
* @param {*} [options] Override http request option.
|
|
1389
1993
|
* @throws {RequiredError}
|
|
1390
1994
|
*/
|
|
1391
|
-
|
|
1995
|
+
configListRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1392
1996
|
/**
|
|
1393
|
-
*
|
|
1394
|
-
* @summary
|
|
1395
|
-
* @param {AuthorizationRequest} [authorizationRequest]
|
|
1997
|
+
* List the available feature based roles
|
|
1998
|
+
* @summary List Feature Based Roles
|
|
1396
1999
|
* @param {*} [options] Override http request option.
|
|
1397
2000
|
* @throws {RequiredError}
|
|
1398
2001
|
*/
|
|
1399
|
-
|
|
1400
|
-
};
|
|
1401
|
-
/**
|
|
1402
|
-
* AuthorizationApi - factory interface
|
|
1403
|
-
* @export
|
|
1404
|
-
*/
|
|
1405
|
-
export declare const AuthorizationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2002
|
+
listFeatureBasedRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1406
2003
|
/**
|
|
1407
|
-
*
|
|
1408
|
-
* @summary
|
|
1409
|
-
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
2004
|
+
* List the available permissions
|
|
2005
|
+
* @summary List Permissions
|
|
1410
2006
|
* @param {*} [options] Override http request option.
|
|
1411
2007
|
* @throws {RequiredError}
|
|
1412
2008
|
*/
|
|
1413
|
-
|
|
2009
|
+
listPermissions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1414
2010
|
/**
|
|
1415
|
-
*
|
|
1416
|
-
* @summary
|
|
1417
|
-
* @param {AuthorizationRequest} [authorizationRequest]
|
|
2011
|
+
* List the available roles
|
|
2012
|
+
* @summary List Roles
|
|
1418
2013
|
* @param {*} [options] Override http request option.
|
|
1419
2014
|
* @throws {RequiredError}
|
|
1420
2015
|
*/
|
|
1421
|
-
|
|
2016
|
+
listRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1422
2017
|
};
|
|
1423
2018
|
/**
|
|
1424
|
-
*
|
|
2019
|
+
* ConfigurationDataApi - functional programming interface
|
|
1425
2020
|
* @export
|
|
1426
|
-
* @class AuthorizationApi
|
|
1427
|
-
* @extends {BaseAPI}
|
|
1428
2021
|
*/
|
|
1429
|
-
export declare
|
|
2022
|
+
export declare const ConfigurationDataApiFp: (configuration?: Configuration) => {
|
|
1430
2023
|
/**
|
|
1431
|
-
*
|
|
1432
|
-
* @summary
|
|
1433
|
-
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
2024
|
+
* List the available feature based roles
|
|
2025
|
+
* @summary List Feature Based Roles
|
|
1434
2026
|
* @param {*} [options] Override http request option.
|
|
1435
2027
|
* @throws {RequiredError}
|
|
1436
|
-
* @memberof AuthorizationApi
|
|
1437
2028
|
*/
|
|
1438
|
-
|
|
2029
|
+
configListFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFeatureBasedRolesSuccessResponse>>;
|
|
1439
2030
|
/**
|
|
1440
|
-
*
|
|
1441
|
-
* @summary
|
|
1442
|
-
* @param {AuthorizationRequest} [authorizationRequest]
|
|
2031
|
+
* List the available permissions
|
|
2032
|
+
* @summary List Permissions
|
|
1443
2033
|
* @param {*} [options] Override http request option.
|
|
1444
2034
|
* @throws {RequiredError}
|
|
1445
|
-
* @memberof AuthorizationApi
|
|
1446
2035
|
*/
|
|
1447
|
-
|
|
1448
|
-
|
|
1449
|
-
|
|
1450
|
-
|
|
1451
|
-
*
|
|
1452
|
-
|
|
1453
|
-
|
|
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>>;
|
|
1454
2051
|
/**
|
|
1455
2052
|
* List the available permissions
|
|
1456
2053
|
* @summary List Permissions
|
|
1457
2054
|
* @param {*} [options] Override http request option.
|
|
1458
2055
|
* @throws {RequiredError}
|
|
1459
2056
|
*/
|
|
1460
|
-
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>>;
|
|
1461
2065
|
};
|
|
1462
2066
|
/**
|
|
1463
|
-
*
|
|
2067
|
+
* ConfigurationDataApi - factory interface
|
|
1464
2068
|
* @export
|
|
1465
2069
|
*/
|
|
1466
|
-
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>;
|
|
1467
2078
|
/**
|
|
1468
2079
|
* List the available permissions
|
|
1469
2080
|
* @summary List Permissions
|
|
1470
2081
|
* @param {*} [options] Override http request option.
|
|
1471
2082
|
* @throws {RequiredError}
|
|
1472
2083
|
*/
|
|
1473
|
-
|
|
1474
|
-
|
|
1475
|
-
|
|
1476
|
-
|
|
1477
|
-
*
|
|
1478
|
-
|
|
1479
|
-
|
|
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>;
|
|
1480
2099
|
/**
|
|
1481
2100
|
* List the available permissions
|
|
1482
2101
|
* @summary List Permissions
|
|
1483
2102
|
* @param {*} [options] Override http request option.
|
|
1484
2103
|
* @throws {RequiredError}
|
|
1485
2104
|
*/
|
|
1486
|
-
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>;
|
|
1487
2113
|
};
|
|
1488
2114
|
/**
|
|
1489
|
-
*
|
|
2115
|
+
* ConfigurationDataApi - object-oriented interface
|
|
1490
2116
|
* @export
|
|
1491
|
-
* @class
|
|
2117
|
+
* @class ConfigurationDataApi
|
|
1492
2118
|
* @extends {BaseAPI}
|
|
1493
2119
|
*/
|
|
1494
|
-
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, {}>>;
|
|
1495
2153
|
/**
|
|
1496
2154
|
* List the available permissions
|
|
1497
2155
|
* @summary List Permissions
|
|
1498
2156
|
* @param {*} [options] Override http request option.
|
|
1499
2157
|
* @throws {RequiredError}
|
|
1500
|
-
* @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
|
|
1501
2167
|
*/
|
|
1502
|
-
|
|
2168
|
+
listRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRolesSuccessResponse, any, {}>>;
|
|
1503
2169
|
}
|
|
1504
2170
|
/**
|
|
1505
2171
|
* RoleAssignmentApi - axios parameter creator
|
|
@@ -1643,7 +2309,7 @@ export declare class RoleAssignmentApi extends BaseAPI {
|
|
|
1643
2309
|
* @throws {RequiredError}
|
|
1644
2310
|
* @memberof RoleAssignmentApi
|
|
1645
2311
|
*/
|
|
1646
|
-
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, {}>>;
|
|
1647
2313
|
/**
|
|
1648
2314
|
* Get the active roles for a given principal
|
|
1649
2315
|
* @summary Get Principal Roles
|
|
@@ -1653,7 +2319,7 @@ export declare class RoleAssignmentApi extends BaseAPI {
|
|
|
1653
2319
|
* @throws {RequiredError}
|
|
1654
2320
|
* @memberof RoleAssignmentApi
|
|
1655
2321
|
*/
|
|
1656
|
-
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, {}>>;
|
|
1657
2323
|
/**
|
|
1658
2324
|
* Revokes a forbidden role from a given principal (user, group, etc.)
|
|
1659
2325
|
* @summary Revoke Forbidden Role from Principal
|
|
@@ -1663,7 +2329,7 @@ export declare class RoleAssignmentApi extends BaseAPI {
|
|
|
1663
2329
|
* @throws {RequiredError}
|
|
1664
2330
|
* @memberof RoleAssignmentApi
|
|
1665
2331
|
*/
|
|
1666
|
-
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, {}>>;
|
|
1667
2333
|
/**
|
|
1668
2334
|
* Revokes a specified role from a given principal (user, group, etc.)
|
|
1669
2335
|
* @summary Revoke Role from Principal
|
|
@@ -1673,13 +2339,88 @@ export declare class RoleAssignmentApi extends BaseAPI {
|
|
|
1673
2339
|
* @throws {RequiredError}
|
|
1674
2340
|
* @memberof RoleAssignmentApi
|
|
1675
2341
|
*/
|
|
1676
|
-
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, {}>>;
|
|
1677
2402
|
}
|
|
1678
2403
|
/**
|
|
1679
2404
|
* UserPermissionsApi - axios parameter creator
|
|
1680
2405
|
* @export
|
|
1681
2406
|
*/
|
|
1682
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>;
|
|
1683
2424
|
/**
|
|
1684
2425
|
* List the available permissions for the current user
|
|
1685
2426
|
* @summary List Own Permissions
|
|
@@ -1703,6 +2444,30 @@ export declare const UserPermissionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
1703
2444
|
* @export
|
|
1704
2445
|
*/
|
|
1705
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
|
+
}>>;
|
|
1706
2471
|
/**
|
|
1707
2472
|
* List the available permissions for the current user
|
|
1708
2473
|
* @summary List Own Permissions
|
|
@@ -1726,6 +2491,30 @@ export declare const UserPermissionsApiFp: (configuration?: Configuration) => {
|
|
|
1726
2491
|
* @export
|
|
1727
2492
|
*/
|
|
1728
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
|
+
}>;
|
|
1729
2518
|
/**
|
|
1730
2519
|
* List the available permissions for the current user
|
|
1731
2520
|
* @summary List Own Permissions
|
|
@@ -1751,6 +2540,32 @@ export declare const UserPermissionsApiFactory: (configuration?: Configuration,
|
|
|
1751
2540
|
* @extends {BaseAPI}
|
|
1752
2541
|
*/
|
|
1753
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, {}>>;
|
|
1754
2569
|
/**
|
|
1755
2570
|
* List the available permissions for the current user
|
|
1756
2571
|
* @summary List Own Permissions
|
|
@@ -1759,7 +2574,7 @@ export declare class UserPermissionsApi extends BaseAPI {
|
|
|
1759
2574
|
* @throws {RequiredError}
|
|
1760
2575
|
* @memberof UserPermissionsApi
|
|
1761
2576
|
*/
|
|
1762
|
-
listOwnPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any>>;
|
|
2577
|
+
listOwnPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any, {}>>;
|
|
1763
2578
|
/**
|
|
1764
2579
|
* List the available permissions for a given user
|
|
1765
2580
|
* @summary List User Permissions
|
|
@@ -1769,5 +2584,5 @@ export declare class UserPermissionsApi extends BaseAPI {
|
|
|
1769
2584
|
* @throws {RequiredError}
|
|
1770
2585
|
* @memberof UserPermissionsApi
|
|
1771
2586
|
*/
|
|
1772
|
-
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, {}>>;
|
|
1773
2588
|
}
|