@flipdish/authorization 0.2.38 → 0.2.40-rc.1781267640
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/api.ts +369 -2079
- package/configuration.ts +1 -1
- package/dist/api.d.ts +311 -1377
- package/dist/api.js +358 -2033
- package/dist/configuration.js +1 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -13,125 +13,6 @@ import type { Configuration } from './configuration';
|
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import type { RequestArgs } from './base';
|
|
15
15
|
import { BaseAPI } from './base';
|
|
16
|
-
/**
|
|
17
|
-
* Details for assigning a role to a principal
|
|
18
|
-
* @export
|
|
19
|
-
* @interface AssignRoleRequestBody
|
|
20
|
-
*/
|
|
21
|
-
export interface AssignRoleRequestBody {
|
|
22
|
-
/**
|
|
23
|
-
*
|
|
24
|
-
* @type {string}
|
|
25
|
-
* @memberof AssignRoleRequestBody
|
|
26
|
-
*/
|
|
27
|
-
'role': AssignRoleRequestBodyRoleEnum;
|
|
28
|
-
/**
|
|
29
|
-
*
|
|
30
|
-
* @type {AuthorizationRequestResource}
|
|
31
|
-
* @memberof AssignRoleRequestBody
|
|
32
|
-
*/
|
|
33
|
-
'resource': AuthorizationRequestResource;
|
|
34
|
-
/**
|
|
35
|
-
*
|
|
36
|
-
* @type {AuthorizationRequestPrincipal}
|
|
37
|
-
* @memberof AssignRoleRequestBody
|
|
38
|
-
*/
|
|
39
|
-
'principal': AuthorizationRequestPrincipal;
|
|
40
|
-
/**
|
|
41
|
-
*
|
|
42
|
-
* @type {string}
|
|
43
|
-
* @memberof AssignRoleRequestBody
|
|
44
|
-
*/
|
|
45
|
-
'brandId': string;
|
|
46
|
-
}
|
|
47
|
-
export declare const AssignRoleRequestBodyRoleEnum: {
|
|
48
|
-
readonly OrgViewer: "OrgViewer";
|
|
49
|
-
readonly OrgManager: "OrgManager";
|
|
50
|
-
readonly OrgAdmin: "OrgAdmin";
|
|
51
|
-
readonly BrandViewer: "BrandViewer";
|
|
52
|
-
readonly BrandManager: "BrandManager";
|
|
53
|
-
readonly BrandAdmin: "BrandAdmin";
|
|
54
|
-
readonly StoreViewer: "StoreViewer";
|
|
55
|
-
readonly StoreEditor: "StoreEditor";
|
|
56
|
-
readonly StoreManager: "StoreManager";
|
|
57
|
-
readonly CustomerViewer: "CustomerViewer";
|
|
58
|
-
readonly CustomerManager: "CustomerManager";
|
|
59
|
-
readonly VoucherViewer: "VoucherViewer";
|
|
60
|
-
readonly VoucherEditor: "VoucherEditor";
|
|
61
|
-
readonly VoucherManager: "VoucherManager";
|
|
62
|
-
readonly VoucherCampaignManager: "VoucherCampaignManager";
|
|
63
|
-
readonly VoucherStatisticsViewer: "VoucherStatisticsViewer";
|
|
64
|
-
readonly AnalyticsViewer: "AnalyticsViewer";
|
|
65
|
-
readonly ReportsViewer: "ReportsViewer";
|
|
66
|
-
readonly FinanceViewer: "FinanceViewer";
|
|
67
|
-
readonly FinanceManager: "FinanceManager";
|
|
68
|
-
readonly TeamViewer: "TeamViewer";
|
|
69
|
-
readonly TeamManager: "TeamManager";
|
|
70
|
-
readonly TeamAdmin: "TeamAdmin";
|
|
71
|
-
readonly TechViewer: "TechViewer";
|
|
72
|
-
readonly TechManager: "TechManager";
|
|
73
|
-
readonly AppStoreViewer: "AppStoreViewer";
|
|
74
|
-
readonly AppStoreManager: "AppStoreManager";
|
|
75
|
-
readonly SalesChannelViewer: "SalesChannelViewer";
|
|
76
|
-
readonly SalesChannelEditor: "SalesChannelEditor";
|
|
77
|
-
readonly SalesChannelManager: "SalesChannelManager";
|
|
78
|
-
readonly DeliveryViewer: "DeliveryViewer";
|
|
79
|
-
readonly DeliveryManager: "DeliveryManager";
|
|
80
|
-
readonly DriverManager: "DriverManager";
|
|
81
|
-
readonly AuditViewer: "AuditViewer";
|
|
82
|
-
readonly AuditManager: "AuditManager";
|
|
83
|
-
readonly AccountsViewer: "AccountsViewer";
|
|
84
|
-
readonly AccountsEditor: "AccountsEditor";
|
|
85
|
-
readonly DocumentExplorerViewer: "DocumentExplorerViewer";
|
|
86
|
-
readonly DocumentExplorerEditor: "DocumentExplorerEditor";
|
|
87
|
-
readonly PayrollViewer: "PayrollViewer";
|
|
88
|
-
readonly PayrollEditor: "PayrollEditor";
|
|
89
|
-
readonly PropertyViewer: "PropertyViewer";
|
|
90
|
-
readonly PropertyManager: "PropertyManager";
|
|
91
|
-
readonly PropertyAdmin: "PropertyAdmin";
|
|
92
|
-
readonly WebsiteContentEditor: "WebsiteContentEditor";
|
|
93
|
-
readonly WebsiteContentViewer: "WebsiteContentViewer";
|
|
94
|
-
readonly WebsiteTechViewer: "WebsiteTechViewer";
|
|
95
|
-
readonly MenuViewer: "MenuViewer";
|
|
96
|
-
readonly MenuEditor: "MenuEditor";
|
|
97
|
-
readonly MenuManager: "MenuManager";
|
|
98
|
-
readonly MenuMetaFieldManager: "MenuMetaFieldManager";
|
|
99
|
-
readonly MenuMetaFieldEditor: "MenuMetaFieldEditor";
|
|
100
|
-
readonly MenuMetaFieldViewer: "MenuMetaFieldViewer";
|
|
101
|
-
readonly StoreDeliveryZoneManager: "StoreDeliveryZoneManager";
|
|
102
|
-
readonly StoreDeliveryZoneEditor: "StoreDeliveryZoneEditor";
|
|
103
|
-
readonly StoreDeliveryZoneViewer: "StoreDeliveryZoneViewer";
|
|
104
|
-
readonly OrderFulfillmentManager: "OrderFulfillmentManager";
|
|
105
|
-
readonly OrderManager: "OrderManager";
|
|
106
|
-
readonly OrderEditor: "OrderEditor";
|
|
107
|
-
readonly OrderViewer: "OrderViewer";
|
|
108
|
-
readonly InventoryManager: "InventoryManager";
|
|
109
|
-
readonly InventoryEditor: "InventoryEditor";
|
|
110
|
-
readonly InventoryViewer: "InventoryViewer";
|
|
111
|
-
readonly PaymentManager: "PaymentManager";
|
|
112
|
-
readonly OnboardingManager: "OnboardingManager";
|
|
113
|
-
readonly FeatureFlagManager: "FeatureFlagManager";
|
|
114
|
-
readonly PropertyOwnerMisc: "PropertyOwnerMisc";
|
|
115
|
-
readonly ManagedOwnerMisc: "ManagedOwnerMisc";
|
|
116
|
-
readonly IntegratorMisc: "IntegratorMisc";
|
|
117
|
-
readonly PropertyManagerMisc: "PropertyManagerMisc";
|
|
118
|
-
readonly FinanceManagerMisc: "FinanceManagerMisc";
|
|
119
|
-
readonly SupportMisc: "SupportMisc";
|
|
120
|
-
};
|
|
121
|
-
export type AssignRoleRequestBodyRoleEnum = typeof AssignRoleRequestBodyRoleEnum[keyof typeof AssignRoleRequestBodyRoleEnum];
|
|
122
|
-
/**
|
|
123
|
-
* Successful role assignment response
|
|
124
|
-
* @export
|
|
125
|
-
* @interface AssignRoleSuccessResponse
|
|
126
|
-
*/
|
|
127
|
-
export interface AssignRoleSuccessResponse {
|
|
128
|
-
/**
|
|
129
|
-
* Confirmation message
|
|
130
|
-
* @type {string}
|
|
131
|
-
* @memberof AssignRoleSuccessResponse
|
|
132
|
-
*/
|
|
133
|
-
'message': string;
|
|
134
|
-
}
|
|
135
16
|
/**
|
|
136
17
|
* 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
18
|
* @export
|
|
@@ -572,25 +453,6 @@ export interface ErrorResponse {
|
|
|
572
453
|
*/
|
|
573
454
|
'message': string;
|
|
574
455
|
}
|
|
575
|
-
/**
|
|
576
|
-
* Feature based role and its permissions
|
|
577
|
-
* @export
|
|
578
|
-
* @interface FeatureBasedRole
|
|
579
|
-
*/
|
|
580
|
-
export interface FeatureBasedRole {
|
|
581
|
-
/**
|
|
582
|
-
* Name of the role
|
|
583
|
-
* @type {string}
|
|
584
|
-
* @memberof FeatureBasedRole
|
|
585
|
-
*/
|
|
586
|
-
'name': string;
|
|
587
|
-
/**
|
|
588
|
-
*
|
|
589
|
-
* @type {Permissions & Array<Permissions>}
|
|
590
|
-
* @memberof FeatureBasedRole
|
|
591
|
-
*/
|
|
592
|
-
'permissions': Permissions & Array<Permissions>;
|
|
593
|
-
}
|
|
594
456
|
/**
|
|
595
457
|
* 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.
|
|
596
458
|
* @export
|
|
@@ -771,144 +633,6 @@ export interface GetAuthorizedPropertiesResponse {
|
|
|
771
633
|
*/
|
|
772
634
|
'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
773
635
|
}
|
|
774
|
-
/**
|
|
775
|
-
* Details for getting roles for a principal
|
|
776
|
-
* @export
|
|
777
|
-
* @interface GetPrincipalRolesRequestBody
|
|
778
|
-
*/
|
|
779
|
-
export interface GetPrincipalRolesRequestBody {
|
|
780
|
-
/**
|
|
781
|
-
*
|
|
782
|
-
* @type {AuthorizationRequestPrincipal}
|
|
783
|
-
* @memberof GetPrincipalRolesRequestBody
|
|
784
|
-
*/
|
|
785
|
-
'principal': AuthorizationRequestPrincipal;
|
|
786
|
-
/**
|
|
787
|
-
*
|
|
788
|
-
* @type {AuthorizationRequestResource}
|
|
789
|
-
* @memberof GetPrincipalRolesRequestBody
|
|
790
|
-
*/
|
|
791
|
-
'resource'?: AuthorizationRequestResource;
|
|
792
|
-
}
|
|
793
|
-
/**
|
|
794
|
-
* Successful roles retrieval response
|
|
795
|
-
* @export
|
|
796
|
-
* @interface GetPrincipalRolesSuccessResponse
|
|
797
|
-
*/
|
|
798
|
-
export interface GetPrincipalRolesSuccessResponse {
|
|
799
|
-
/**
|
|
800
|
-
* List of roles assigned to the principal
|
|
801
|
-
* @type {Array<GetPrincipalRolesSuccessResponseRolesInner>}
|
|
802
|
-
* @memberof GetPrincipalRolesSuccessResponse
|
|
803
|
-
*/
|
|
804
|
-
'roles': Array<GetPrincipalRolesSuccessResponseRolesInner>;
|
|
805
|
-
}
|
|
806
|
-
/**
|
|
807
|
-
*
|
|
808
|
-
* @export
|
|
809
|
-
* @interface GetPrincipalRolesSuccessResponseRolesInner
|
|
810
|
-
*/
|
|
811
|
-
export interface GetPrincipalRolesSuccessResponseRolesInner {
|
|
812
|
-
/**
|
|
813
|
-
* Policy ID
|
|
814
|
-
* @type {string}
|
|
815
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
816
|
-
*/
|
|
817
|
-
'policyId': string;
|
|
818
|
-
/**
|
|
819
|
-
*
|
|
820
|
-
* @type {GetPrincipalRolesSuccessResponseRolesInnerRoleName}
|
|
821
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
822
|
-
*/
|
|
823
|
-
'roleName': GetPrincipalRolesSuccessResponseRolesInnerRoleName;
|
|
824
|
-
/**
|
|
825
|
-
* Policy type
|
|
826
|
-
* @type {string}
|
|
827
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
828
|
-
*/
|
|
829
|
-
'policyType': GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum;
|
|
830
|
-
/**
|
|
831
|
-
* Date and time the role was assigned
|
|
832
|
-
* @type {string}
|
|
833
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
834
|
-
*/
|
|
835
|
-
'assignedAt': string;
|
|
836
|
-
/**
|
|
837
|
-
* User who assigned the role
|
|
838
|
-
* @type {string}
|
|
839
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
840
|
-
*/
|
|
841
|
-
'assignedBy': string;
|
|
842
|
-
/**
|
|
843
|
-
* Type of resource the role is assigned to
|
|
844
|
-
* @type {string}
|
|
845
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
846
|
-
*/
|
|
847
|
-
'resourceType'?: GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum;
|
|
848
|
-
/**
|
|
849
|
-
* Organization ID
|
|
850
|
-
* @type {string}
|
|
851
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
852
|
-
*/
|
|
853
|
-
'orgId'?: string;
|
|
854
|
-
/**
|
|
855
|
-
* Property ID
|
|
856
|
-
* @type {string}
|
|
857
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
858
|
-
*/
|
|
859
|
-
'propertyId'?: string;
|
|
860
|
-
/**
|
|
861
|
-
* Brand ID this role is scoped to
|
|
862
|
-
* @type {string}
|
|
863
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
864
|
-
*/
|
|
865
|
-
'brandId'?: string;
|
|
866
|
-
/**
|
|
867
|
-
* Sales channel ID this role is scoped to
|
|
868
|
-
* @type {string}
|
|
869
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
870
|
-
*/
|
|
871
|
-
'salesChannelId'?: string;
|
|
872
|
-
/**
|
|
873
|
-
* Principal ID this role is assigned to
|
|
874
|
-
* @type {string}
|
|
875
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
876
|
-
*/
|
|
877
|
-
'principalId': string;
|
|
878
|
-
/**
|
|
879
|
-
* Type of principal this role is assigned to
|
|
880
|
-
* @type {string}
|
|
881
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
882
|
-
*/
|
|
883
|
-
'principalType': GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum;
|
|
884
|
-
}
|
|
885
|
-
export declare const GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum: {
|
|
886
|
-
readonly Main: "Main";
|
|
887
|
-
readonly BrandOverride: "BrandOverride";
|
|
888
|
-
readonly OrgOverride: "OrgOverride";
|
|
889
|
-
readonly Forbidden: "Forbidden";
|
|
890
|
-
readonly NamedRole: "NamedRole";
|
|
891
|
-
};
|
|
892
|
-
export type GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum];
|
|
893
|
-
export declare const GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum: {
|
|
894
|
-
readonly Property: "Property";
|
|
895
|
-
readonly Org: "Org";
|
|
896
|
-
readonly Brand: "Brand";
|
|
897
|
-
readonly SalesChannel: "SalesChannel";
|
|
898
|
-
};
|
|
899
|
-
export type GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum];
|
|
900
|
-
export declare const GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum: {
|
|
901
|
-
readonly User: "User";
|
|
902
|
-
readonly Automation: "Automation";
|
|
903
|
-
};
|
|
904
|
-
export type GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum];
|
|
905
|
-
/**
|
|
906
|
-
* Role name
|
|
907
|
-
* @export
|
|
908
|
-
* @interface GetPrincipalRolesSuccessResponseRolesInnerRoleName
|
|
909
|
-
*/
|
|
910
|
-
export interface GetPrincipalRolesSuccessResponseRolesInnerRoleName {
|
|
911
|
-
}
|
|
912
636
|
/**
|
|
913
637
|
* Successful user permissions retrieval response
|
|
914
638
|
* @export
|
|
@@ -963,64 +687,6 @@ export type GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = ty
|
|
|
963
687
|
*/
|
|
964
688
|
export interface GetUserPermissionsSuccessResponseResourcesValueResourceId {
|
|
965
689
|
}
|
|
966
|
-
/**
|
|
967
|
-
* Grant teammate app access to a user being assigned within a brand for the first time.
|
|
968
|
-
* @export
|
|
969
|
-
* @interface GrantTeammateAccessRequestBody
|
|
970
|
-
*/
|
|
971
|
-
export interface GrantTeammateAccessRequestBody {
|
|
972
|
-
/**
|
|
973
|
-
* Teammate app access level (role)
|
|
974
|
-
* @type {string}
|
|
975
|
-
* @memberof GrantTeammateAccessRequestBody
|
|
976
|
-
*/
|
|
977
|
-
'appAccessLevel': GrantTeammateAccessRequestBodyAppAccessLevelEnum;
|
|
978
|
-
/**
|
|
979
|
-
* Brand identifier (AppId); normalized to lowercase when stored
|
|
980
|
-
* @type {string}
|
|
981
|
-
* @memberof GrantTeammateAccessRequestBody
|
|
982
|
-
*/
|
|
983
|
-
'brandId': string;
|
|
984
|
-
/**
|
|
985
|
-
* Org-wide store access; when false, propertyIds are required for property-scoped roles
|
|
986
|
-
* @type {boolean}
|
|
987
|
-
* @memberof GrantTeammateAccessRequestBody
|
|
988
|
-
*/
|
|
989
|
-
'hasAccessToAllStores': boolean;
|
|
990
|
-
/**
|
|
991
|
-
* Property resource ids (e.g. p123) when scoped to properties
|
|
992
|
-
* @type {Array<string>}
|
|
993
|
-
* @memberof GrantTeammateAccessRequestBody
|
|
994
|
-
*/
|
|
995
|
-
'propertyIds'?: Array<string>;
|
|
996
|
-
/**
|
|
997
|
-
* Optional v2 permission set keys to apply to this teammate role
|
|
998
|
-
* @type {Array<string>}
|
|
999
|
-
* @memberof GrantTeammateAccessRequestBody
|
|
1000
|
-
*/
|
|
1001
|
-
'optionalPermissionSetKeys'?: Array<string>;
|
|
1002
|
-
/**
|
|
1003
|
-
* Target user email; persisted on first assignment only
|
|
1004
|
-
* @type {string}
|
|
1005
|
-
* @memberof GrantTeammateAccessRequestBody
|
|
1006
|
-
*/
|
|
1007
|
-
'userEmail': string;
|
|
1008
|
-
/**
|
|
1009
|
-
* Target user display name; persisted on first assignment only
|
|
1010
|
-
* @type {string}
|
|
1011
|
-
* @memberof GrantTeammateAccessRequestBody
|
|
1012
|
-
*/
|
|
1013
|
-
'userName'?: string;
|
|
1014
|
-
}
|
|
1015
|
-
export declare const GrantTeammateAccessRequestBodyAppAccessLevelEnum: {
|
|
1016
|
-
readonly Owner: "Owner";
|
|
1017
|
-
readonly ManagedOwner: "ManagedOwner";
|
|
1018
|
-
readonly PropertyOwner: "PropertyOwner";
|
|
1019
|
-
readonly PropertyManager: "PropertyManager";
|
|
1020
|
-
readonly FinanceManager: "FinanceManager";
|
|
1021
|
-
readonly Integrator: "Integrator";
|
|
1022
|
-
};
|
|
1023
|
-
export type GrantTeammateAccessRequestBodyAppAccessLevelEnum = typeof GrantTeammateAccessRequestBodyAppAccessLevelEnum[keyof typeof GrantTeammateAccessRequestBodyAppAccessLevelEnum];
|
|
1024
690
|
/**
|
|
1025
691
|
*
|
|
1026
692
|
* @export
|
|
@@ -1064,19 +730,6 @@ export interface IsInRoleResponse {
|
|
|
1064
730
|
*/
|
|
1065
731
|
'authorized': boolean;
|
|
1066
732
|
}
|
|
1067
|
-
/**
|
|
1068
|
-
* Successful feature based roles retrieval response
|
|
1069
|
-
* @export
|
|
1070
|
-
* @interface ListFeatureBasedRolesSuccessResponse
|
|
1071
|
-
*/
|
|
1072
|
-
export interface ListFeatureBasedRolesSuccessResponse {
|
|
1073
|
-
/**
|
|
1074
|
-
*
|
|
1075
|
-
* @type {Array<FeatureBasedRole>}
|
|
1076
|
-
* @memberof ListFeatureBasedRolesSuccessResponse
|
|
1077
|
-
*/
|
|
1078
|
-
'roles': Array<FeatureBasedRole>;
|
|
1079
|
-
}
|
|
1080
733
|
/**
|
|
1081
734
|
*
|
|
1082
735
|
* @export
|
|
@@ -1085,10 +738,10 @@ export interface ListFeatureBasedRolesSuccessResponse {
|
|
|
1085
738
|
export interface ListOrgRolesSuccessResponseValue {
|
|
1086
739
|
/**
|
|
1087
740
|
*
|
|
1088
|
-
* @type {
|
|
741
|
+
* @type {ListOrgRolesSuccessResponseValueOrgId}
|
|
1089
742
|
* @memberof ListOrgRolesSuccessResponseValue
|
|
1090
743
|
*/
|
|
1091
|
-
'orgId':
|
|
744
|
+
'orgId': ListOrgRolesSuccessResponseValueOrgId;
|
|
1092
745
|
/**
|
|
1093
746
|
* List of roles that are assigned to the user in the org
|
|
1094
747
|
* @type {Array<string>}
|
|
@@ -1103,22 +756,22 @@ export interface ListOrgRolesSuccessResponseValue {
|
|
|
1103
756
|
'optionalPermissionSetKeys'?: Array<string>;
|
|
1104
757
|
/**
|
|
1105
758
|
* Property IDs, or * for all properties, the roles are scoped to
|
|
1106
|
-
* @type {Array<
|
|
759
|
+
* @type {Array<ListOrgRolesSuccessResponseValuePropertiesInner>}
|
|
1107
760
|
* @memberof ListOrgRolesSuccessResponseValue
|
|
1108
761
|
*/
|
|
1109
|
-
'properties'?: Array<
|
|
762
|
+
'properties'?: Array<ListOrgRolesSuccessResponseValuePropertiesInner>;
|
|
1110
763
|
/**
|
|
1111
764
|
* Brand IDs, or * for all brands, the roles are scoped to
|
|
1112
|
-
* @type {Array<
|
|
765
|
+
* @type {Array<ListOrgRolesSuccessResponseValueBrandsInner>}
|
|
1113
766
|
* @memberof ListOrgRolesSuccessResponseValue
|
|
1114
767
|
*/
|
|
1115
|
-
'brands'?: Array<
|
|
768
|
+
'brands'?: Array<ListOrgRolesSuccessResponseValueBrandsInner>;
|
|
1116
769
|
/**
|
|
1117
770
|
* Sales channel IDs, or * for all sales channels, the roles are scoped to
|
|
1118
|
-
* @type {Array<
|
|
771
|
+
* @type {Array<ListOrgRolesSuccessResponseValueSalesChannelsInner>}
|
|
1119
772
|
* @memberof ListOrgRolesSuccessResponseValue
|
|
1120
773
|
*/
|
|
1121
|
-
'salesChannels'?: Array<
|
|
774
|
+
'salesChannels'?: Array<ListOrgRolesSuccessResponseValueSalesChannelsInner>;
|
|
1122
775
|
}
|
|
1123
776
|
export declare const ListOrgRolesSuccessResponseValueRolesEnum: {
|
|
1124
777
|
readonly Owner: "Owner";
|
|
@@ -1132,121 +785,30 @@ export type ListOrgRolesSuccessResponseValueRolesEnum = typeof ListOrgRolesSucce
|
|
|
1132
785
|
/**
|
|
1133
786
|
*
|
|
1134
787
|
* @export
|
|
1135
|
-
* @interface
|
|
1136
|
-
*/
|
|
1137
|
-
export interface ListOrgRolesSuccessResponseValueAnyOf {
|
|
1138
|
-
/**
|
|
1139
|
-
*
|
|
1140
|
-
* @type {ListOrgRolesSuccessResponseValueAnyOfOrgId}
|
|
1141
|
-
* @memberof ListOrgRolesSuccessResponseValueAnyOf
|
|
1142
|
-
*/
|
|
1143
|
-
'orgId': ListOrgRolesSuccessResponseValueAnyOfOrgId;
|
|
1144
|
-
/**
|
|
1145
|
-
* List of roles that are assigned to the user in the org
|
|
1146
|
-
* @type {Array<string>}
|
|
1147
|
-
* @memberof ListOrgRolesSuccessResponseValueAnyOf
|
|
1148
|
-
*/
|
|
1149
|
-
'roles': Array<ListOrgRolesSuccessResponseValueAnyOfRolesEnum>;
|
|
1150
|
-
/**
|
|
1151
|
-
* Optional permission set keys applied to the roles
|
|
1152
|
-
* @type {Array<string>}
|
|
1153
|
-
* @memberof ListOrgRolesSuccessResponseValueAnyOf
|
|
1154
|
-
*/
|
|
1155
|
-
'optionalPermissionSetKeys'?: Array<string>;
|
|
1156
|
-
/**
|
|
1157
|
-
* Property IDs, or * for all properties, the roles are scoped to
|
|
1158
|
-
* @type {Array<ListOrgRolesSuccessResponseValueAnyOfPropertiesInner>}
|
|
1159
|
-
* @memberof ListOrgRolesSuccessResponseValueAnyOf
|
|
1160
|
-
*/
|
|
1161
|
-
'properties'?: Array<ListOrgRolesSuccessResponseValueAnyOfPropertiesInner>;
|
|
1162
|
-
/**
|
|
1163
|
-
* Brand IDs, or * for all brands, the roles are scoped to
|
|
1164
|
-
* @type {Array<ListOrgRolesSuccessResponseValueAnyOfBrandsInner>}
|
|
1165
|
-
* @memberof ListOrgRolesSuccessResponseValueAnyOf
|
|
1166
|
-
*/
|
|
1167
|
-
'brands'?: Array<ListOrgRolesSuccessResponseValueAnyOfBrandsInner>;
|
|
1168
|
-
/**
|
|
1169
|
-
* Sales channel IDs, or * for all sales channels, the roles are scoped to
|
|
1170
|
-
* @type {Array<ListOrgRolesSuccessResponseValueAnyOfSalesChannelsInner>}
|
|
1171
|
-
* @memberof ListOrgRolesSuccessResponseValueAnyOf
|
|
1172
|
-
*/
|
|
1173
|
-
'salesChannels'?: Array<ListOrgRolesSuccessResponseValueAnyOfSalesChannelsInner>;
|
|
1174
|
-
}
|
|
1175
|
-
export declare const ListOrgRolesSuccessResponseValueAnyOfRolesEnum: {
|
|
1176
|
-
readonly Owner: "Owner";
|
|
1177
|
-
readonly PropertyOwner: "PropertyOwner";
|
|
1178
|
-
readonly ManagedOwner: "ManagedOwner";
|
|
1179
|
-
readonly Integrator: "Integrator";
|
|
1180
|
-
readonly PropertyManager: "PropertyManager";
|
|
1181
|
-
readonly FinanceManager: "FinanceManager";
|
|
1182
|
-
};
|
|
1183
|
-
export type ListOrgRolesSuccessResponseValueAnyOfRolesEnum = typeof ListOrgRolesSuccessResponseValueAnyOfRolesEnum[keyof typeof ListOrgRolesSuccessResponseValueAnyOfRolesEnum];
|
|
1184
|
-
/**
|
|
1185
|
-
*
|
|
1186
|
-
* @export
|
|
1187
|
-
* @interface ListOrgRolesSuccessResponseValueAnyOfBrandsInner
|
|
788
|
+
* @interface ListOrgRolesSuccessResponseValueBrandsInner
|
|
1188
789
|
*/
|
|
1189
|
-
export interface
|
|
790
|
+
export interface ListOrgRolesSuccessResponseValueBrandsInner {
|
|
1190
791
|
}
|
|
1191
792
|
/**
|
|
1192
793
|
* ID of the org the roles are assigned in
|
|
1193
794
|
* @export
|
|
1194
|
-
* @interface
|
|
1195
|
-
*/
|
|
1196
|
-
export interface ListOrgRolesSuccessResponseValueAnyOfOrgId {
|
|
1197
|
-
}
|
|
1198
|
-
/**
|
|
1199
|
-
*
|
|
1200
|
-
* @export
|
|
1201
|
-
* @interface ListOrgRolesSuccessResponseValueAnyOfPropertiesInner
|
|
1202
|
-
*/
|
|
1203
|
-
export interface ListOrgRolesSuccessResponseValueAnyOfPropertiesInner {
|
|
1204
|
-
}
|
|
1205
|
-
/**
|
|
1206
|
-
*
|
|
1207
|
-
* @export
|
|
1208
|
-
* @interface ListOrgRolesSuccessResponseValueAnyOfSalesChannelsInner
|
|
795
|
+
* @interface ListOrgRolesSuccessResponseValueOrgId
|
|
1209
796
|
*/
|
|
1210
|
-
export interface
|
|
797
|
+
export interface ListOrgRolesSuccessResponseValueOrgId {
|
|
1211
798
|
}
|
|
1212
799
|
/**
|
|
1213
800
|
*
|
|
1214
801
|
* @export
|
|
1215
|
-
* @interface
|
|
802
|
+
* @interface ListOrgRolesSuccessResponseValuePropertiesInner
|
|
1216
803
|
*/
|
|
1217
|
-
export interface
|
|
1218
|
-
/**
|
|
1219
|
-
* Type of resource the permissions are assigned to
|
|
1220
|
-
* @type {string}
|
|
1221
|
-
* @memberof ListOrgRolesSuccessResponseValueAnyOfValue
|
|
1222
|
-
*/
|
|
1223
|
-
'resourceType': ListOrgRolesSuccessResponseValueAnyOfValueResourceTypeEnum;
|
|
1224
|
-
/**
|
|
1225
|
-
*
|
|
1226
|
-
* @type {GetUserPermissionsSuccessResponseResourcesValueResourceId}
|
|
1227
|
-
* @memberof ListOrgRolesSuccessResponseValueAnyOfValue
|
|
1228
|
-
*/
|
|
1229
|
-
'resourceId': GetUserPermissionsSuccessResponseResourcesValueResourceId;
|
|
1230
|
-
/**
|
|
1231
|
-
* List of roles that are assigned to the user for the resource
|
|
1232
|
-
* @type {Array<ListOrgRolesSuccessResponseValueAnyOfValueRolesInner>}
|
|
1233
|
-
* @memberof ListOrgRolesSuccessResponseValueAnyOfValue
|
|
1234
|
-
*/
|
|
1235
|
-
'roles': Array<ListOrgRolesSuccessResponseValueAnyOfValueRolesInner>;
|
|
804
|
+
export interface ListOrgRolesSuccessResponseValuePropertiesInner {
|
|
1236
805
|
}
|
|
1237
|
-
export declare const ListOrgRolesSuccessResponseValueAnyOfValueResourceTypeEnum: {
|
|
1238
|
-
readonly Property: "Property";
|
|
1239
|
-
readonly Org: "Org";
|
|
1240
|
-
readonly Brand: "Brand";
|
|
1241
|
-
readonly SalesChannel: "SalesChannel";
|
|
1242
|
-
};
|
|
1243
|
-
export type ListOrgRolesSuccessResponseValueAnyOfValueResourceTypeEnum = typeof ListOrgRolesSuccessResponseValueAnyOfValueResourceTypeEnum[keyof typeof ListOrgRolesSuccessResponseValueAnyOfValueResourceTypeEnum];
|
|
1244
806
|
/**
|
|
1245
807
|
*
|
|
1246
808
|
* @export
|
|
1247
|
-
* @interface
|
|
809
|
+
* @interface ListOrgRolesSuccessResponseValueSalesChannelsInner
|
|
1248
810
|
*/
|
|
1249
|
-
export interface
|
|
811
|
+
export interface ListOrgRolesSuccessResponseValueSalesChannelsInner {
|
|
1250
812
|
}
|
|
1251
813
|
/**
|
|
1252
814
|
* Successful permissions retrieval response
|
|
@@ -1513,460 +1075,406 @@ export declare const Permissions: {
|
|
|
1513
1075
|
};
|
|
1514
1076
|
export type Permissions = typeof Permissions[keyof typeof Permissions];
|
|
1515
1077
|
/**
|
|
1516
|
-
*
|
|
1078
|
+
* Principals in org
|
|
1517
1079
|
* @export
|
|
1518
|
-
* @interface
|
|
1080
|
+
* @interface PrincipalsInOrgResponse
|
|
1519
1081
|
*/
|
|
1520
|
-
export interface
|
|
1082
|
+
export interface PrincipalsInOrgResponse {
|
|
1521
1083
|
/**
|
|
1522
1084
|
*
|
|
1523
1085
|
* @type {string}
|
|
1524
|
-
* @memberof
|
|
1086
|
+
* @memberof PrincipalsInOrgResponse
|
|
1525
1087
|
*/
|
|
1526
|
-
'
|
|
1088
|
+
'orgId': string;
|
|
1089
|
+
/**
|
|
1090
|
+
* List of principals in org
|
|
1091
|
+
* @type {Array<AuthorizationRequestPrincipal>}
|
|
1092
|
+
* @memberof PrincipalsInOrgResponse
|
|
1093
|
+
*/
|
|
1094
|
+
'principals': Array<AuthorizationRequestPrincipal>;
|
|
1095
|
+
}
|
|
1096
|
+
/**
|
|
1097
|
+
* Role assignment key to rematerialize
|
|
1098
|
+
* @export
|
|
1099
|
+
* @interface RematerializeRoleAssignmentRequestBody
|
|
1100
|
+
*/
|
|
1101
|
+
export interface RematerializeRoleAssignmentRequestBody {
|
|
1527
1102
|
/**
|
|
1528
1103
|
*
|
|
1529
1104
|
* @type {string}
|
|
1530
|
-
* @memberof
|
|
1105
|
+
* @memberof RematerializeRoleAssignmentRequestBody
|
|
1531
1106
|
*/
|
|
1532
|
-
'
|
|
1107
|
+
'pk': string;
|
|
1533
1108
|
/**
|
|
1534
1109
|
*
|
|
1535
1110
|
* @type {string}
|
|
1536
|
-
* @memberof
|
|
1111
|
+
* @memberof RematerializeRoleAssignmentRequestBody
|
|
1537
1112
|
*/
|
|
1538
|
-
'
|
|
1113
|
+
'sk': string;
|
|
1114
|
+
}
|
|
1115
|
+
/**
|
|
1116
|
+
* Successful role assignment rematerialization response
|
|
1117
|
+
* @export
|
|
1118
|
+
* @interface RematerializeRoleAssignmentSuccessResponse
|
|
1119
|
+
*/
|
|
1120
|
+
export interface RematerializeRoleAssignmentSuccessResponse {
|
|
1539
1121
|
/**
|
|
1540
1122
|
*
|
|
1541
|
-
* @type {
|
|
1542
|
-
* @memberof
|
|
1123
|
+
* @type {RematerializeRoleAssignmentSuccessResponseRoleAssignment}
|
|
1124
|
+
* @memberof RematerializeRoleAssignmentSuccessResponse
|
|
1543
1125
|
*/
|
|
1544
|
-
'
|
|
1126
|
+
'roleAssignment': RematerializeRoleAssignmentSuccessResponseRoleAssignment;
|
|
1545
1127
|
/**
|
|
1546
1128
|
*
|
|
1547
|
-
* @type {
|
|
1548
|
-
* @memberof
|
|
1129
|
+
* @type {number}
|
|
1130
|
+
* @memberof RematerializeRoleAssignmentSuccessResponse
|
|
1549
1131
|
*/
|
|
1550
|
-
'
|
|
1132
|
+
'materialized': number;
|
|
1551
1133
|
/**
|
|
1552
|
-
*
|
|
1553
|
-
* @type {
|
|
1554
|
-
* @memberof
|
|
1134
|
+
*
|
|
1135
|
+
* @type {number}
|
|
1136
|
+
* @memberof RematerializeRoleAssignmentSuccessResponse
|
|
1555
1137
|
*/
|
|
1556
|
-
'
|
|
1138
|
+
'applied': number;
|
|
1557
1139
|
/**
|
|
1558
|
-
*
|
|
1559
|
-
* @type {
|
|
1560
|
-
* @memberof
|
|
1140
|
+
*
|
|
1141
|
+
* @type {Array<RematerializeRoleAssignmentSuccessResponsePolicyAssignmentsInner>}
|
|
1142
|
+
* @memberof RematerializeRoleAssignmentSuccessResponse
|
|
1561
1143
|
*/
|
|
1562
|
-
'
|
|
1144
|
+
'policyAssignments': Array<RematerializeRoleAssignmentSuccessResponsePolicyAssignmentsInner>;
|
|
1563
1145
|
}
|
|
1564
|
-
export declare const PrincipalInOrgWithTeammatePermissionSummaryTypeEnum: {
|
|
1565
|
-
readonly User: "User";
|
|
1566
|
-
readonly Automation: "Automation";
|
|
1567
|
-
};
|
|
1568
|
-
export type PrincipalInOrgWithTeammatePermissionSummaryTypeEnum = typeof PrincipalInOrgWithTeammatePermissionSummaryTypeEnum[keyof typeof PrincipalInOrgWithTeammatePermissionSummaryTypeEnum];
|
|
1569
1146
|
/**
|
|
1570
|
-
*
|
|
1147
|
+
*
|
|
1571
1148
|
* @export
|
|
1572
|
-
* @interface
|
|
1149
|
+
* @interface RematerializeRoleAssignmentSuccessResponsePolicyAssignmentsInner
|
|
1573
1150
|
*/
|
|
1574
|
-
export interface
|
|
1151
|
+
export interface RematerializeRoleAssignmentSuccessResponsePolicyAssignmentsInner {
|
|
1575
1152
|
/**
|
|
1576
1153
|
*
|
|
1577
1154
|
* @type {string}
|
|
1578
|
-
* @memberof
|
|
1155
|
+
* @memberof RematerializeRoleAssignmentSuccessResponsePolicyAssignmentsInner
|
|
1579
1156
|
*/
|
|
1580
|
-
'
|
|
1157
|
+
'policyId': string;
|
|
1581
1158
|
/**
|
|
1582
|
-
*
|
|
1583
|
-
* @type {
|
|
1584
|
-
* @memberof
|
|
1159
|
+
*
|
|
1160
|
+
* @type {string}
|
|
1161
|
+
* @memberof RematerializeRoleAssignmentSuccessResponsePolicyAssignmentsInner
|
|
1585
1162
|
*/
|
|
1586
|
-
'
|
|
1163
|
+
'assignmentPk': string;
|
|
1164
|
+
/**
|
|
1165
|
+
*
|
|
1166
|
+
* @type {string}
|
|
1167
|
+
* @memberof RematerializeRoleAssignmentSuccessResponsePolicyAssignmentsInner
|
|
1168
|
+
*/
|
|
1169
|
+
'assignmentSk': string;
|
|
1587
1170
|
}
|
|
1588
1171
|
/**
|
|
1589
|
-
*
|
|
1172
|
+
*
|
|
1590
1173
|
* @export
|
|
1591
|
-
* @interface
|
|
1174
|
+
* @interface RematerializeRoleAssignmentSuccessResponseRoleAssignment
|
|
1592
1175
|
*/
|
|
1593
|
-
export interface
|
|
1176
|
+
export interface RematerializeRoleAssignmentSuccessResponseRoleAssignment {
|
|
1594
1177
|
/**
|
|
1595
1178
|
*
|
|
1596
1179
|
* @type {string}
|
|
1597
|
-
* @memberof
|
|
1180
|
+
* @memberof RematerializeRoleAssignmentSuccessResponseRoleAssignment
|
|
1598
1181
|
*/
|
|
1599
|
-
'
|
|
1182
|
+
'pk': string;
|
|
1600
1183
|
/**
|
|
1601
|
-
*
|
|
1602
|
-
* @type {
|
|
1603
|
-
* @memberof
|
|
1184
|
+
*
|
|
1185
|
+
* @type {string}
|
|
1186
|
+
* @memberof RematerializeRoleAssignmentSuccessResponseRoleAssignment
|
|
1187
|
+
*/
|
|
1188
|
+
'sk': string;
|
|
1189
|
+
/**
|
|
1190
|
+
*
|
|
1191
|
+
* @type {string}
|
|
1192
|
+
* @memberof RematerializeRoleAssignmentSuccessResponseRoleAssignment
|
|
1604
1193
|
*/
|
|
1605
|
-
'
|
|
1194
|
+
'assignmentId': string;
|
|
1606
1195
|
}
|
|
1607
1196
|
/**
|
|
1608
|
-
*
|
|
1197
|
+
*
|
|
1609
1198
|
* @export
|
|
1610
|
-
* @interface
|
|
1199
|
+
* @interface RemoveTeammateRequestBody
|
|
1611
1200
|
*/
|
|
1612
|
-
export interface
|
|
1201
|
+
export interface RemoveTeammateRequestBody {
|
|
1613
1202
|
/**
|
|
1614
1203
|
*
|
|
1615
|
-
* @type {
|
|
1616
|
-
* @memberof
|
|
1204
|
+
* @type {RemoveTeammateRequestBodyPrincipal}
|
|
1205
|
+
* @memberof RemoveTeammateRequestBody
|
|
1617
1206
|
*/
|
|
1618
|
-
'
|
|
1207
|
+
'principal': RemoveTeammateRequestBodyPrincipal;
|
|
1619
1208
|
/**
|
|
1620
1209
|
*
|
|
1621
|
-
* @type {
|
|
1622
|
-
* @memberof
|
|
1210
|
+
* @type {RemoveTeammateRequestBodyActor}
|
|
1211
|
+
* @memberof RemoveTeammateRequestBody
|
|
1623
1212
|
*/
|
|
1624
|
-
'
|
|
1213
|
+
'actor'?: RemoveTeammateRequestBodyActor;
|
|
1625
1214
|
}
|
|
1626
1215
|
/**
|
|
1627
|
-
*
|
|
1216
|
+
* Actor performing the removal
|
|
1628
1217
|
* @export
|
|
1629
|
-
* @interface
|
|
1218
|
+
* @interface RemoveTeammateRequestBodyActor
|
|
1630
1219
|
*/
|
|
1631
|
-
export interface
|
|
1220
|
+
export interface RemoveTeammateRequestBodyActor {
|
|
1632
1221
|
/**
|
|
1633
1222
|
*
|
|
1634
|
-
* @type {
|
|
1635
|
-
* @memberof
|
|
1223
|
+
* @type {string}
|
|
1224
|
+
* @memberof RemoveTeammateRequestBodyActor
|
|
1636
1225
|
*/
|
|
1637
|
-
'
|
|
1226
|
+
'type': RemoveTeammateRequestBodyActorTypeEnum;
|
|
1638
1227
|
/**
|
|
1639
1228
|
*
|
|
1640
|
-
* @type {
|
|
1641
|
-
* @memberof
|
|
1229
|
+
* @type {string}
|
|
1230
|
+
* @memberof RemoveTeammateRequestBodyActor
|
|
1642
1231
|
*/
|
|
1643
|
-
'
|
|
1232
|
+
'id': string;
|
|
1644
1233
|
/**
|
|
1645
1234
|
*
|
|
1646
|
-
* @type {
|
|
1647
|
-
* @memberof
|
|
1235
|
+
* @type {string}
|
|
1236
|
+
* @memberof RemoveTeammateRequestBodyActor
|
|
1648
1237
|
*/
|
|
1649
|
-
'
|
|
1238
|
+
'name'?: string;
|
|
1239
|
+
/**
|
|
1240
|
+
*
|
|
1241
|
+
* @type {string}
|
|
1242
|
+
* @memberof RemoveTeammateRequestBodyActor
|
|
1243
|
+
*/
|
|
1244
|
+
'email'?: string;
|
|
1650
1245
|
/**
|
|
1651
1246
|
*
|
|
1652
|
-
* @type {
|
|
1653
|
-
* @memberof
|
|
1247
|
+
* @type {string}
|
|
1248
|
+
* @memberof RemoveTeammateRequestBodyActor
|
|
1654
1249
|
*/
|
|
1655
|
-
'
|
|
1250
|
+
'phone'?: string;
|
|
1656
1251
|
}
|
|
1252
|
+
export declare const RemoveTeammateRequestBodyActorTypeEnum: {
|
|
1253
|
+
readonly User: "User";
|
|
1254
|
+
readonly Automation: "Automation";
|
|
1255
|
+
};
|
|
1256
|
+
export type RemoveTeammateRequestBodyActorTypeEnum = typeof RemoveTeammateRequestBodyActorTypeEnum[keyof typeof RemoveTeammateRequestBodyActorTypeEnum];
|
|
1657
1257
|
/**
|
|
1658
|
-
*
|
|
1258
|
+
* Principal to remove from the org
|
|
1659
1259
|
* @export
|
|
1660
|
-
* @interface
|
|
1260
|
+
* @interface RemoveTeammateRequestBodyPrincipal
|
|
1661
1261
|
*/
|
|
1662
|
-
export interface
|
|
1262
|
+
export interface RemoveTeammateRequestBodyPrincipal {
|
|
1663
1263
|
/**
|
|
1664
1264
|
*
|
|
1665
1265
|
* @type {string}
|
|
1666
|
-
* @memberof
|
|
1266
|
+
* @memberof RemoveTeammateRequestBodyPrincipal
|
|
1667
1267
|
*/
|
|
1668
|
-
'
|
|
1268
|
+
'type': RemoveTeammateRequestBodyPrincipalTypeEnum;
|
|
1669
1269
|
/**
|
|
1670
1270
|
*
|
|
1671
1271
|
* @type {string}
|
|
1672
|
-
* @memberof
|
|
1272
|
+
* @memberof RemoveTeammateRequestBodyPrincipal
|
|
1673
1273
|
*/
|
|
1674
|
-
'
|
|
1274
|
+
'id': string;
|
|
1675
1275
|
/**
|
|
1676
1276
|
*
|
|
1677
1277
|
* @type {string}
|
|
1678
|
-
* @memberof
|
|
1278
|
+
* @memberof RemoveTeammateRequestBodyPrincipal
|
|
1679
1279
|
*/
|
|
1680
|
-
'
|
|
1681
|
-
}
|
|
1682
|
-
/**
|
|
1683
|
-
*
|
|
1684
|
-
* @export
|
|
1685
|
-
* @interface RematerializeRoleAssignmentV2SuccessResponseRoleAssignment
|
|
1686
|
-
*/
|
|
1687
|
-
export interface RematerializeRoleAssignmentV2SuccessResponseRoleAssignment {
|
|
1280
|
+
'name'?: string;
|
|
1688
1281
|
/**
|
|
1689
1282
|
*
|
|
1690
1283
|
* @type {string}
|
|
1691
|
-
* @memberof
|
|
1284
|
+
* @memberof RemoveTeammateRequestBodyPrincipal
|
|
1692
1285
|
*/
|
|
1693
|
-
'
|
|
1286
|
+
'email'?: string;
|
|
1694
1287
|
/**
|
|
1695
1288
|
*
|
|
1696
1289
|
* @type {string}
|
|
1697
|
-
* @memberof
|
|
1290
|
+
* @memberof RemoveTeammateRequestBodyPrincipal
|
|
1698
1291
|
*/
|
|
1699
|
-
'
|
|
1292
|
+
'phone'?: string;
|
|
1293
|
+
}
|
|
1294
|
+
export declare const RemoveTeammateRequestBodyPrincipalTypeEnum: {
|
|
1295
|
+
readonly User: "User";
|
|
1296
|
+
readonly Automation: "Automation";
|
|
1297
|
+
};
|
|
1298
|
+
export type RemoveTeammateRequestBodyPrincipalTypeEnum = typeof RemoveTeammateRequestBodyPrincipalTypeEnum[keyof typeof RemoveTeammateRequestBodyPrincipalTypeEnum];
|
|
1299
|
+
/**
|
|
1300
|
+
* Teammate removed from org
|
|
1301
|
+
* @export
|
|
1302
|
+
* @interface RemoveTeammateSuccessResponse
|
|
1303
|
+
*/
|
|
1304
|
+
export interface RemoveTeammateSuccessResponse {
|
|
1700
1305
|
/**
|
|
1701
1306
|
*
|
|
1702
1307
|
* @type {string}
|
|
1703
|
-
* @memberof
|
|
1308
|
+
* @memberof RemoveTeammateSuccessResponse
|
|
1704
1309
|
*/
|
|
1705
|
-
'
|
|
1310
|
+
'message': string;
|
|
1706
1311
|
}
|
|
1707
1312
|
/**
|
|
1708
|
-
*
|
|
1313
|
+
*
|
|
1709
1314
|
* @export
|
|
1710
|
-
* @interface
|
|
1315
|
+
* @interface RoleAssignmentRequestBody
|
|
1711
1316
|
*/
|
|
1712
|
-
export interface
|
|
1317
|
+
export interface RoleAssignmentRequestBody {
|
|
1713
1318
|
/**
|
|
1714
1319
|
*
|
|
1715
|
-
* @type {
|
|
1716
|
-
* @memberof
|
|
1320
|
+
* @type {RoleAssignmentRequestBodyPrincipal}
|
|
1321
|
+
* @memberof RoleAssignmentRequestBody
|
|
1717
1322
|
*/
|
|
1718
|
-
'principal':
|
|
1323
|
+
'principal': RoleAssignmentRequestBodyPrincipal;
|
|
1719
1324
|
/**
|
|
1720
|
-
*
|
|
1325
|
+
* Role name
|
|
1721
1326
|
* @type {string}
|
|
1722
|
-
* @memberof
|
|
1327
|
+
* @memberof RoleAssignmentRequestBody
|
|
1723
1328
|
*/
|
|
1724
|
-
'
|
|
1329
|
+
'roleName': RoleAssignmentRequestBodyRoleNameEnum;
|
|
1725
1330
|
/**
|
|
1726
|
-
*
|
|
1727
|
-
* @type {
|
|
1728
|
-
* @memberof
|
|
1331
|
+
* Property resource ids (e.g. p123) when scoped to properties
|
|
1332
|
+
* @type {Array<ListOrgRolesSuccessResponseValuePropertiesInner>}
|
|
1333
|
+
* @memberof RoleAssignmentRequestBody
|
|
1334
|
+
*/
|
|
1335
|
+
'properties'?: Array<ListOrgRolesSuccessResponseValuePropertiesInner>;
|
|
1336
|
+
/**
|
|
1337
|
+
* Brand resource ids (e.g. b123) when scoped to brands
|
|
1338
|
+
* @type {Array<ListOrgRolesSuccessResponseValueBrandsInner>}
|
|
1339
|
+
* @memberof RoleAssignmentRequestBody
|
|
1340
|
+
*/
|
|
1341
|
+
'brands'?: Array<ListOrgRolesSuccessResponseValueBrandsInner>;
|
|
1342
|
+
/**
|
|
1343
|
+
* Sales channel resource ids (e.g. sc123) when scoped to sales channels
|
|
1344
|
+
* @type {Array<ListOrgRolesSuccessResponseValueSalesChannelsInner>}
|
|
1345
|
+
* @memberof RoleAssignmentRequestBody
|
|
1346
|
+
*/
|
|
1347
|
+
'salesChannels'?: Array<ListOrgRolesSuccessResponseValueSalesChannelsInner>;
|
|
1348
|
+
/**
|
|
1349
|
+
* Optional permission set keys to apply to this role assignment
|
|
1350
|
+
* @type {Array<string>}
|
|
1351
|
+
* @memberof RoleAssignmentRequestBody
|
|
1352
|
+
*/
|
|
1353
|
+
'optionalPermissionSetKeys'?: Array<string>;
|
|
1354
|
+
/**
|
|
1355
|
+
*
|
|
1356
|
+
* @type {RoleAssignmentRequestBodyActor}
|
|
1357
|
+
* @memberof RoleAssignmentRequestBody
|
|
1729
1358
|
*/
|
|
1730
|
-
'
|
|
1359
|
+
'actor'?: RoleAssignmentRequestBodyActor;
|
|
1731
1360
|
}
|
|
1732
|
-
export declare const
|
|
1733
|
-
readonly
|
|
1734
|
-
readonly
|
|
1735
|
-
readonly
|
|
1736
|
-
readonly
|
|
1737
|
-
readonly
|
|
1738
|
-
readonly
|
|
1361
|
+
export declare const RoleAssignmentRequestBodyRoleNameEnum: {
|
|
1362
|
+
readonly Owner: "Owner";
|
|
1363
|
+
readonly PropertyOwner: "PropertyOwner";
|
|
1364
|
+
readonly ManagedOwner: "ManagedOwner";
|
|
1365
|
+
readonly Integrator: "Integrator";
|
|
1366
|
+
readonly PropertyManager: "PropertyManager";
|
|
1367
|
+
readonly FinanceManager: "FinanceManager";
|
|
1739
1368
|
};
|
|
1740
|
-
export type
|
|
1369
|
+
export type RoleAssignmentRequestBodyRoleNameEnum = typeof RoleAssignmentRequestBodyRoleNameEnum[keyof typeof RoleAssignmentRequestBodyRoleNameEnum];
|
|
1741
1370
|
/**
|
|
1742
|
-
*
|
|
1371
|
+
* Actor making the assignment
|
|
1743
1372
|
* @export
|
|
1744
|
-
* @interface
|
|
1373
|
+
* @interface RoleAssignmentRequestBodyActor
|
|
1745
1374
|
*/
|
|
1746
|
-
export interface
|
|
1375
|
+
export interface RoleAssignmentRequestBodyActor {
|
|
1747
1376
|
/**
|
|
1748
1377
|
*
|
|
1749
1378
|
* @type {string}
|
|
1750
|
-
* @memberof
|
|
1379
|
+
* @memberof RoleAssignmentRequestBodyActor
|
|
1751
1380
|
*/
|
|
1752
|
-
'
|
|
1381
|
+
'type': RoleAssignmentRequestBodyActorTypeEnum;
|
|
1753
1382
|
/**
|
|
1754
1383
|
*
|
|
1755
|
-
* @type {
|
|
1756
|
-
* @memberof
|
|
1384
|
+
* @type {string}
|
|
1385
|
+
* @memberof RoleAssignmentRequestBodyActor
|
|
1757
1386
|
*/
|
|
1758
|
-
'
|
|
1387
|
+
'id': string;
|
|
1759
1388
|
/**
|
|
1760
1389
|
*
|
|
1761
|
-
* @type {
|
|
1762
|
-
* @memberof
|
|
1390
|
+
* @type {string}
|
|
1391
|
+
* @memberof RoleAssignmentRequestBodyActor
|
|
1763
1392
|
*/
|
|
1764
|
-
'
|
|
1393
|
+
'name'?: string;
|
|
1765
1394
|
/**
|
|
1766
1395
|
*
|
|
1767
1396
|
* @type {string}
|
|
1768
|
-
* @memberof
|
|
1397
|
+
* @memberof RoleAssignmentRequestBodyActor
|
|
1769
1398
|
*/
|
|
1770
|
-
'
|
|
1771
|
-
}
|
|
1772
|
-
export declare const RevokeRoleRequestBodyRoleEnum: {
|
|
1773
|
-
readonly OrgViewer: "OrgViewer";
|
|
1774
|
-
readonly OrgManager: "OrgManager";
|
|
1775
|
-
readonly OrgAdmin: "OrgAdmin";
|
|
1776
|
-
readonly BrandViewer: "BrandViewer";
|
|
1777
|
-
readonly BrandManager: "BrandManager";
|
|
1778
|
-
readonly BrandAdmin: "BrandAdmin";
|
|
1779
|
-
readonly StoreViewer: "StoreViewer";
|
|
1780
|
-
readonly StoreEditor: "StoreEditor";
|
|
1781
|
-
readonly StoreManager: "StoreManager";
|
|
1782
|
-
readonly CustomerViewer: "CustomerViewer";
|
|
1783
|
-
readonly CustomerManager: "CustomerManager";
|
|
1784
|
-
readonly VoucherViewer: "VoucherViewer";
|
|
1785
|
-
readonly VoucherEditor: "VoucherEditor";
|
|
1786
|
-
readonly VoucherManager: "VoucherManager";
|
|
1787
|
-
readonly VoucherCampaignManager: "VoucherCampaignManager";
|
|
1788
|
-
readonly VoucherStatisticsViewer: "VoucherStatisticsViewer";
|
|
1789
|
-
readonly AnalyticsViewer: "AnalyticsViewer";
|
|
1790
|
-
readonly ReportsViewer: "ReportsViewer";
|
|
1791
|
-
readonly FinanceViewer: "FinanceViewer";
|
|
1792
|
-
readonly FinanceManager: "FinanceManager";
|
|
1793
|
-
readonly TeamViewer: "TeamViewer";
|
|
1794
|
-
readonly TeamManager: "TeamManager";
|
|
1795
|
-
readonly TeamAdmin: "TeamAdmin";
|
|
1796
|
-
readonly TechViewer: "TechViewer";
|
|
1797
|
-
readonly TechManager: "TechManager";
|
|
1798
|
-
readonly AppStoreViewer: "AppStoreViewer";
|
|
1799
|
-
readonly AppStoreManager: "AppStoreManager";
|
|
1800
|
-
readonly SalesChannelViewer: "SalesChannelViewer";
|
|
1801
|
-
readonly SalesChannelEditor: "SalesChannelEditor";
|
|
1802
|
-
readonly SalesChannelManager: "SalesChannelManager";
|
|
1803
|
-
readonly DeliveryViewer: "DeliveryViewer";
|
|
1804
|
-
readonly DeliveryManager: "DeliveryManager";
|
|
1805
|
-
readonly DriverManager: "DriverManager";
|
|
1806
|
-
readonly AuditViewer: "AuditViewer";
|
|
1807
|
-
readonly AuditManager: "AuditManager";
|
|
1808
|
-
readonly AccountsViewer: "AccountsViewer";
|
|
1809
|
-
readonly AccountsEditor: "AccountsEditor";
|
|
1810
|
-
readonly DocumentExplorerViewer: "DocumentExplorerViewer";
|
|
1811
|
-
readonly DocumentExplorerEditor: "DocumentExplorerEditor";
|
|
1812
|
-
readonly PayrollViewer: "PayrollViewer";
|
|
1813
|
-
readonly PayrollEditor: "PayrollEditor";
|
|
1814
|
-
readonly PropertyViewer: "PropertyViewer";
|
|
1815
|
-
readonly PropertyManager: "PropertyManager";
|
|
1816
|
-
readonly PropertyAdmin: "PropertyAdmin";
|
|
1817
|
-
readonly WebsiteContentEditor: "WebsiteContentEditor";
|
|
1818
|
-
readonly WebsiteContentViewer: "WebsiteContentViewer";
|
|
1819
|
-
readonly WebsiteTechViewer: "WebsiteTechViewer";
|
|
1820
|
-
readonly MenuViewer: "MenuViewer";
|
|
1821
|
-
readonly MenuEditor: "MenuEditor";
|
|
1822
|
-
readonly MenuManager: "MenuManager";
|
|
1823
|
-
readonly MenuMetaFieldManager: "MenuMetaFieldManager";
|
|
1824
|
-
readonly MenuMetaFieldEditor: "MenuMetaFieldEditor";
|
|
1825
|
-
readonly MenuMetaFieldViewer: "MenuMetaFieldViewer";
|
|
1826
|
-
readonly StoreDeliveryZoneManager: "StoreDeliveryZoneManager";
|
|
1827
|
-
readonly StoreDeliveryZoneEditor: "StoreDeliveryZoneEditor";
|
|
1828
|
-
readonly StoreDeliveryZoneViewer: "StoreDeliveryZoneViewer";
|
|
1829
|
-
readonly OrderFulfillmentManager: "OrderFulfillmentManager";
|
|
1830
|
-
readonly OrderManager: "OrderManager";
|
|
1831
|
-
readonly OrderEditor: "OrderEditor";
|
|
1832
|
-
readonly OrderViewer: "OrderViewer";
|
|
1833
|
-
readonly InventoryManager: "InventoryManager";
|
|
1834
|
-
readonly InventoryEditor: "InventoryEditor";
|
|
1835
|
-
readonly InventoryViewer: "InventoryViewer";
|
|
1836
|
-
readonly PaymentManager: "PaymentManager";
|
|
1837
|
-
readonly OnboardingManager: "OnboardingManager";
|
|
1838
|
-
readonly FeatureFlagManager: "FeatureFlagManager";
|
|
1839
|
-
readonly PropertyOwnerMisc: "PropertyOwnerMisc";
|
|
1840
|
-
readonly ManagedOwnerMisc: "ManagedOwnerMisc";
|
|
1841
|
-
readonly IntegratorMisc: "IntegratorMisc";
|
|
1842
|
-
readonly PropertyManagerMisc: "PropertyManagerMisc";
|
|
1843
|
-
readonly FinanceManagerMisc: "FinanceManagerMisc";
|
|
1844
|
-
readonly SupportMisc: "SupportMisc";
|
|
1845
|
-
};
|
|
1846
|
-
export type RevokeRoleRequestBodyRoleEnum = typeof RevokeRoleRequestBodyRoleEnum[keyof typeof RevokeRoleRequestBodyRoleEnum];
|
|
1847
|
-
/**
|
|
1848
|
-
* Successful role revocation response
|
|
1849
|
-
* @export
|
|
1850
|
-
* @interface RevokeRoleSuccessResponse
|
|
1851
|
-
*/
|
|
1852
|
-
export interface RevokeRoleSuccessResponse {
|
|
1399
|
+
'email'?: string;
|
|
1853
1400
|
/**
|
|
1854
|
-
*
|
|
1401
|
+
*
|
|
1855
1402
|
* @type {string}
|
|
1856
|
-
* @memberof
|
|
1403
|
+
* @memberof RoleAssignmentRequestBodyActor
|
|
1857
1404
|
*/
|
|
1858
|
-
'
|
|
1405
|
+
'phone'?: string;
|
|
1859
1406
|
}
|
|
1860
|
-
|
|
1861
|
-
|
|
1862
|
-
|
|
1863
|
-
* @enum {string}
|
|
1864
|
-
*/
|
|
1865
|
-
export declare const RoleNames: {
|
|
1866
|
-
readonly Admin: "Admin";
|
|
1867
|
-
readonly Factory: "Factory";
|
|
1868
|
-
readonly AuthDeveloper: "AuthDeveloper";
|
|
1407
|
+
export declare const RoleAssignmentRequestBodyActorTypeEnum: {
|
|
1408
|
+
readonly User: "User";
|
|
1409
|
+
readonly Automation: "Automation";
|
|
1869
1410
|
};
|
|
1870
|
-
export type
|
|
1411
|
+
export type RoleAssignmentRequestBodyActorTypeEnum = typeof RoleAssignmentRequestBodyActorTypeEnum[keyof typeof RoleAssignmentRequestBodyActorTypeEnum];
|
|
1871
1412
|
/**
|
|
1872
|
-
*
|
|
1413
|
+
* Principal to assign the role to
|
|
1873
1414
|
* @export
|
|
1874
|
-
* @interface
|
|
1415
|
+
* @interface RoleAssignmentRequestBodyPrincipal
|
|
1875
1416
|
*/
|
|
1876
|
-
export interface
|
|
1417
|
+
export interface RoleAssignmentRequestBodyPrincipal {
|
|
1877
1418
|
/**
|
|
1878
1419
|
*
|
|
1879
1420
|
* @type {string}
|
|
1880
|
-
* @memberof
|
|
1421
|
+
* @memberof RoleAssignmentRequestBodyPrincipal
|
|
1881
1422
|
*/
|
|
1882
|
-
'
|
|
1883
|
-
}
|
|
1884
|
-
/**
|
|
1885
|
-
* Update teammate app access for an existing teammate. Email and name are not accepted on update; the existing values stored against the user id are reused.
|
|
1886
|
-
* @export
|
|
1887
|
-
* @interface UpdateTeammateAccessRequestBody
|
|
1888
|
-
*/
|
|
1889
|
-
export interface UpdateTeammateAccessRequestBody {
|
|
1423
|
+
'type': RoleAssignmentRequestBodyPrincipalTypeEnum;
|
|
1890
1424
|
/**
|
|
1891
|
-
*
|
|
1425
|
+
*
|
|
1892
1426
|
* @type {string}
|
|
1893
|
-
* @memberof
|
|
1427
|
+
* @memberof RoleAssignmentRequestBodyPrincipal
|
|
1894
1428
|
*/
|
|
1895
|
-
'
|
|
1429
|
+
'id': string;
|
|
1896
1430
|
/**
|
|
1897
|
-
*
|
|
1431
|
+
*
|
|
1898
1432
|
* @type {string}
|
|
1899
|
-
* @memberof
|
|
1433
|
+
* @memberof RoleAssignmentRequestBodyPrincipal
|
|
1900
1434
|
*/
|
|
1901
|
-
'
|
|
1902
|
-
/**
|
|
1903
|
-
* Org-wide store access; when false, propertyIds are required for property-scoped roles
|
|
1904
|
-
* @type {boolean}
|
|
1905
|
-
* @memberof UpdateTeammateAccessRequestBody
|
|
1906
|
-
*/
|
|
1907
|
-
'hasAccessToAllStores': boolean;
|
|
1435
|
+
'name'?: string;
|
|
1908
1436
|
/**
|
|
1909
|
-
*
|
|
1910
|
-
* @type {
|
|
1911
|
-
* @memberof
|
|
1437
|
+
*
|
|
1438
|
+
* @type {string}
|
|
1439
|
+
* @memberof RoleAssignmentRequestBodyPrincipal
|
|
1912
1440
|
*/
|
|
1913
|
-
'
|
|
1441
|
+
'email'?: string;
|
|
1914
1442
|
/**
|
|
1915
|
-
*
|
|
1916
|
-
* @type {
|
|
1917
|
-
* @memberof
|
|
1443
|
+
*
|
|
1444
|
+
* @type {string}
|
|
1445
|
+
* @memberof RoleAssignmentRequestBodyPrincipal
|
|
1918
1446
|
*/
|
|
1919
|
-
'
|
|
1447
|
+
'phone'?: string;
|
|
1920
1448
|
}
|
|
1921
|
-
export declare const
|
|
1922
|
-
readonly
|
|
1923
|
-
readonly
|
|
1924
|
-
readonly PropertyOwner: "PropertyOwner";
|
|
1925
|
-
readonly PropertyManager: "PropertyManager";
|
|
1926
|
-
readonly FinanceManager: "FinanceManager";
|
|
1927
|
-
readonly Integrator: "Integrator";
|
|
1449
|
+
export declare const RoleAssignmentRequestBodyPrincipalTypeEnum: {
|
|
1450
|
+
readonly User: "User";
|
|
1451
|
+
readonly Automation: "Automation";
|
|
1928
1452
|
};
|
|
1929
|
-
export type
|
|
1453
|
+
export type RoleAssignmentRequestBodyPrincipalTypeEnum = typeof RoleAssignmentRequestBodyPrincipalTypeEnum[keyof typeof RoleAssignmentRequestBodyPrincipalTypeEnum];
|
|
1930
1454
|
/**
|
|
1931
|
-
*
|
|
1455
|
+
* Role assignment applied
|
|
1932
1456
|
* @export
|
|
1933
|
-
* @interface
|
|
1457
|
+
* @interface RoleAssignmentSuccessResponse
|
|
1934
1458
|
*/
|
|
1935
|
-
export interface
|
|
1459
|
+
export interface RoleAssignmentSuccessResponse {
|
|
1936
1460
|
/**
|
|
1937
|
-
*
|
|
1461
|
+
*
|
|
1938
1462
|
* @type {string}
|
|
1939
|
-
* @memberof
|
|
1940
|
-
*/
|
|
1941
|
-
'appAccessLevel': V2UiRoleAssignmentRequestBodyAppAccessLevelEnum;
|
|
1942
|
-
/**
|
|
1943
|
-
* Org-wide store access; when false, propertyIds are required for property-scoped roles
|
|
1944
|
-
* @type {boolean}
|
|
1945
|
-
* @memberof V2UiRoleAssignmentRequestBody
|
|
1946
|
-
*/
|
|
1947
|
-
'hasAccessToAllStores': boolean;
|
|
1948
|
-
/**
|
|
1949
|
-
* Property resource ids (e.g. p123) when scoped to properties
|
|
1950
|
-
* @type {Array<string>}
|
|
1951
|
-
* @memberof V2UiRoleAssignmentRequestBody
|
|
1952
|
-
*/
|
|
1953
|
-
'propertyIds'?: Array<string>;
|
|
1954
|
-
/**
|
|
1955
|
-
* Optional v2 permission set keys to apply to this teammate role
|
|
1956
|
-
* @type {Array<string>}
|
|
1957
|
-
* @memberof V2UiRoleAssignmentRequestBody
|
|
1463
|
+
* @memberof RoleAssignmentSuccessResponse
|
|
1958
1464
|
*/
|
|
1959
|
-
'
|
|
1465
|
+
'message': string;
|
|
1960
1466
|
}
|
|
1961
|
-
|
|
1962
|
-
|
|
1963
|
-
|
|
1964
|
-
|
|
1965
|
-
|
|
1966
|
-
|
|
1967
|
-
readonly
|
|
1467
|
+
/**
|
|
1468
|
+
* Role names
|
|
1469
|
+
* @export
|
|
1470
|
+
* @enum {string}
|
|
1471
|
+
*/
|
|
1472
|
+
export declare const RoleNames: {
|
|
1473
|
+
readonly Admin: "Admin";
|
|
1474
|
+
readonly Factory: "Factory";
|
|
1475
|
+
readonly AuthDeveloper: "AuthDeveloper";
|
|
1968
1476
|
};
|
|
1969
|
-
export type
|
|
1477
|
+
export type RoleNames = typeof RoleNames[keyof typeof RoleNames];
|
|
1970
1478
|
/**
|
|
1971
1479
|
*
|
|
1972
1480
|
* @export
|
|
@@ -2381,34 +1889,6 @@ export declare class AuthorizedEntitiesApi extends BaseAPI {
|
|
|
2381
1889
|
* @export
|
|
2382
1890
|
*/
|
|
2383
1891
|
export declare const ConfigurationDataApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2384
|
-
/**
|
|
2385
|
-
* List the available feature based roles
|
|
2386
|
-
* @summary List Feature Based Roles
|
|
2387
|
-
* @param {*} [options] Override http request option.
|
|
2388
|
-
* @throws {RequiredError}
|
|
2389
|
-
*/
|
|
2390
|
-
configListFeatureBasedRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2391
|
-
/**
|
|
2392
|
-
* List the available permissions
|
|
2393
|
-
* @summary List Permissions
|
|
2394
|
-
* @param {*} [options] Override http request option.
|
|
2395
|
-
* @throws {RequiredError}
|
|
2396
|
-
*/
|
|
2397
|
-
configListPermissions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2398
|
-
/**
|
|
2399
|
-
* List the available roles
|
|
2400
|
-
* @summary List Roles
|
|
2401
|
-
* @param {*} [options] Override http request option.
|
|
2402
|
-
* @throws {RequiredError}
|
|
2403
|
-
*/
|
|
2404
|
-
configListRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2405
|
-
/**
|
|
2406
|
-
* List the available feature based roles
|
|
2407
|
-
* @summary List Feature Based Roles
|
|
2408
|
-
* @param {*} [options] Override http request option.
|
|
2409
|
-
* @throws {RequiredError}
|
|
2410
|
-
*/
|
|
2411
|
-
listFeatureBasedRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2412
1892
|
/**
|
|
2413
1893
|
* List the available permissions
|
|
2414
1894
|
* @summary List Permissions
|
|
@@ -2429,34 +1909,6 @@ export declare const ConfigurationDataApiAxiosParamCreator: (configuration?: Con
|
|
|
2429
1909
|
* @export
|
|
2430
1910
|
*/
|
|
2431
1911
|
export declare const ConfigurationDataApiFp: (configuration?: Configuration) => {
|
|
2432
|
-
/**
|
|
2433
|
-
* List the available feature based roles
|
|
2434
|
-
* @summary List Feature Based Roles
|
|
2435
|
-
* @param {*} [options] Override http request option.
|
|
2436
|
-
* @throws {RequiredError}
|
|
2437
|
-
*/
|
|
2438
|
-
configListFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFeatureBasedRolesSuccessResponse>>;
|
|
2439
|
-
/**
|
|
2440
|
-
* List the available permissions
|
|
2441
|
-
* @summary List Permissions
|
|
2442
|
-
* @param {*} [options] Override http request option.
|
|
2443
|
-
* @throws {RequiredError}
|
|
2444
|
-
*/
|
|
2445
|
-
configListPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPermissionsSuccessResponse>>;
|
|
2446
|
-
/**
|
|
2447
|
-
* List the available roles
|
|
2448
|
-
* @summary List Roles
|
|
2449
|
-
* @param {*} [options] Override http request option.
|
|
2450
|
-
* @throws {RequiredError}
|
|
2451
|
-
*/
|
|
2452
|
-
configListRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesSuccessResponse>>;
|
|
2453
|
-
/**
|
|
2454
|
-
* List the available feature based roles
|
|
2455
|
-
* @summary List Feature Based Roles
|
|
2456
|
-
* @param {*} [options] Override http request option.
|
|
2457
|
-
* @throws {RequiredError}
|
|
2458
|
-
*/
|
|
2459
|
-
listFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFeatureBasedRolesSuccessResponse>>;
|
|
2460
1912
|
/**
|
|
2461
1913
|
* List the available permissions
|
|
2462
1914
|
* @summary List Permissions
|
|
@@ -2477,34 +1929,6 @@ export declare const ConfigurationDataApiFp: (configuration?: Configuration) =>
|
|
|
2477
1929
|
* @export
|
|
2478
1930
|
*/
|
|
2479
1931
|
export declare const ConfigurationDataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2480
|
-
/**
|
|
2481
|
-
* List the available feature based roles
|
|
2482
|
-
* @summary List Feature Based Roles
|
|
2483
|
-
* @param {*} [options] Override http request option.
|
|
2484
|
-
* @throws {RequiredError}
|
|
2485
|
-
*/
|
|
2486
|
-
configListFeatureBasedRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListFeatureBasedRolesSuccessResponse>;
|
|
2487
|
-
/**
|
|
2488
|
-
* List the available permissions
|
|
2489
|
-
* @summary List Permissions
|
|
2490
|
-
* @param {*} [options] Override http request option.
|
|
2491
|
-
* @throws {RequiredError}
|
|
2492
|
-
*/
|
|
2493
|
-
configListPermissions(options?: RawAxiosRequestConfig): AxiosPromise<ListPermissionsSuccessResponse>;
|
|
2494
|
-
/**
|
|
2495
|
-
* List the available roles
|
|
2496
|
-
* @summary List Roles
|
|
2497
|
-
* @param {*} [options] Override http request option.
|
|
2498
|
-
* @throws {RequiredError}
|
|
2499
|
-
*/
|
|
2500
|
-
configListRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListRolesSuccessResponse>;
|
|
2501
|
-
/**
|
|
2502
|
-
* List the available feature based roles
|
|
2503
|
-
* @summary List Feature Based Roles
|
|
2504
|
-
* @param {*} [options] Override http request option.
|
|
2505
|
-
* @throws {RequiredError}
|
|
2506
|
-
*/
|
|
2507
|
-
listFeatureBasedRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListFeatureBasedRolesSuccessResponse>;
|
|
2508
1932
|
/**
|
|
2509
1933
|
* List the available permissions
|
|
2510
1934
|
* @summary List Permissions
|
|
@@ -2527,38 +1951,6 @@ export declare const ConfigurationDataApiFactory: (configuration?: Configuration
|
|
|
2527
1951
|
* @extends {BaseAPI}
|
|
2528
1952
|
*/
|
|
2529
1953
|
export declare class ConfigurationDataApi extends BaseAPI {
|
|
2530
|
-
/**
|
|
2531
|
-
* List the available feature based roles
|
|
2532
|
-
* @summary List Feature Based Roles
|
|
2533
|
-
* @param {*} [options] Override http request option.
|
|
2534
|
-
* @throws {RequiredError}
|
|
2535
|
-
* @memberof ConfigurationDataApi
|
|
2536
|
-
*/
|
|
2537
|
-
configListFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFeatureBasedRolesSuccessResponse, any, {}>>;
|
|
2538
|
-
/**
|
|
2539
|
-
* List the available permissions
|
|
2540
|
-
* @summary List Permissions
|
|
2541
|
-
* @param {*} [options] Override http request option.
|
|
2542
|
-
* @throws {RequiredError}
|
|
2543
|
-
* @memberof ConfigurationDataApi
|
|
2544
|
-
*/
|
|
2545
|
-
configListPermissions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPermissionsSuccessResponse, any, {}>>;
|
|
2546
|
-
/**
|
|
2547
|
-
* List the available roles
|
|
2548
|
-
* @summary List Roles
|
|
2549
|
-
* @param {*} [options] Override http request option.
|
|
2550
|
-
* @throws {RequiredError}
|
|
2551
|
-
* @memberof ConfigurationDataApi
|
|
2552
|
-
*/
|
|
2553
|
-
configListRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRolesSuccessResponse, any, {}>>;
|
|
2554
|
-
/**
|
|
2555
|
-
* List the available feature based roles
|
|
2556
|
-
* @summary List Feature Based Roles
|
|
2557
|
-
* @param {*} [options] Override http request option.
|
|
2558
|
-
* @throws {RequiredError}
|
|
2559
|
-
* @memberof ConfigurationDataApi
|
|
2560
|
-
*/
|
|
2561
|
-
listFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFeatureBasedRolesSuccessResponse, any, {}>>;
|
|
2562
1954
|
/**
|
|
2563
1955
|
* List the available permissions
|
|
2564
1956
|
* @summary List Permissions
|
|
@@ -2582,90 +1974,32 @@ export declare class ConfigurationDataApi extends BaseAPI {
|
|
|
2582
1974
|
*/
|
|
2583
1975
|
export declare const RoleAssignmentApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2584
1976
|
/**
|
|
2585
|
-
*
|
|
2586
|
-
* @summary
|
|
1977
|
+
* Apply a role assignment for the target user without invoking legacy teammate/Zeus role assignment flows.
|
|
1978
|
+
* @summary Apply role assignment
|
|
2587
1979
|
* @param {string} orgId
|
|
2588
|
-
* @param {
|
|
1980
|
+
* @param {RoleAssignmentRequestBody} [roleAssignmentRequestBody]
|
|
2589
1981
|
* @param {*} [options] Override http request option.
|
|
2590
1982
|
* @throws {RequiredError}
|
|
2591
1983
|
*/
|
|
2592
|
-
|
|
1984
|
+
applyRoleAssignment: (orgId: string, roleAssignmentRequestBody?: RoleAssignmentRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2593
1985
|
/**
|
|
2594
|
-
*
|
|
2595
|
-
* @summary
|
|
1986
|
+
* Rematerializes a role assignment and applies the resulting policy assignments
|
|
1987
|
+
* @summary Rematerialize Role Assignment
|
|
2596
1988
|
* @param {string} orgId
|
|
2597
|
-
* @param {
|
|
1989
|
+
* @param {RematerializeRoleAssignmentRequestBody} [rematerializeRoleAssignmentRequestBody]
|
|
2598
1990
|
* @param {*} [options] Override http request option.
|
|
2599
1991
|
* @throws {RequiredError}
|
|
2600
1992
|
*/
|
|
2601
|
-
|
|
1993
|
+
rematerializeRoleAssignmentV2: (orgId: string, rematerializeRoleAssignmentRequestBody?: RematerializeRoleAssignmentRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2602
1994
|
/**
|
|
2603
|
-
*
|
|
2604
|
-
* @summary
|
|
1995
|
+
* Revokes all V2 role assignments for the teammate in this org, reconciles away their policies, and removes them from the org user list. Does not delete the teammate account in Zeus.
|
|
1996
|
+
* @summary Remove teammate
|
|
2605
1997
|
* @param {string} orgId
|
|
2606
|
-
* @param {
|
|
2607
|
-
* @param {GrantTeammateAccessRequestBody} [grantTeammateAccessRequestBody]
|
|
1998
|
+
* @param {RemoveTeammateRequestBody} [removeTeammateRequestBody]
|
|
2608
1999
|
* @param {*} [options] Override http request option.
|
|
2609
2000
|
* @throws {RequiredError}
|
|
2610
2001
|
*/
|
|
2611
|
-
|
|
2612
|
-
/**
|
|
2613
|
-
* Apply a v2 UI role assignment without invoking legacy teammate/Zeus role assignment flows.
|
|
2614
|
-
* @summary Grant v2 teammate access to a user
|
|
2615
|
-
* @param {string} orgId
|
|
2616
|
-
* @param {string} userId Target Flipdish user id (numeric string)
|
|
2617
|
-
* @param {V2UiRoleAssignmentRequestBody} [v2UiRoleAssignmentRequestBody]
|
|
2618
|
-
* @param {*} [options] Override http request option.
|
|
2619
|
-
* @throws {RequiredError}
|
|
2620
|
-
*/
|
|
2621
|
-
grantTeammateAccessV2: (orgId: string, userId: string, v2UiRoleAssignmentRequestBody?: V2UiRoleAssignmentRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2622
|
-
/**
|
|
2623
|
-
* Rematerializes a V2 role assignment and applies the resulting policy assignments
|
|
2624
|
-
* @summary Rematerialize V2 Role Assignment
|
|
2625
|
-
* @param {string} orgId
|
|
2626
|
-
* @param {RematerializeRoleAssignmentV2RequestBody} [rematerializeRoleAssignmentV2RequestBody]
|
|
2627
|
-
* @param {*} [options] Override http request option.
|
|
2628
|
-
* @throws {RequiredError}
|
|
2629
|
-
*/
|
|
2630
|
-
rematerializeRoleAssignmentV2: (orgId: string, rematerializeRoleAssignmentV2RequestBody?: RematerializeRoleAssignmentV2RequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2631
|
-
/**
|
|
2632
|
-
* Revokes a forbidden role from a given principal (user, group, etc.)
|
|
2633
|
-
* @summary Revoke Forbidden Role from Principal
|
|
2634
|
-
* @param {string} orgId
|
|
2635
|
-
* @param {RevokeForbiddenRoleRequestBody} [revokeForbiddenRoleRequestBody]
|
|
2636
|
-
* @param {*} [options] Override http request option.
|
|
2637
|
-
* @throws {RequiredError}
|
|
2638
|
-
*/
|
|
2639
|
-
revokeForbiddenRoleFromPrincipal: (orgId: string, revokeForbiddenRoleRequestBody?: RevokeForbiddenRoleRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2640
|
-
/**
|
|
2641
|
-
* Revokes a specified role from a given principal (user, group, etc.)
|
|
2642
|
-
* @summary Revoke Role from Principal
|
|
2643
|
-
* @param {string} orgId
|
|
2644
|
-
* @param {RevokeRoleRequestBody} [revokeRoleRequestBody]
|
|
2645
|
-
* @param {*} [options] Override http request option.
|
|
2646
|
-
* @throws {RequiredError}
|
|
2647
|
-
*/
|
|
2648
|
-
revokeRoleFromPrincipal: (orgId: string, revokeRoleRequestBody?: RevokeRoleRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2649
|
-
/**
|
|
2650
|
-
* Update teammate app access and underlying permissions for an existing teammate. The user must already have been granted access for this brand. Email and name are not accepted on update; existing values are reused. Returns 404 if no existing assignment is found.
|
|
2651
|
-
* @summary Update teammate access for an existing user
|
|
2652
|
-
* @param {string} orgId
|
|
2653
|
-
* @param {string} userId Target Flipdish user id (numeric string)
|
|
2654
|
-
* @param {UpdateTeammateAccessRequestBody} [updateTeammateAccessRequestBody]
|
|
2655
|
-
* @param {*} [options] Override http request option.
|
|
2656
|
-
* @throws {RequiredError}
|
|
2657
|
-
*/
|
|
2658
|
-
updateTeammateAccess: (orgId: string, userId: string, updateTeammateAccessRequestBody?: UpdateTeammateAccessRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2659
|
-
/**
|
|
2660
|
-
* Apply a v2 UI role assignment without invoking legacy teammate/Zeus role assignment flows.
|
|
2661
|
-
* @summary Update v2 teammate access for a user
|
|
2662
|
-
* @param {string} orgId
|
|
2663
|
-
* @param {string} userId Target Flipdish user id (numeric string)
|
|
2664
|
-
* @param {V2UiRoleAssignmentRequestBody} [v2UiRoleAssignmentRequestBody]
|
|
2665
|
-
* @param {*} [options] Override http request option.
|
|
2666
|
-
* @throws {RequiredError}
|
|
2667
|
-
*/
|
|
2668
|
-
updateTeammateAccessV2: (orgId: string, userId: string, v2UiRoleAssignmentRequestBody?: V2UiRoleAssignmentRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2002
|
+
removeTeammate: (orgId: string, removeTeammateRequestBody?: RemoveTeammateRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2669
2003
|
};
|
|
2670
2004
|
/**
|
|
2671
2005
|
* RoleAssignmentApi - functional programming interface
|
|
@@ -2673,90 +2007,32 @@ export declare const RoleAssignmentApiAxiosParamCreator: (configuration?: Config
|
|
|
2673
2007
|
*/
|
|
2674
2008
|
export declare const RoleAssignmentApiFp: (configuration?: Configuration) => {
|
|
2675
2009
|
/**
|
|
2676
|
-
*
|
|
2677
|
-
* @summary
|
|
2010
|
+
* Apply a role assignment for the target user without invoking legacy teammate/Zeus role assignment flows.
|
|
2011
|
+
* @summary Apply role assignment
|
|
2678
2012
|
* @param {string} orgId
|
|
2679
|
-
* @param {
|
|
2013
|
+
* @param {RoleAssignmentRequestBody} [roleAssignmentRequestBody]
|
|
2680
2014
|
* @param {*} [options] Override http request option.
|
|
2681
2015
|
* @throws {RequiredError}
|
|
2682
2016
|
*/
|
|
2683
|
-
|
|
2017
|
+
applyRoleAssignment(orgId: string, roleAssignmentRequestBody?: RoleAssignmentRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RoleAssignmentSuccessResponse>>;
|
|
2684
2018
|
/**
|
|
2685
|
-
*
|
|
2686
|
-
* @summary
|
|
2019
|
+
* Rematerializes a role assignment and applies the resulting policy assignments
|
|
2020
|
+
* @summary Rematerialize Role Assignment
|
|
2687
2021
|
* @param {string} orgId
|
|
2688
|
-
* @param {
|
|
2022
|
+
* @param {RematerializeRoleAssignmentRequestBody} [rematerializeRoleAssignmentRequestBody]
|
|
2689
2023
|
* @param {*} [options] Override http request option.
|
|
2690
2024
|
* @throws {RequiredError}
|
|
2691
2025
|
*/
|
|
2692
|
-
|
|
2026
|
+
rematerializeRoleAssignmentV2(orgId: string, rematerializeRoleAssignmentRequestBody?: RematerializeRoleAssignmentRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RematerializeRoleAssignmentSuccessResponse>>;
|
|
2693
2027
|
/**
|
|
2694
|
-
*
|
|
2695
|
-
* @summary
|
|
2028
|
+
* Revokes all V2 role assignments for the teammate in this org, reconciles away their policies, and removes them from the org user list. Does not delete the teammate account in Zeus.
|
|
2029
|
+
* @summary Remove teammate
|
|
2696
2030
|
* @param {string} orgId
|
|
2697
|
-
* @param {
|
|
2698
|
-
* @param {GrantTeammateAccessRequestBody} [grantTeammateAccessRequestBody]
|
|
2031
|
+
* @param {RemoveTeammateRequestBody} [removeTeammateRequestBody]
|
|
2699
2032
|
* @param {*} [options] Override http request option.
|
|
2700
2033
|
* @throws {RequiredError}
|
|
2701
2034
|
*/
|
|
2702
|
-
|
|
2703
|
-
/**
|
|
2704
|
-
* Apply a v2 UI role assignment without invoking legacy teammate/Zeus role assignment flows.
|
|
2705
|
-
* @summary Grant v2 teammate access to a user
|
|
2706
|
-
* @param {string} orgId
|
|
2707
|
-
* @param {string} userId Target Flipdish user id (numeric string)
|
|
2708
|
-
* @param {V2UiRoleAssignmentRequestBody} [v2UiRoleAssignmentRequestBody]
|
|
2709
|
-
* @param {*} [options] Override http request option.
|
|
2710
|
-
* @throws {RequiredError}
|
|
2711
|
-
*/
|
|
2712
|
-
grantTeammateAccessV2(orgId: string, userId: string, v2UiRoleAssignmentRequestBody?: V2UiRoleAssignmentRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TeammateAccessSuccessResponse>>;
|
|
2713
|
-
/**
|
|
2714
|
-
* Rematerializes a V2 role assignment and applies the resulting policy assignments
|
|
2715
|
-
* @summary Rematerialize V2 Role Assignment
|
|
2716
|
-
* @param {string} orgId
|
|
2717
|
-
* @param {RematerializeRoleAssignmentV2RequestBody} [rematerializeRoleAssignmentV2RequestBody]
|
|
2718
|
-
* @param {*} [options] Override http request option.
|
|
2719
|
-
* @throws {RequiredError}
|
|
2720
|
-
*/
|
|
2721
|
-
rematerializeRoleAssignmentV2(orgId: string, rematerializeRoleAssignmentV2RequestBody?: RematerializeRoleAssignmentV2RequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RematerializeRoleAssignmentV2SuccessResponse>>;
|
|
2722
|
-
/**
|
|
2723
|
-
* Revokes a forbidden role from a given principal (user, group, etc.)
|
|
2724
|
-
* @summary Revoke Forbidden Role from Principal
|
|
2725
|
-
* @param {string} orgId
|
|
2726
|
-
* @param {RevokeForbiddenRoleRequestBody} [revokeForbiddenRoleRequestBody]
|
|
2727
|
-
* @param {*} [options] Override http request option.
|
|
2728
|
-
* @throws {RequiredError}
|
|
2729
|
-
*/
|
|
2730
|
-
revokeForbiddenRoleFromPrincipal(orgId: string, revokeForbiddenRoleRequestBody?: RevokeForbiddenRoleRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RevokeRoleSuccessResponse>>;
|
|
2731
|
-
/**
|
|
2732
|
-
* Revokes a specified role from a given principal (user, group, etc.)
|
|
2733
|
-
* @summary Revoke Role from Principal
|
|
2734
|
-
* @param {string} orgId
|
|
2735
|
-
* @param {RevokeRoleRequestBody} [revokeRoleRequestBody]
|
|
2736
|
-
* @param {*} [options] Override http request option.
|
|
2737
|
-
* @throws {RequiredError}
|
|
2738
|
-
*/
|
|
2739
|
-
revokeRoleFromPrincipal(orgId: string, revokeRoleRequestBody?: RevokeRoleRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RevokeRoleSuccessResponse>>;
|
|
2740
|
-
/**
|
|
2741
|
-
* Update teammate app access and underlying permissions for an existing teammate. The user must already have been granted access for this brand. Email and name are not accepted on update; existing values are reused. Returns 404 if no existing assignment is found.
|
|
2742
|
-
* @summary Update teammate access for an existing user
|
|
2743
|
-
* @param {string} orgId
|
|
2744
|
-
* @param {string} userId Target Flipdish user id (numeric string)
|
|
2745
|
-
* @param {UpdateTeammateAccessRequestBody} [updateTeammateAccessRequestBody]
|
|
2746
|
-
* @param {*} [options] Override http request option.
|
|
2747
|
-
* @throws {RequiredError}
|
|
2748
|
-
*/
|
|
2749
|
-
updateTeammateAccess(orgId: string, userId: string, updateTeammateAccessRequestBody?: UpdateTeammateAccessRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TeammateAccessSuccessResponse>>;
|
|
2750
|
-
/**
|
|
2751
|
-
* Apply a v2 UI role assignment without invoking legacy teammate/Zeus role assignment flows.
|
|
2752
|
-
* @summary Update v2 teammate access for a user
|
|
2753
|
-
* @param {string} orgId
|
|
2754
|
-
* @param {string} userId Target Flipdish user id (numeric string)
|
|
2755
|
-
* @param {V2UiRoleAssignmentRequestBody} [v2UiRoleAssignmentRequestBody]
|
|
2756
|
-
* @param {*} [options] Override http request option.
|
|
2757
|
-
* @throws {RequiredError}
|
|
2758
|
-
*/
|
|
2759
|
-
updateTeammateAccessV2(orgId: string, userId: string, v2UiRoleAssignmentRequestBody?: V2UiRoleAssignmentRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TeammateAccessSuccessResponse>>;
|
|
2035
|
+
removeTeammate(orgId: string, removeTeammateRequestBody?: RemoveTeammateRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoveTeammateSuccessResponse>>;
|
|
2760
2036
|
};
|
|
2761
2037
|
/**
|
|
2762
2038
|
* RoleAssignmentApi - factory interface
|
|
@@ -2764,90 +2040,32 @@ export declare const RoleAssignmentApiFp: (configuration?: Configuration) => {
|
|
|
2764
2040
|
*/
|
|
2765
2041
|
export declare const RoleAssignmentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2766
2042
|
/**
|
|
2767
|
-
*
|
|
2768
|
-
* @summary
|
|
2769
|
-
* @param {string} orgId
|
|
2770
|
-
* @param {AssignRoleRequestBody} [assignRoleRequestBody]
|
|
2771
|
-
* @param {*} [options] Override http request option.
|
|
2772
|
-
* @throws {RequiredError}
|
|
2773
|
-
*/
|
|
2774
|
-
assignRoleToPrincipal(orgId: string, assignRoleRequestBody?: AssignRoleRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<AssignRoleSuccessResponse>;
|
|
2775
|
-
/**
|
|
2776
|
-
* Get the active roles for a given principal
|
|
2777
|
-
* @summary Get Principal Roles
|
|
2778
|
-
* @param {string} orgId
|
|
2779
|
-
* @param {GetPrincipalRolesRequestBody} [getPrincipalRolesRequestBody]
|
|
2780
|
-
* @param {*} [options] Override http request option.
|
|
2781
|
-
* @throws {RequiredError}
|
|
2782
|
-
*/
|
|
2783
|
-
getPrincipalRoles(orgId: string, getPrincipalRolesRequestBody?: GetPrincipalRolesRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<GetPrincipalRolesSuccessResponse>;
|
|
2784
|
-
/**
|
|
2785
|
-
* Grant teammate app access and underlying permissions for a user being assigned within a brand for the first time. Email and name are persisted on first assignment only and must be supplied here.
|
|
2786
|
-
* @summary Grant teammate access to a new user
|
|
2787
|
-
* @param {string} orgId
|
|
2788
|
-
* @param {string} userId Target Flipdish user id (numeric string)
|
|
2789
|
-
* @param {GrantTeammateAccessRequestBody} [grantTeammateAccessRequestBody]
|
|
2790
|
-
* @param {*} [options] Override http request option.
|
|
2791
|
-
* @throws {RequiredError}
|
|
2792
|
-
*/
|
|
2793
|
-
grantTeammateAccess(orgId: string, userId: string, grantTeammateAccessRequestBody?: GrantTeammateAccessRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<TeammateAccessSuccessResponse>;
|
|
2794
|
-
/**
|
|
2795
|
-
* Apply a v2 UI role assignment without invoking legacy teammate/Zeus role assignment flows.
|
|
2796
|
-
* @summary Grant v2 teammate access to a user
|
|
2043
|
+
* Apply a role assignment for the target user without invoking legacy teammate/Zeus role assignment flows.
|
|
2044
|
+
* @summary Apply role assignment
|
|
2797
2045
|
* @param {string} orgId
|
|
2798
|
-
* @param {
|
|
2799
|
-
* @param {V2UiRoleAssignmentRequestBody} [v2UiRoleAssignmentRequestBody]
|
|
2046
|
+
* @param {RoleAssignmentRequestBody} [roleAssignmentRequestBody]
|
|
2800
2047
|
* @param {*} [options] Override http request option.
|
|
2801
2048
|
* @throws {RequiredError}
|
|
2802
2049
|
*/
|
|
2803
|
-
|
|
2050
|
+
applyRoleAssignment(orgId: string, roleAssignmentRequestBody?: RoleAssignmentRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<RoleAssignmentSuccessResponse>;
|
|
2804
2051
|
/**
|
|
2805
|
-
* Rematerializes a
|
|
2806
|
-
* @summary Rematerialize
|
|
2052
|
+
* Rematerializes a role assignment and applies the resulting policy assignments
|
|
2053
|
+
* @summary Rematerialize Role Assignment
|
|
2807
2054
|
* @param {string} orgId
|
|
2808
|
-
* @param {
|
|
2055
|
+
* @param {RematerializeRoleAssignmentRequestBody} [rematerializeRoleAssignmentRequestBody]
|
|
2809
2056
|
* @param {*} [options] Override http request option.
|
|
2810
2057
|
* @throws {RequiredError}
|
|
2811
2058
|
*/
|
|
2812
|
-
rematerializeRoleAssignmentV2(orgId: string,
|
|
2059
|
+
rematerializeRoleAssignmentV2(orgId: string, rematerializeRoleAssignmentRequestBody?: RematerializeRoleAssignmentRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<RematerializeRoleAssignmentSuccessResponse>;
|
|
2813
2060
|
/**
|
|
2814
|
-
* Revokes
|
|
2815
|
-
* @summary
|
|
2061
|
+
* Revokes all V2 role assignments for the teammate in this org, reconciles away their policies, and removes them from the org user list. Does not delete the teammate account in Zeus.
|
|
2062
|
+
* @summary Remove teammate
|
|
2816
2063
|
* @param {string} orgId
|
|
2817
|
-
* @param {
|
|
2064
|
+
* @param {RemoveTeammateRequestBody} [removeTeammateRequestBody]
|
|
2818
2065
|
* @param {*} [options] Override http request option.
|
|
2819
2066
|
* @throws {RequiredError}
|
|
2820
2067
|
*/
|
|
2821
|
-
|
|
2822
|
-
/**
|
|
2823
|
-
* Revokes a specified role from a given principal (user, group, etc.)
|
|
2824
|
-
* @summary Revoke Role from Principal
|
|
2825
|
-
* @param {string} orgId
|
|
2826
|
-
* @param {RevokeRoleRequestBody} [revokeRoleRequestBody]
|
|
2827
|
-
* @param {*} [options] Override http request option.
|
|
2828
|
-
* @throws {RequiredError}
|
|
2829
|
-
*/
|
|
2830
|
-
revokeRoleFromPrincipal(orgId: string, revokeRoleRequestBody?: RevokeRoleRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<RevokeRoleSuccessResponse>;
|
|
2831
|
-
/**
|
|
2832
|
-
* Update teammate app access and underlying permissions for an existing teammate. The user must already have been granted access for this brand. Email and name are not accepted on update; existing values are reused. Returns 404 if no existing assignment is found.
|
|
2833
|
-
* @summary Update teammate access for an existing user
|
|
2834
|
-
* @param {string} orgId
|
|
2835
|
-
* @param {string} userId Target Flipdish user id (numeric string)
|
|
2836
|
-
* @param {UpdateTeammateAccessRequestBody} [updateTeammateAccessRequestBody]
|
|
2837
|
-
* @param {*} [options] Override http request option.
|
|
2838
|
-
* @throws {RequiredError}
|
|
2839
|
-
*/
|
|
2840
|
-
updateTeammateAccess(orgId: string, userId: string, updateTeammateAccessRequestBody?: UpdateTeammateAccessRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<TeammateAccessSuccessResponse>;
|
|
2841
|
-
/**
|
|
2842
|
-
* Apply a v2 UI role assignment without invoking legacy teammate/Zeus role assignment flows.
|
|
2843
|
-
* @summary Update v2 teammate access for a user
|
|
2844
|
-
* @param {string} orgId
|
|
2845
|
-
* @param {string} userId Target Flipdish user id (numeric string)
|
|
2846
|
-
* @param {V2UiRoleAssignmentRequestBody} [v2UiRoleAssignmentRequestBody]
|
|
2847
|
-
* @param {*} [options] Override http request option.
|
|
2848
|
-
* @throws {RequiredError}
|
|
2849
|
-
*/
|
|
2850
|
-
updateTeammateAccessV2(orgId: string, userId: string, v2UiRoleAssignmentRequestBody?: V2UiRoleAssignmentRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<TeammateAccessSuccessResponse>;
|
|
2068
|
+
removeTeammate(orgId: string, removeTeammateRequestBody?: RemoveTeammateRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<RemoveTeammateSuccessResponse>;
|
|
2851
2069
|
};
|
|
2852
2070
|
/**
|
|
2853
2071
|
* RoleAssignmentApi - object-oriented interface
|
|
@@ -2857,99 +2075,35 @@ export declare const RoleAssignmentApiFactory: (configuration?: Configuration, b
|
|
|
2857
2075
|
*/
|
|
2858
2076
|
export declare class RoleAssignmentApi extends BaseAPI {
|
|
2859
2077
|
/**
|
|
2860
|
-
*
|
|
2861
|
-
* @summary
|
|
2862
|
-
* @param {string} orgId
|
|
2863
|
-
* @param {AssignRoleRequestBody} [assignRoleRequestBody]
|
|
2864
|
-
* @param {*} [options] Override http request option.
|
|
2865
|
-
* @throws {RequiredError}
|
|
2866
|
-
* @memberof RoleAssignmentApi
|
|
2867
|
-
*/
|
|
2868
|
-
assignRoleToPrincipal(orgId: string, assignRoleRequestBody?: AssignRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AssignRoleSuccessResponse, any, {}>>;
|
|
2869
|
-
/**
|
|
2870
|
-
* Get the active roles for a given principal
|
|
2871
|
-
* @summary Get Principal Roles
|
|
2872
|
-
* @param {string} orgId
|
|
2873
|
-
* @param {GetPrincipalRolesRequestBody} [getPrincipalRolesRequestBody]
|
|
2874
|
-
* @param {*} [options] Override http request option.
|
|
2875
|
-
* @throws {RequiredError}
|
|
2876
|
-
* @memberof RoleAssignmentApi
|
|
2877
|
-
*/
|
|
2878
|
-
getPrincipalRoles(orgId: string, getPrincipalRolesRequestBody?: GetPrincipalRolesRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPrincipalRolesSuccessResponse, any, {}>>;
|
|
2879
|
-
/**
|
|
2880
|
-
* Grant teammate app access and underlying permissions for a user being assigned within a brand for the first time. Email and name are persisted on first assignment only and must be supplied here.
|
|
2881
|
-
* @summary Grant teammate access to a new user
|
|
2078
|
+
* Apply a role assignment for the target user without invoking legacy teammate/Zeus role assignment flows.
|
|
2079
|
+
* @summary Apply role assignment
|
|
2882
2080
|
* @param {string} orgId
|
|
2883
|
-
* @param {
|
|
2884
|
-
* @param {GrantTeammateAccessRequestBody} [grantTeammateAccessRequestBody]
|
|
2081
|
+
* @param {RoleAssignmentRequestBody} [roleAssignmentRequestBody]
|
|
2885
2082
|
* @param {*} [options] Override http request option.
|
|
2886
2083
|
* @throws {RequiredError}
|
|
2887
2084
|
* @memberof RoleAssignmentApi
|
|
2888
2085
|
*/
|
|
2889
|
-
|
|
2086
|
+
applyRoleAssignment(orgId: string, roleAssignmentRequestBody?: RoleAssignmentRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RoleAssignmentSuccessResponse, any, {}>>;
|
|
2890
2087
|
/**
|
|
2891
|
-
*
|
|
2892
|
-
* @summary
|
|
2088
|
+
* Rematerializes a role assignment and applies the resulting policy assignments
|
|
2089
|
+
* @summary Rematerialize Role Assignment
|
|
2893
2090
|
* @param {string} orgId
|
|
2894
|
-
* @param {
|
|
2895
|
-
* @param {V2UiRoleAssignmentRequestBody} [v2UiRoleAssignmentRequestBody]
|
|
2091
|
+
* @param {RematerializeRoleAssignmentRequestBody} [rematerializeRoleAssignmentRequestBody]
|
|
2896
2092
|
* @param {*} [options] Override http request option.
|
|
2897
2093
|
* @throws {RequiredError}
|
|
2898
2094
|
* @memberof RoleAssignmentApi
|
|
2899
2095
|
*/
|
|
2900
|
-
|
|
2096
|
+
rematerializeRoleAssignmentV2(orgId: string, rematerializeRoleAssignmentRequestBody?: RematerializeRoleAssignmentRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RematerializeRoleAssignmentSuccessResponse, any, {}>>;
|
|
2901
2097
|
/**
|
|
2902
|
-
*
|
|
2903
|
-
* @summary
|
|
2098
|
+
* Revokes all V2 role assignments for the teammate in this org, reconciles away their policies, and removes them from the org user list. Does not delete the teammate account in Zeus.
|
|
2099
|
+
* @summary Remove teammate
|
|
2904
2100
|
* @param {string} orgId
|
|
2905
|
-
* @param {
|
|
2101
|
+
* @param {RemoveTeammateRequestBody} [removeTeammateRequestBody]
|
|
2906
2102
|
* @param {*} [options] Override http request option.
|
|
2907
2103
|
* @throws {RequiredError}
|
|
2908
2104
|
* @memberof RoleAssignmentApi
|
|
2909
2105
|
*/
|
|
2910
|
-
|
|
2911
|
-
/**
|
|
2912
|
-
* Revokes a forbidden role from a given principal (user, group, etc.)
|
|
2913
|
-
* @summary Revoke Forbidden Role from Principal
|
|
2914
|
-
* @param {string} orgId
|
|
2915
|
-
* @param {RevokeForbiddenRoleRequestBody} [revokeForbiddenRoleRequestBody]
|
|
2916
|
-
* @param {*} [options] Override http request option.
|
|
2917
|
-
* @throws {RequiredError}
|
|
2918
|
-
* @memberof RoleAssignmentApi
|
|
2919
|
-
*/
|
|
2920
|
-
revokeForbiddenRoleFromPrincipal(orgId: string, revokeForbiddenRoleRequestBody?: RevokeForbiddenRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeRoleSuccessResponse, any, {}>>;
|
|
2921
|
-
/**
|
|
2922
|
-
* Revokes a specified role from a given principal (user, group, etc.)
|
|
2923
|
-
* @summary Revoke Role from Principal
|
|
2924
|
-
* @param {string} orgId
|
|
2925
|
-
* @param {RevokeRoleRequestBody} [revokeRoleRequestBody]
|
|
2926
|
-
* @param {*} [options] Override http request option.
|
|
2927
|
-
* @throws {RequiredError}
|
|
2928
|
-
* @memberof RoleAssignmentApi
|
|
2929
|
-
*/
|
|
2930
|
-
revokeRoleFromPrincipal(orgId: string, revokeRoleRequestBody?: RevokeRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeRoleSuccessResponse, any, {}>>;
|
|
2931
|
-
/**
|
|
2932
|
-
* Update teammate app access and underlying permissions for an existing teammate. The user must already have been granted access for this brand. Email and name are not accepted on update; existing values are reused. Returns 404 if no existing assignment is found.
|
|
2933
|
-
* @summary Update teammate access for an existing user
|
|
2934
|
-
* @param {string} orgId
|
|
2935
|
-
* @param {string} userId Target Flipdish user id (numeric string)
|
|
2936
|
-
* @param {UpdateTeammateAccessRequestBody} [updateTeammateAccessRequestBody]
|
|
2937
|
-
* @param {*} [options] Override http request option.
|
|
2938
|
-
* @throws {RequiredError}
|
|
2939
|
-
* @memberof RoleAssignmentApi
|
|
2940
|
-
*/
|
|
2941
|
-
updateTeammateAccess(orgId: string, userId: string, updateTeammateAccessRequestBody?: UpdateTeammateAccessRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TeammateAccessSuccessResponse, any, {}>>;
|
|
2942
|
-
/**
|
|
2943
|
-
* Apply a v2 UI role assignment without invoking legacy teammate/Zeus role assignment flows.
|
|
2944
|
-
* @summary Update v2 teammate access for a user
|
|
2945
|
-
* @param {string} orgId
|
|
2946
|
-
* @param {string} userId Target Flipdish user id (numeric string)
|
|
2947
|
-
* @param {V2UiRoleAssignmentRequestBody} [v2UiRoleAssignmentRequestBody]
|
|
2948
|
-
* @param {*} [options] Override http request option.
|
|
2949
|
-
* @throws {RequiredError}
|
|
2950
|
-
* @memberof RoleAssignmentApi
|
|
2951
|
-
*/
|
|
2952
|
-
updateTeammateAccessV2(orgId: string, userId: string, v2UiRoleAssignmentRequestBody?: V2UiRoleAssignmentRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TeammateAccessSuccessResponse, any, {}>>;
|
|
2106
|
+
removeTeammate(orgId: string, removeTeammateRequestBody?: RemoveTeammateRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RemoveTeammateSuccessResponse, any, {}>>;
|
|
2953
2107
|
}
|
|
2954
2108
|
/**
|
|
2955
2109
|
* UserManagementApi - axios parameter creator
|
|
@@ -2964,22 +2118,6 @@ export declare const UserManagementApiAxiosParamCreator: (configuration?: Config
|
|
|
2964
2118
|
* @throws {RequiredError}
|
|
2965
2119
|
*/
|
|
2966
2120
|
listUsersInOrg: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2967
|
-
/**
|
|
2968
|
-
* List the users in a given org for the v2 control plane UI
|
|
2969
|
-
* @summary List Users in Org V2
|
|
2970
|
-
* @param {string} orgId
|
|
2971
|
-
* @param {*} [options] Override http request option.
|
|
2972
|
-
* @throws {RequiredError}
|
|
2973
|
-
*/
|
|
2974
|
-
listUsersInOrgV2: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2975
|
-
/**
|
|
2976
|
-
* Same principals as list users, plus roleDisplay and isCustomised per principal (extra Dynamo reads for compensating roles and granular assignments).
|
|
2977
|
-
* @summary List Users in Org with teammate permission summary
|
|
2978
|
-
* @param {string} orgId
|
|
2979
|
-
* @param {*} [options] Override http request option.
|
|
2980
|
-
* @throws {RequiredError}
|
|
2981
|
-
*/
|
|
2982
|
-
listUsersInOrgWithTeammatePermissionSummary: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2983
2121
|
};
|
|
2984
2122
|
/**
|
|
2985
2123
|
* UserManagementApi - functional programming interface
|
|
@@ -2994,22 +2132,6 @@ export declare const UserManagementApiFp: (configuration?: Configuration) => {
|
|
|
2994
2132
|
* @throws {RequiredError}
|
|
2995
2133
|
*/
|
|
2996
2134
|
listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PrincipalsInOrgResponse>>;
|
|
2997
|
-
/**
|
|
2998
|
-
* List the users in a given org for the v2 control plane UI
|
|
2999
|
-
* @summary List Users in Org V2
|
|
3000
|
-
* @param {string} orgId
|
|
3001
|
-
* @param {*} [options] Override http request option.
|
|
3002
|
-
* @throws {RequiredError}
|
|
3003
|
-
*/
|
|
3004
|
-
listUsersInOrgV2(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PrincipalsInOrgResponse>>;
|
|
3005
|
-
/**
|
|
3006
|
-
* Same principals as list users, plus roleDisplay and isCustomised per principal (extra Dynamo reads for compensating roles and granular assignments).
|
|
3007
|
-
* @summary List Users in Org with teammate permission summary
|
|
3008
|
-
* @param {string} orgId
|
|
3009
|
-
* @param {*} [options] Override http request option.
|
|
3010
|
-
* @throws {RequiredError}
|
|
3011
|
-
*/
|
|
3012
|
-
listUsersInOrgWithTeammatePermissionSummary(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PrincipalsInOrgWithTeammatePermissionSummaryResponse>>;
|
|
3013
2135
|
};
|
|
3014
2136
|
/**
|
|
3015
2137
|
* UserManagementApi - factory interface
|
|
@@ -3024,22 +2146,6 @@ export declare const UserManagementApiFactory: (configuration?: Configuration, b
|
|
|
3024
2146
|
* @throws {RequiredError}
|
|
3025
2147
|
*/
|
|
3026
2148
|
listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<PrincipalsInOrgResponse>;
|
|
3027
|
-
/**
|
|
3028
|
-
* List the users in a given org for the v2 control plane UI
|
|
3029
|
-
* @summary List Users in Org V2
|
|
3030
|
-
* @param {string} orgId
|
|
3031
|
-
* @param {*} [options] Override http request option.
|
|
3032
|
-
* @throws {RequiredError}
|
|
3033
|
-
*/
|
|
3034
|
-
listUsersInOrgV2(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<PrincipalsInOrgResponse>;
|
|
3035
|
-
/**
|
|
3036
|
-
* Same principals as list users, plus roleDisplay and isCustomised per principal (extra Dynamo reads for compensating roles and granular assignments).
|
|
3037
|
-
* @summary List Users in Org with teammate permission summary
|
|
3038
|
-
* @param {string} orgId
|
|
3039
|
-
* @param {*} [options] Override http request option.
|
|
3040
|
-
* @throws {RequiredError}
|
|
3041
|
-
*/
|
|
3042
|
-
listUsersInOrgWithTeammatePermissionSummary(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<PrincipalsInOrgWithTeammatePermissionSummaryResponse>;
|
|
3043
2149
|
};
|
|
3044
2150
|
/**
|
|
3045
2151
|
* UserManagementApi - object-oriented interface
|
|
@@ -3057,24 +2163,6 @@ export declare class UserManagementApi extends BaseAPI {
|
|
|
3057
2163
|
* @memberof UserManagementApi
|
|
3058
2164
|
*/
|
|
3059
2165
|
listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PrincipalsInOrgResponse, any, {}>>;
|
|
3060
|
-
/**
|
|
3061
|
-
* List the users in a given org for the v2 control plane UI
|
|
3062
|
-
* @summary List Users in Org V2
|
|
3063
|
-
* @param {string} orgId
|
|
3064
|
-
* @param {*} [options] Override http request option.
|
|
3065
|
-
* @throws {RequiredError}
|
|
3066
|
-
* @memberof UserManagementApi
|
|
3067
|
-
*/
|
|
3068
|
-
listUsersInOrgV2(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PrincipalsInOrgResponse, any, {}>>;
|
|
3069
|
-
/**
|
|
3070
|
-
* Same principals as list users, plus roleDisplay and isCustomised per principal (extra Dynamo reads for compensating roles and granular assignments).
|
|
3071
|
-
* @summary List Users in Org with teammate permission summary
|
|
3072
|
-
* @param {string} orgId
|
|
3073
|
-
* @param {*} [options] Override http request option.
|
|
3074
|
-
* @throws {RequiredError}
|
|
3075
|
-
* @memberof UserManagementApi
|
|
3076
|
-
*/
|
|
3077
|
-
listUsersInOrgWithTeammatePermissionSummary(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PrincipalsInOrgWithTeammatePermissionSummaryResponse, any, {}>>;
|
|
3078
2166
|
}
|
|
3079
2167
|
/**
|
|
3080
2168
|
* UserPermissionsApi - axios parameter creator
|
|
@@ -3082,7 +2170,7 @@ export declare class UserManagementApi extends BaseAPI {
|
|
|
3082
2170
|
*/
|
|
3083
2171
|
export declare const UserPermissionsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3084
2172
|
/**
|
|
3085
|
-
* List the
|
|
2173
|
+
* List the current permission assignments in the org
|
|
3086
2174
|
* @summary List Org Permissions
|
|
3087
2175
|
* @param {string} orgId
|
|
3088
2176
|
* @param {*} [options] Override http request option.
|
|
@@ -3090,29 +2178,13 @@ export declare const UserPermissionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
3090
2178
|
*/
|
|
3091
2179
|
listOrgPermissions: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3092
2180
|
/**
|
|
3093
|
-
* List the
|
|
3094
|
-
* @summary List Org Permissions V2
|
|
3095
|
-
* @param {string} orgId
|
|
3096
|
-
* @param {*} [options] Override http request option.
|
|
3097
|
-
* @throws {RequiredError}
|
|
3098
|
-
*/
|
|
3099
|
-
listOrgPermissionsV2: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3100
|
-
/**
|
|
3101
|
-
* List the available roles for the current user
|
|
2181
|
+
* List the current roles assignments in the org
|
|
3102
2182
|
* @summary List Org Roles
|
|
3103
2183
|
* @param {string} orgId
|
|
3104
2184
|
* @param {*} [options] Override http request option.
|
|
3105
2185
|
* @throws {RequiredError}
|
|
3106
2186
|
*/
|
|
3107
2187
|
listOrgRoles: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3108
|
-
/**
|
|
3109
|
-
* List the v2 role assignments for an org
|
|
3110
|
-
* @summary List Org Roles V2
|
|
3111
|
-
* @param {string} orgId
|
|
3112
|
-
* @param {*} [options] Override http request option.
|
|
3113
|
-
* @throws {RequiredError}
|
|
3114
|
-
*/
|
|
3115
|
-
listOrgRolesV2: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3116
2188
|
/**
|
|
3117
2189
|
* List the available permissions for the current user
|
|
3118
2190
|
* @summary List Own Permissions
|
|
@@ -3121,14 +2193,6 @@ export declare const UserPermissionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
3121
2193
|
* @throws {RequiredError}
|
|
3122
2194
|
*/
|
|
3123
2195
|
listOwnPermissions: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3124
|
-
/**
|
|
3125
|
-
* List the v2 materialized permissions for the current user
|
|
3126
|
-
* @summary List Own Permissions V2
|
|
3127
|
-
* @param {string} orgId
|
|
3128
|
-
* @param {*} [options] Override http request option.
|
|
3129
|
-
* @throws {RequiredError}
|
|
3130
|
-
*/
|
|
3131
|
-
listOwnPermissionsV2: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3132
2196
|
/**
|
|
3133
2197
|
* List the available permissions for a given user
|
|
3134
2198
|
* @summary List User Permissions
|
|
@@ -3138,15 +2202,6 @@ export declare const UserPermissionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
3138
2202
|
* @throws {RequiredError}
|
|
3139
2203
|
*/
|
|
3140
2204
|
listUserPermissions: (orgId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3141
|
-
/**
|
|
3142
|
-
* List the v2 materialized permissions for a given user
|
|
3143
|
-
* @summary List User Permissions V2
|
|
3144
|
-
* @param {string} orgId
|
|
3145
|
-
* @param {string} userId
|
|
3146
|
-
* @param {*} [options] Override http request option.
|
|
3147
|
-
* @throws {RequiredError}
|
|
3148
|
-
*/
|
|
3149
|
-
listUserPermissionsV2: (orgId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3150
2205
|
};
|
|
3151
2206
|
/**
|
|
3152
2207
|
* UserPermissionsApi - functional programming interface
|
|
@@ -3154,7 +2209,7 @@ export declare const UserPermissionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
3154
2209
|
*/
|
|
3155
2210
|
export declare const UserPermissionsApiFp: (configuration?: Configuration) => {
|
|
3156
2211
|
/**
|
|
3157
|
-
* List the
|
|
2212
|
+
* List the current permission assignments in the org
|
|
3158
2213
|
* @summary List Org Permissions
|
|
3159
2214
|
* @param {string} orgId
|
|
3160
2215
|
* @param {*} [options] Override http request option.
|
|
@@ -3166,19 +2221,7 @@ export declare const UserPermissionsApiFp: (configuration?: Configuration) => {
|
|
|
3166
2221
|
};
|
|
3167
2222
|
}>>;
|
|
3168
2223
|
/**
|
|
3169
|
-
* List the
|
|
3170
|
-
* @summary List Org Permissions V2
|
|
3171
|
-
* @param {string} orgId
|
|
3172
|
-
* @param {*} [options] Override http request option.
|
|
3173
|
-
* @throws {RequiredError}
|
|
3174
|
-
*/
|
|
3175
|
-
listOrgPermissionsV2(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
3176
|
-
[key: string]: {
|
|
3177
|
-
[key: string]: GetUserPermissionsSuccessResponseResourcesValue;
|
|
3178
|
-
};
|
|
3179
|
-
}>>;
|
|
3180
|
-
/**
|
|
3181
|
-
* List the available roles for the current user
|
|
2224
|
+
* List the current roles assignments in the org
|
|
3182
2225
|
* @summary List Org Roles
|
|
3183
2226
|
* @param {string} orgId
|
|
3184
2227
|
* @param {*} [options] Override http request option.
|
|
@@ -3187,16 +2230,6 @@ export declare const UserPermissionsApiFp: (configuration?: Configuration) => {
|
|
|
3187
2230
|
listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
3188
2231
|
[key: string]: ListOrgRolesSuccessResponseValue;
|
|
3189
2232
|
}>>;
|
|
3190
|
-
/**
|
|
3191
|
-
* List the v2 role assignments for an org
|
|
3192
|
-
* @summary List Org Roles V2
|
|
3193
|
-
* @param {string} orgId
|
|
3194
|
-
* @param {*} [options] Override http request option.
|
|
3195
|
-
* @throws {RequiredError}
|
|
3196
|
-
*/
|
|
3197
|
-
listOrgRolesV2(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
3198
|
-
[key: string]: ListOrgRolesSuccessResponseValue;
|
|
3199
|
-
}>>;
|
|
3200
2233
|
/**
|
|
3201
2234
|
* List the available permissions for the current user
|
|
3202
2235
|
* @summary List Own Permissions
|
|
@@ -3205,14 +2238,6 @@ export declare const UserPermissionsApiFp: (configuration?: Configuration) => {
|
|
|
3205
2238
|
* @throws {RequiredError}
|
|
3206
2239
|
*/
|
|
3207
2240
|
listOwnPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUserPermissionsSuccessResponse>>;
|
|
3208
|
-
/**
|
|
3209
|
-
* List the v2 materialized permissions for the current user
|
|
3210
|
-
* @summary List Own Permissions V2
|
|
3211
|
-
* @param {string} orgId
|
|
3212
|
-
* @param {*} [options] Override http request option.
|
|
3213
|
-
* @throws {RequiredError}
|
|
3214
|
-
*/
|
|
3215
|
-
listOwnPermissionsV2(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUserPermissionsSuccessResponse>>;
|
|
3216
2241
|
/**
|
|
3217
2242
|
* List the available permissions for a given user
|
|
3218
2243
|
* @summary List User Permissions
|
|
@@ -3222,15 +2247,6 @@ export declare const UserPermissionsApiFp: (configuration?: Configuration) => {
|
|
|
3222
2247
|
* @throws {RequiredError}
|
|
3223
2248
|
*/
|
|
3224
2249
|
listUserPermissions(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUserPermissionsSuccessResponse>>;
|
|
3225
|
-
/**
|
|
3226
|
-
* List the v2 materialized permissions for a given user
|
|
3227
|
-
* @summary List User Permissions V2
|
|
3228
|
-
* @param {string} orgId
|
|
3229
|
-
* @param {string} userId
|
|
3230
|
-
* @param {*} [options] Override http request option.
|
|
3231
|
-
* @throws {RequiredError}
|
|
3232
|
-
*/
|
|
3233
|
-
listUserPermissionsV2(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUserPermissionsSuccessResponse>>;
|
|
3234
2250
|
};
|
|
3235
2251
|
/**
|
|
3236
2252
|
* UserPermissionsApi - factory interface
|
|
@@ -3238,7 +2254,7 @@ export declare const UserPermissionsApiFp: (configuration?: Configuration) => {
|
|
|
3238
2254
|
*/
|
|
3239
2255
|
export declare const UserPermissionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3240
2256
|
/**
|
|
3241
|
-
* List the
|
|
2257
|
+
* List the current permission assignments in the org
|
|
3242
2258
|
* @summary List Org Permissions
|
|
3243
2259
|
* @param {string} orgId
|
|
3244
2260
|
* @param {*} [options] Override http request option.
|
|
@@ -3250,19 +2266,7 @@ export declare const UserPermissionsApiFactory: (configuration?: Configuration,
|
|
|
3250
2266
|
};
|
|
3251
2267
|
}>;
|
|
3252
2268
|
/**
|
|
3253
|
-
* List the
|
|
3254
|
-
* @summary List Org Permissions V2
|
|
3255
|
-
* @param {string} orgId
|
|
3256
|
-
* @param {*} [options] Override http request option.
|
|
3257
|
-
* @throws {RequiredError}
|
|
3258
|
-
*/
|
|
3259
|
-
listOrgPermissionsV2(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
3260
|
-
[key: string]: {
|
|
3261
|
-
[key: string]: GetUserPermissionsSuccessResponseResourcesValue;
|
|
3262
|
-
};
|
|
3263
|
-
}>;
|
|
3264
|
-
/**
|
|
3265
|
-
* List the available roles for the current user
|
|
2269
|
+
* List the current roles assignments in the org
|
|
3266
2270
|
* @summary List Org Roles
|
|
3267
2271
|
* @param {string} orgId
|
|
3268
2272
|
* @param {*} [options] Override http request option.
|
|
@@ -3271,16 +2275,6 @@ export declare const UserPermissionsApiFactory: (configuration?: Configuration,
|
|
|
3271
2275
|
listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
3272
2276
|
[key: string]: ListOrgRolesSuccessResponseValue;
|
|
3273
2277
|
}>;
|
|
3274
|
-
/**
|
|
3275
|
-
* List the v2 role assignments for an org
|
|
3276
|
-
* @summary List Org Roles V2
|
|
3277
|
-
* @param {string} orgId
|
|
3278
|
-
* @param {*} [options] Override http request option.
|
|
3279
|
-
* @throws {RequiredError}
|
|
3280
|
-
*/
|
|
3281
|
-
listOrgRolesV2(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
3282
|
-
[key: string]: ListOrgRolesSuccessResponseValue;
|
|
3283
|
-
}>;
|
|
3284
2278
|
/**
|
|
3285
2279
|
* List the available permissions for the current user
|
|
3286
2280
|
* @summary List Own Permissions
|
|
@@ -3289,14 +2283,6 @@ export declare const UserPermissionsApiFactory: (configuration?: Configuration,
|
|
|
3289
2283
|
* @throws {RequiredError}
|
|
3290
2284
|
*/
|
|
3291
2285
|
listOwnPermissions(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetUserPermissionsSuccessResponse>;
|
|
3292
|
-
/**
|
|
3293
|
-
* List the v2 materialized permissions for the current user
|
|
3294
|
-
* @summary List Own Permissions V2
|
|
3295
|
-
* @param {string} orgId
|
|
3296
|
-
* @param {*} [options] Override http request option.
|
|
3297
|
-
* @throws {RequiredError}
|
|
3298
|
-
*/
|
|
3299
|
-
listOwnPermissionsV2(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetUserPermissionsSuccessResponse>;
|
|
3300
2286
|
/**
|
|
3301
2287
|
* List the available permissions for a given user
|
|
3302
2288
|
* @summary List User Permissions
|
|
@@ -3306,15 +2292,6 @@ export declare const UserPermissionsApiFactory: (configuration?: Configuration,
|
|
|
3306
2292
|
* @throws {RequiredError}
|
|
3307
2293
|
*/
|
|
3308
2294
|
listUserPermissions(orgId: string, userId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetUserPermissionsSuccessResponse>;
|
|
3309
|
-
/**
|
|
3310
|
-
* List the v2 materialized permissions for a given user
|
|
3311
|
-
* @summary List User Permissions V2
|
|
3312
|
-
* @param {string} orgId
|
|
3313
|
-
* @param {string} userId
|
|
3314
|
-
* @param {*} [options] Override http request option.
|
|
3315
|
-
* @throws {RequiredError}
|
|
3316
|
-
*/
|
|
3317
|
-
listUserPermissionsV2(orgId: string, userId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetUserPermissionsSuccessResponse>;
|
|
3318
2295
|
};
|
|
3319
2296
|
/**
|
|
3320
2297
|
* UserPermissionsApi - object-oriented interface
|
|
@@ -3324,7 +2301,7 @@ export declare const UserPermissionsApiFactory: (configuration?: Configuration,
|
|
|
3324
2301
|
*/
|
|
3325
2302
|
export declare class UserPermissionsApi extends BaseAPI {
|
|
3326
2303
|
/**
|
|
3327
|
-
* List the
|
|
2304
|
+
* List the current permission assignments in the org
|
|
3328
2305
|
* @summary List Org Permissions
|
|
3329
2306
|
* @param {string} orgId
|
|
3330
2307
|
* @param {*} [options] Override http request option.
|
|
@@ -3337,20 +2314,7 @@ export declare class UserPermissionsApi extends BaseAPI {
|
|
|
3337
2314
|
};
|
|
3338
2315
|
}, any, {}>>;
|
|
3339
2316
|
/**
|
|
3340
|
-
* List the
|
|
3341
|
-
* @summary List Org Permissions V2
|
|
3342
|
-
* @param {string} orgId
|
|
3343
|
-
* @param {*} [options] Override http request option.
|
|
3344
|
-
* @throws {RequiredError}
|
|
3345
|
-
* @memberof UserPermissionsApi
|
|
3346
|
-
*/
|
|
3347
|
-
listOrgPermissionsV2(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
3348
|
-
[key: string]: {
|
|
3349
|
-
[key: string]: GetUserPermissionsSuccessResponseResourcesValue;
|
|
3350
|
-
};
|
|
3351
|
-
}, any, {}>>;
|
|
3352
|
-
/**
|
|
3353
|
-
* List the available roles for the current user
|
|
2317
|
+
* List the current roles assignments in the org
|
|
3354
2318
|
* @summary List Org Roles
|
|
3355
2319
|
* @param {string} orgId
|
|
3356
2320
|
* @param {*} [options] Override http request option.
|
|
@@ -3360,17 +2324,6 @@ export declare class UserPermissionsApi extends BaseAPI {
|
|
|
3360
2324
|
listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
3361
2325
|
[key: string]: ListOrgRolesSuccessResponseValue;
|
|
3362
2326
|
}, any, {}>>;
|
|
3363
|
-
/**
|
|
3364
|
-
* List the v2 role assignments for an org
|
|
3365
|
-
* @summary List Org Roles V2
|
|
3366
|
-
* @param {string} orgId
|
|
3367
|
-
* @param {*} [options] Override http request option.
|
|
3368
|
-
* @throws {RequiredError}
|
|
3369
|
-
* @memberof UserPermissionsApi
|
|
3370
|
-
*/
|
|
3371
|
-
listOrgRolesV2(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
3372
|
-
[key: string]: ListOrgRolesSuccessResponseValue;
|
|
3373
|
-
}, any, {}>>;
|
|
3374
2327
|
/**
|
|
3375
2328
|
* List the available permissions for the current user
|
|
3376
2329
|
* @summary List Own Permissions
|
|
@@ -3380,15 +2333,6 @@ export declare class UserPermissionsApi extends BaseAPI {
|
|
|
3380
2333
|
* @memberof UserPermissionsApi
|
|
3381
2334
|
*/
|
|
3382
2335
|
listOwnPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any, {}>>;
|
|
3383
|
-
/**
|
|
3384
|
-
* List the v2 materialized permissions for the current user
|
|
3385
|
-
* @summary List Own Permissions V2
|
|
3386
|
-
* @param {string} orgId
|
|
3387
|
-
* @param {*} [options] Override http request option.
|
|
3388
|
-
* @throws {RequiredError}
|
|
3389
|
-
* @memberof UserPermissionsApi
|
|
3390
|
-
*/
|
|
3391
|
-
listOwnPermissionsV2(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any, {}>>;
|
|
3392
2336
|
/**
|
|
3393
2337
|
* List the available permissions for a given user
|
|
3394
2338
|
* @summary List User Permissions
|
|
@@ -3399,14 +2343,4 @@ export declare class UserPermissionsApi extends BaseAPI {
|
|
|
3399
2343
|
* @memberof UserPermissionsApi
|
|
3400
2344
|
*/
|
|
3401
2345
|
listUserPermissions(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any, {}>>;
|
|
3402
|
-
/**
|
|
3403
|
-
* List the v2 materialized permissions for a given user
|
|
3404
|
-
* @summary List User Permissions V2
|
|
3405
|
-
* @param {string} orgId
|
|
3406
|
-
* @param {string} userId
|
|
3407
|
-
* @param {*} [options] Override http request option.
|
|
3408
|
-
* @throws {RequiredError}
|
|
3409
|
-
* @memberof UserPermissionsApi
|
|
3410
|
-
*/
|
|
3411
|
-
listUserPermissionsV2(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any, {}>>;
|
|
3412
2346
|
}
|