@flipdish/authorization 0.2.51 → 0.2.52
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/api.ts +1189 -159
- package/configuration.ts +1 -1
- package/dist/api.d.ts +787 -57
- package/dist/api.js +858 -133
- package/dist/configuration.js +1 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -13,6 +13,144 @@ 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
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface AcceptJoinRequest
|
|
20
|
+
*/
|
|
21
|
+
export interface AcceptJoinRequest {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof AcceptJoinRequest
|
|
26
|
+
*/
|
|
27
|
+
'roleName'?: AcceptJoinRequestRoleNameEnum;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {Array<GetJoinAccessRequest200ResponsePropertyIdsInner>}
|
|
31
|
+
* @memberof AcceptJoinRequest
|
|
32
|
+
*/
|
|
33
|
+
'propertyIds'?: Array<GetJoinAccessRequest200ResponsePropertyIdsInner>;
|
|
34
|
+
}
|
|
35
|
+
export declare const AcceptJoinRequestRoleNameEnum: {
|
|
36
|
+
readonly Owner: "Owner";
|
|
37
|
+
readonly PropertyOwner: "PropertyOwner";
|
|
38
|
+
readonly ManagedOwner: "ManagedOwner";
|
|
39
|
+
readonly Integrator: "Integrator";
|
|
40
|
+
readonly PropertyManager: "PropertyManager";
|
|
41
|
+
readonly FinanceManager: "FinanceManager";
|
|
42
|
+
readonly StaffMember: "StaffMember";
|
|
43
|
+
readonly Kiosk: "Kiosk";
|
|
44
|
+
readonly Terminal: "Terminal";
|
|
45
|
+
};
|
|
46
|
+
export type AcceptJoinRequestRoleNameEnum = typeof AcceptJoinRequestRoleNameEnum[keyof typeof AcceptJoinRequestRoleNameEnum];
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @export
|
|
50
|
+
* @interface AccessBlockStateResponse
|
|
51
|
+
*/
|
|
52
|
+
export interface AccessBlockStateResponse {
|
|
53
|
+
/**
|
|
54
|
+
*
|
|
55
|
+
* @type {AccessBlockStateResponseBlockedPrincipal}
|
|
56
|
+
* @memberof AccessBlockStateResponse
|
|
57
|
+
*/
|
|
58
|
+
'principal': AccessBlockStateResponseBlockedPrincipal;
|
|
59
|
+
/**
|
|
60
|
+
*
|
|
61
|
+
* @type {string}
|
|
62
|
+
* @memberof AccessBlockStateResponse
|
|
63
|
+
*/
|
|
64
|
+
'reason'?: string;
|
|
65
|
+
/**
|
|
66
|
+
*
|
|
67
|
+
* @type {string}
|
|
68
|
+
* @memberof AccessBlockStateResponse
|
|
69
|
+
*/
|
|
70
|
+
'blockedAt': string;
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
* @type {AccessBlockStateResponseBlockedBlockedBy}
|
|
74
|
+
* @memberof AccessBlockStateResponse
|
|
75
|
+
*/
|
|
76
|
+
'blockedBy': AccessBlockStateResponseBlockedBlockedBy;
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
*
|
|
80
|
+
* @export
|
|
81
|
+
* @interface AccessBlockStateResponseBlocked
|
|
82
|
+
*/
|
|
83
|
+
export interface AccessBlockStateResponseBlocked {
|
|
84
|
+
/**
|
|
85
|
+
*
|
|
86
|
+
* @type {AccessBlockStateResponseBlockedPrincipal}
|
|
87
|
+
* @memberof AccessBlockStateResponseBlocked
|
|
88
|
+
*/
|
|
89
|
+
'principal': AccessBlockStateResponseBlockedPrincipal;
|
|
90
|
+
/**
|
|
91
|
+
*
|
|
92
|
+
* @type {string}
|
|
93
|
+
* @memberof AccessBlockStateResponseBlocked
|
|
94
|
+
*/
|
|
95
|
+
'reason'?: string;
|
|
96
|
+
/**
|
|
97
|
+
*
|
|
98
|
+
* @type {string}
|
|
99
|
+
* @memberof AccessBlockStateResponseBlocked
|
|
100
|
+
*/
|
|
101
|
+
'blockedAt': string;
|
|
102
|
+
/**
|
|
103
|
+
*
|
|
104
|
+
* @type {AccessBlockStateResponseBlockedBlockedBy}
|
|
105
|
+
* @memberof AccessBlockStateResponseBlocked
|
|
106
|
+
*/
|
|
107
|
+
'blockedBy': AccessBlockStateResponseBlockedBlockedBy;
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
*
|
|
111
|
+
* @export
|
|
112
|
+
* @interface AccessBlockStateResponseBlockedBlockedBy
|
|
113
|
+
*/
|
|
114
|
+
export interface AccessBlockStateResponseBlockedBlockedBy {
|
|
115
|
+
/**
|
|
116
|
+
*
|
|
117
|
+
* @type {string}
|
|
118
|
+
* @memberof AccessBlockStateResponseBlockedBlockedBy
|
|
119
|
+
*/
|
|
120
|
+
'principalId': string;
|
|
121
|
+
/**
|
|
122
|
+
*
|
|
123
|
+
* @type {string}
|
|
124
|
+
* @memberof AccessBlockStateResponseBlockedBlockedBy
|
|
125
|
+
*/
|
|
126
|
+
'email': string;
|
|
127
|
+
}
|
|
128
|
+
/**
|
|
129
|
+
*
|
|
130
|
+
* @export
|
|
131
|
+
* @interface AccessBlockStateResponseBlockedPrincipal
|
|
132
|
+
*/
|
|
133
|
+
export interface AccessBlockStateResponseBlockedPrincipal {
|
|
134
|
+
/**
|
|
135
|
+
*
|
|
136
|
+
* @type {string}
|
|
137
|
+
* @memberof AccessBlockStateResponseBlockedPrincipal
|
|
138
|
+
*/
|
|
139
|
+
'type': AccessBlockStateResponseBlockedPrincipalTypeEnum;
|
|
140
|
+
/**
|
|
141
|
+
*
|
|
142
|
+
* @type {string}
|
|
143
|
+
* @memberof AccessBlockStateResponseBlockedPrincipal
|
|
144
|
+
*/
|
|
145
|
+
'id': string;
|
|
146
|
+
}
|
|
147
|
+
export declare const AccessBlockStateResponseBlockedPrincipalTypeEnum: {
|
|
148
|
+
readonly User: "User";
|
|
149
|
+
readonly Automation: "Automation";
|
|
150
|
+
readonly Kiosk: "Kiosk";
|
|
151
|
+
readonly Terminal: "Terminal";
|
|
152
|
+
};
|
|
153
|
+
export type AccessBlockStateResponseBlockedPrincipalTypeEnum = typeof AccessBlockStateResponseBlockedPrincipalTypeEnum[keyof typeof AccessBlockStateResponseBlockedPrincipalTypeEnum];
|
|
16
154
|
/**
|
|
17
155
|
*
|
|
18
156
|
* @export
|
|
@@ -43,6 +181,12 @@ export interface AccessRequestResponse {
|
|
|
43
181
|
* @memberof AccessRequestResponse
|
|
44
182
|
*/
|
|
45
183
|
'requesterEmail': string;
|
|
184
|
+
/**
|
|
185
|
+
*
|
|
186
|
+
* @type {string}
|
|
187
|
+
* @memberof AccessRequestResponse
|
|
188
|
+
*/
|
|
189
|
+
'requesterName'?: string;
|
|
46
190
|
/**
|
|
47
191
|
*
|
|
48
192
|
* @type {string}
|
|
@@ -57,10 +201,10 @@ export interface AccessRequestResponse {
|
|
|
57
201
|
'orgName': string;
|
|
58
202
|
/**
|
|
59
203
|
*
|
|
60
|
-
* @type {Array<
|
|
204
|
+
* @type {Array<GetJoinAccessRequest200ResponsePropertyIdsInner>}
|
|
61
205
|
* @memberof AccessRequestResponse
|
|
62
206
|
*/
|
|
63
|
-
'propertyIds': Array<
|
|
207
|
+
'propertyIds': Array<GetJoinAccessRequest200ResponsePropertyIdsInner>;
|
|
64
208
|
/**
|
|
65
209
|
*
|
|
66
210
|
* @type {Array<string>}
|
|
@@ -711,6 +855,25 @@ export interface AuthorizeBatchChecks400ResponseAnyOfInner {
|
|
|
711
855
|
*/
|
|
712
856
|
export interface AuthorizeBatchChecks400ResponseAnyOfInnerPathInner {
|
|
713
857
|
}
|
|
858
|
+
/**
|
|
859
|
+
*
|
|
860
|
+
* @export
|
|
861
|
+
* @interface BlockPrincipalAccessRequest
|
|
862
|
+
*/
|
|
863
|
+
export interface BlockPrincipalAccessRequest {
|
|
864
|
+
/**
|
|
865
|
+
*
|
|
866
|
+
* @type {AccessBlockStateResponseBlockedPrincipal}
|
|
867
|
+
* @memberof BlockPrincipalAccessRequest
|
|
868
|
+
*/
|
|
869
|
+
'principal': AccessBlockStateResponseBlockedPrincipal;
|
|
870
|
+
/**
|
|
871
|
+
*
|
|
872
|
+
* @type {string}
|
|
873
|
+
* @memberof BlockPrincipalAccessRequest
|
|
874
|
+
*/
|
|
875
|
+
'reason'?: string;
|
|
876
|
+
}
|
|
714
877
|
/**
|
|
715
878
|
*
|
|
716
879
|
* @export
|
|
@@ -1036,6 +1199,12 @@ export interface GetJoinAccessRequest200Response {
|
|
|
1036
1199
|
* @memberof GetJoinAccessRequest200Response
|
|
1037
1200
|
*/
|
|
1038
1201
|
'requesterEmail': string;
|
|
1202
|
+
/**
|
|
1203
|
+
*
|
|
1204
|
+
* @type {string}
|
|
1205
|
+
* @memberof GetJoinAccessRequest200Response
|
|
1206
|
+
*/
|
|
1207
|
+
'requesterName'?: string;
|
|
1039
1208
|
/**
|
|
1040
1209
|
*
|
|
1041
1210
|
* @type {string}
|
|
@@ -1050,10 +1219,10 @@ export interface GetJoinAccessRequest200Response {
|
|
|
1050
1219
|
'orgName': string;
|
|
1051
1220
|
/**
|
|
1052
1221
|
*
|
|
1053
|
-
* @type {Array<
|
|
1222
|
+
* @type {Array<GetJoinAccessRequest200ResponsePropertyIdsInner>}
|
|
1054
1223
|
* @memberof GetJoinAccessRequest200Response
|
|
1055
1224
|
*/
|
|
1056
|
-
'propertyIds': Array<
|
|
1225
|
+
'propertyIds': Array<GetJoinAccessRequest200ResponsePropertyIdsInner>;
|
|
1057
1226
|
/**
|
|
1058
1227
|
*
|
|
1059
1228
|
* @type {Array<string>}
|
|
@@ -1110,6 +1279,13 @@ export declare const GetJoinAccessRequest200ResponseRoleNameEnum: {
|
|
|
1110
1279
|
readonly Terminal: "Terminal";
|
|
1111
1280
|
};
|
|
1112
1281
|
export type GetJoinAccessRequest200ResponseRoleNameEnum = typeof GetJoinAccessRequest200ResponseRoleNameEnum[keyof typeof GetJoinAccessRequest200ResponseRoleNameEnum];
|
|
1282
|
+
/**
|
|
1283
|
+
*
|
|
1284
|
+
* @export
|
|
1285
|
+
* @interface GetJoinAccessRequest200ResponsePropertyIdsInner
|
|
1286
|
+
*/
|
|
1287
|
+
export interface GetJoinAccessRequest200ResponsePropertyIdsInner {
|
|
1288
|
+
}
|
|
1113
1289
|
/**
|
|
1114
1290
|
* Successful user permissions retrieval response
|
|
1115
1291
|
* @export
|
|
@@ -1619,10 +1795,10 @@ export interface ListOrgRolesSuccessResponseValue {
|
|
|
1619
1795
|
'optionalPermissionSetKeys'?: Array<string>;
|
|
1620
1796
|
/**
|
|
1621
1797
|
* Property IDs, or * for all properties, the roles are scoped to
|
|
1622
|
-
* @type {Array<
|
|
1798
|
+
* @type {Array<GetJoinAccessRequest200ResponsePropertyIdsInner>}
|
|
1623
1799
|
* @memberof ListOrgRolesSuccessResponseValue
|
|
1624
1800
|
*/
|
|
1625
|
-
'properties'?: Array<
|
|
1801
|
+
'properties'?: Array<GetJoinAccessRequest200ResponsePropertyIdsInner>;
|
|
1626
1802
|
/**
|
|
1627
1803
|
* Brand IDs, or * for all brands, the roles are scoped to
|
|
1628
1804
|
* @type {Array<ListOrgRolesSuccessResponseValueBrandsInner>}
|
|
@@ -1662,13 +1838,6 @@ export interface ListOrgRolesSuccessResponseValueBrandsInner {
|
|
|
1662
1838
|
*/
|
|
1663
1839
|
export interface ListOrgRolesSuccessResponseValueOrgId {
|
|
1664
1840
|
}
|
|
1665
|
-
/**
|
|
1666
|
-
*
|
|
1667
|
-
* @export
|
|
1668
|
-
* @interface ListOrgRolesSuccessResponseValuePropertiesInner
|
|
1669
|
-
*/
|
|
1670
|
-
export interface ListOrgRolesSuccessResponseValuePropertiesInner {
|
|
1671
|
-
}
|
|
1672
1841
|
/**
|
|
1673
1842
|
*
|
|
1674
1843
|
* @export
|
|
@@ -1689,6 +1858,19 @@ export interface ListPermissionsSuccessResponse {
|
|
|
1689
1858
|
*/
|
|
1690
1859
|
'permissions': Permissions & Array<Permissions>;
|
|
1691
1860
|
}
|
|
1861
|
+
/**
|
|
1862
|
+
*
|
|
1863
|
+
* @export
|
|
1864
|
+
* @interface ListPrincipalAccessBlocksResponse
|
|
1865
|
+
*/
|
|
1866
|
+
export interface ListPrincipalAccessBlocksResponse {
|
|
1867
|
+
/**
|
|
1868
|
+
*
|
|
1869
|
+
* @type {Array<AccessBlockStateResponse>}
|
|
1870
|
+
* @memberof ListPrincipalAccessBlocksResponse
|
|
1871
|
+
*/
|
|
1872
|
+
'items': Array<AccessBlockStateResponse>;
|
|
1873
|
+
}
|
|
1692
1874
|
/**
|
|
1693
1875
|
* Successful roles retrieval response
|
|
1694
1876
|
* @export
|
|
@@ -1702,6 +1884,19 @@ export interface ListRolesSuccessResponse {
|
|
|
1702
1884
|
*/
|
|
1703
1885
|
'roles': Array<RoleNames>;
|
|
1704
1886
|
}
|
|
1887
|
+
/**
|
|
1888
|
+
* The caller\'s active timed access grants
|
|
1889
|
+
* @export
|
|
1890
|
+
* @interface ListTimedAccessGrantsResponse
|
|
1891
|
+
*/
|
|
1892
|
+
export interface ListTimedAccessGrantsResponse {
|
|
1893
|
+
/**
|
|
1894
|
+
*
|
|
1895
|
+
* @type {Array<TimedAccessGrant>}
|
|
1896
|
+
* @memberof ListTimedAccessGrantsResponse
|
|
1897
|
+
*/
|
|
1898
|
+
'grants': Array<TimedAccessGrant>;
|
|
1899
|
+
}
|
|
1705
1900
|
/**
|
|
1706
1901
|
* Permissions
|
|
1707
1902
|
* @export
|
|
@@ -1771,6 +1966,7 @@ export declare const Permissions: {
|
|
|
1771
1966
|
readonly ViewMenu: "ViewMenu";
|
|
1772
1967
|
readonly CreateGlobalApiKey: "CreateGlobalAPIKey";
|
|
1773
1968
|
readonly ListGlobalApiKeys: "ListGlobalAPIKeys";
|
|
1969
|
+
readonly BlockPrincipalAccess: "BlockPrincipalAccess";
|
|
1774
1970
|
readonly CreateMenu: "CreateMenu";
|
|
1775
1971
|
readonly UpdateMenu: "UpdateMenu";
|
|
1776
1972
|
readonly DeleteMenu: "DeleteMenu";
|
|
@@ -2035,7 +2231,7 @@ export interface RematerializeRoleAssignmentRequestBody {
|
|
|
2035
2231
|
'sk': string;
|
|
2036
2232
|
}
|
|
2037
2233
|
/**
|
|
2038
|
-
* Successful role assignment rematerialization response
|
|
2234
|
+
* Successful role assignment rematerialization response (reconcile: add missing + revoke leftovers)
|
|
2039
2235
|
* @export
|
|
2040
2236
|
* @interface RematerializeRoleAssignmentSuccessResponse
|
|
2041
2237
|
*/
|
|
@@ -2051,44 +2247,19 @@ export interface RematerializeRoleAssignmentSuccessResponse {
|
|
|
2051
2247
|
* @type {number}
|
|
2052
2248
|
* @memberof RematerializeRoleAssignmentSuccessResponse
|
|
2053
2249
|
*/
|
|
2054
|
-
'
|
|
2250
|
+
'added': number;
|
|
2055
2251
|
/**
|
|
2056
2252
|
*
|
|
2057
2253
|
* @type {number}
|
|
2058
2254
|
* @memberof RematerializeRoleAssignmentSuccessResponse
|
|
2059
2255
|
*/
|
|
2060
|
-
'
|
|
2256
|
+
'revoked': number;
|
|
2061
2257
|
/**
|
|
2062
2258
|
*
|
|
2063
|
-
* @type {
|
|
2259
|
+
* @type {number}
|
|
2064
2260
|
* @memberof RematerializeRoleAssignmentSuccessResponse
|
|
2065
2261
|
*/
|
|
2066
|
-
'
|
|
2067
|
-
}
|
|
2068
|
-
/**
|
|
2069
|
-
*
|
|
2070
|
-
* @export
|
|
2071
|
-
* @interface RematerializeRoleAssignmentSuccessResponsePolicyAssignmentsInner
|
|
2072
|
-
*/
|
|
2073
|
-
export interface RematerializeRoleAssignmentSuccessResponsePolicyAssignmentsInner {
|
|
2074
|
-
/**
|
|
2075
|
-
*
|
|
2076
|
-
* @type {string}
|
|
2077
|
-
* @memberof RematerializeRoleAssignmentSuccessResponsePolicyAssignmentsInner
|
|
2078
|
-
*/
|
|
2079
|
-
'policyId': string;
|
|
2080
|
-
/**
|
|
2081
|
-
*
|
|
2082
|
-
* @type {string}
|
|
2083
|
-
* @memberof RematerializeRoleAssignmentSuccessResponsePolicyAssignmentsInner
|
|
2084
|
-
*/
|
|
2085
|
-
'assignmentPk': string;
|
|
2086
|
-
/**
|
|
2087
|
-
*
|
|
2088
|
-
* @type {string}
|
|
2089
|
-
* @memberof RematerializeRoleAssignmentSuccessResponsePolicyAssignmentsInner
|
|
2090
|
-
*/
|
|
2091
|
-
'assignmentSk': string;
|
|
2262
|
+
'unchanged': number;
|
|
2092
2263
|
}
|
|
2093
2264
|
/**
|
|
2094
2265
|
*
|
|
@@ -2255,10 +2426,10 @@ export interface RoleAssignmentRequestBody {
|
|
|
2255
2426
|
'roleName': RoleAssignmentRequestBodyRoleNameEnum;
|
|
2256
2427
|
/**
|
|
2257
2428
|
* Property resource ids (e.g. p123) when scoped to properties
|
|
2258
|
-
* @type {Array<
|
|
2429
|
+
* @type {Array<GetJoinAccessRequest200ResponsePropertyIdsInner>}
|
|
2259
2430
|
* @memberof RoleAssignmentRequestBody
|
|
2260
2431
|
*/
|
|
2261
|
-
'properties'?: Array<
|
|
2432
|
+
'properties'?: Array<GetJoinAccessRequest200ResponsePropertyIdsInner>;
|
|
2262
2433
|
/**
|
|
2263
2434
|
* Brand resource ids (e.g. b123) when scoped to brands
|
|
2264
2435
|
* @type {Array<ListOrgRolesSuccessResponseValueBrandsInner>}
|
|
@@ -2409,6 +2580,272 @@ export declare const RoleNames: {
|
|
|
2409
2580
|
readonly FlipdishStaff: "FlipdishStaff";
|
|
2410
2581
|
};
|
|
2411
2582
|
export type RoleNames = typeof RoleNames[keyof typeof RoleNames];
|
|
2583
|
+
/**
|
|
2584
|
+
* A temporary timed access grant
|
|
2585
|
+
* @export
|
|
2586
|
+
* @interface TimedAccessGrant
|
|
2587
|
+
*/
|
|
2588
|
+
export interface TimedAccessGrant {
|
|
2589
|
+
/**
|
|
2590
|
+
*
|
|
2591
|
+
* @type {string}
|
|
2592
|
+
* @memberof TimedAccessGrant
|
|
2593
|
+
*/
|
|
2594
|
+
'grantId': string;
|
|
2595
|
+
/**
|
|
2596
|
+
*
|
|
2597
|
+
* @type {string}
|
|
2598
|
+
* @memberof TimedAccessGrant
|
|
2599
|
+
*/
|
|
2600
|
+
'principalType': TimedAccessGrantPrincipalTypeEnum;
|
|
2601
|
+
/**
|
|
2602
|
+
*
|
|
2603
|
+
* @type {string}
|
|
2604
|
+
* @memberof TimedAccessGrant
|
|
2605
|
+
*/
|
|
2606
|
+
'principalId': string;
|
|
2607
|
+
/**
|
|
2608
|
+
*
|
|
2609
|
+
* @type {string}
|
|
2610
|
+
* @memberof TimedAccessGrant
|
|
2611
|
+
*/
|
|
2612
|
+
'email': string;
|
|
2613
|
+
/**
|
|
2614
|
+
*
|
|
2615
|
+
* @type {string}
|
|
2616
|
+
* @memberof TimedAccessGrant
|
|
2617
|
+
*/
|
|
2618
|
+
'orgId': string;
|
|
2619
|
+
/**
|
|
2620
|
+
*
|
|
2621
|
+
* @type {string}
|
|
2622
|
+
* @memberof TimedAccessGrant
|
|
2623
|
+
*/
|
|
2624
|
+
'roleName': string;
|
|
2625
|
+
/**
|
|
2626
|
+
*
|
|
2627
|
+
* @type {Array<string>}
|
|
2628
|
+
* @memberof TimedAccessGrant
|
|
2629
|
+
*/
|
|
2630
|
+
'propertyIds': Array<string>;
|
|
2631
|
+
/**
|
|
2632
|
+
*
|
|
2633
|
+
* @type {Array<string>}
|
|
2634
|
+
* @memberof TimedAccessGrant
|
|
2635
|
+
*/
|
|
2636
|
+
'brandIds': Array<string>;
|
|
2637
|
+
/**
|
|
2638
|
+
*
|
|
2639
|
+
* @type {Array<string>}
|
|
2640
|
+
* @memberof TimedAccessGrant
|
|
2641
|
+
*/
|
|
2642
|
+
'salesChannelIds': Array<string>;
|
|
2643
|
+
/**
|
|
2644
|
+
*
|
|
2645
|
+
* @type {string}
|
|
2646
|
+
* @memberof TimedAccessGrant
|
|
2647
|
+
*/
|
|
2648
|
+
'startsAt': string;
|
|
2649
|
+
/**
|
|
2650
|
+
*
|
|
2651
|
+
* @type {string}
|
|
2652
|
+
* @memberof TimedAccessGrant
|
|
2653
|
+
*/
|
|
2654
|
+
'expiresAt': string;
|
|
2655
|
+
/**
|
|
2656
|
+
*
|
|
2657
|
+
* @type {string}
|
|
2658
|
+
* @memberof TimedAccessGrant
|
|
2659
|
+
*/
|
|
2660
|
+
'status': TimedAccessGrantStatusEnum;
|
|
2661
|
+
}
|
|
2662
|
+
export declare const TimedAccessGrantPrincipalTypeEnum: {
|
|
2663
|
+
readonly User: "User";
|
|
2664
|
+
readonly Automation: "Automation";
|
|
2665
|
+
readonly Kiosk: "Kiosk";
|
|
2666
|
+
readonly Terminal: "Terminal";
|
|
2667
|
+
};
|
|
2668
|
+
export type TimedAccessGrantPrincipalTypeEnum = typeof TimedAccessGrantPrincipalTypeEnum[keyof typeof TimedAccessGrantPrincipalTypeEnum];
|
|
2669
|
+
export declare const TimedAccessGrantStatusEnum: {
|
|
2670
|
+
readonly Active: "active";
|
|
2671
|
+
readonly Expired: "expired";
|
|
2672
|
+
};
|
|
2673
|
+
export type TimedAccessGrantStatusEnum = typeof TimedAccessGrantStatusEnum[keyof typeof TimedAccessGrantStatusEnum];
|
|
2674
|
+
/**
|
|
2675
|
+
*
|
|
2676
|
+
* @export
|
|
2677
|
+
* @interface TimedAccessGrantRequestBody
|
|
2678
|
+
*/
|
|
2679
|
+
export interface TimedAccessGrantRequestBody {
|
|
2680
|
+
/**
|
|
2681
|
+
* Must match the authenticated caller
|
|
2682
|
+
* @type {string}
|
|
2683
|
+
* @memberof TimedAccessGrantRequestBody
|
|
2684
|
+
*/
|
|
2685
|
+
'userId': string;
|
|
2686
|
+
/**
|
|
2687
|
+
* The org to grant temporary access to
|
|
2688
|
+
* @type {string}
|
|
2689
|
+
* @memberof TimedAccessGrantRequestBody
|
|
2690
|
+
*/
|
|
2691
|
+
'orgId': string;
|
|
2692
|
+
/**
|
|
2693
|
+
* Role the pass grants
|
|
2694
|
+
* @type {string}
|
|
2695
|
+
* @memberof TimedAccessGrantRequestBody
|
|
2696
|
+
*/
|
|
2697
|
+
'roleName': TimedAccessGrantRequestBodyRoleNameEnum;
|
|
2698
|
+
/**
|
|
2699
|
+
* Optional property scope
|
|
2700
|
+
* @type {Array<string>}
|
|
2701
|
+
* @memberof TimedAccessGrantRequestBody
|
|
2702
|
+
*/
|
|
2703
|
+
'propertyIds'?: Array<string>;
|
|
2704
|
+
/**
|
|
2705
|
+
* Optional brand scope
|
|
2706
|
+
* @type {Array<string>}
|
|
2707
|
+
* @memberof TimedAccessGrantRequestBody
|
|
2708
|
+
*/
|
|
2709
|
+
'brandIds'?: Array<string>;
|
|
2710
|
+
/**
|
|
2711
|
+
* Optional sales channel scope
|
|
2712
|
+
* @type {Array<string>}
|
|
2713
|
+
* @memberof TimedAccessGrantRequestBody
|
|
2714
|
+
*/
|
|
2715
|
+
'salesChannelIds'?: Array<string>;
|
|
2716
|
+
}
|
|
2717
|
+
export declare const TimedAccessGrantRequestBodyRoleNameEnum: {
|
|
2718
|
+
readonly Owner: "Owner";
|
|
2719
|
+
};
|
|
2720
|
+
export type TimedAccessGrantRequestBodyRoleNameEnum = typeof TimedAccessGrantRequestBodyRoleNameEnum[keyof typeof TimedAccessGrantRequestBodyRoleNameEnum];
|
|
2721
|
+
/**
|
|
2722
|
+
* The timed access grant that was created or refreshed
|
|
2723
|
+
* @export
|
|
2724
|
+
* @interface TimedAccessGrantResponse
|
|
2725
|
+
*/
|
|
2726
|
+
export interface TimedAccessGrantResponse {
|
|
2727
|
+
/**
|
|
2728
|
+
*
|
|
2729
|
+
* @type {string}
|
|
2730
|
+
* @memberof TimedAccessGrantResponse
|
|
2731
|
+
*/
|
|
2732
|
+
'grantId': string;
|
|
2733
|
+
/**
|
|
2734
|
+
*
|
|
2735
|
+
* @type {string}
|
|
2736
|
+
* @memberof TimedAccessGrantResponse
|
|
2737
|
+
*/
|
|
2738
|
+
'principalType': TimedAccessGrantResponsePrincipalTypeEnum;
|
|
2739
|
+
/**
|
|
2740
|
+
*
|
|
2741
|
+
* @type {string}
|
|
2742
|
+
* @memberof TimedAccessGrantResponse
|
|
2743
|
+
*/
|
|
2744
|
+
'principalId': string;
|
|
2745
|
+
/**
|
|
2746
|
+
*
|
|
2747
|
+
* @type {string}
|
|
2748
|
+
* @memberof TimedAccessGrantResponse
|
|
2749
|
+
*/
|
|
2750
|
+
'email': string;
|
|
2751
|
+
/**
|
|
2752
|
+
*
|
|
2753
|
+
* @type {string}
|
|
2754
|
+
* @memberof TimedAccessGrantResponse
|
|
2755
|
+
*/
|
|
2756
|
+
'orgId': string;
|
|
2757
|
+
/**
|
|
2758
|
+
*
|
|
2759
|
+
* @type {string}
|
|
2760
|
+
* @memberof TimedAccessGrantResponse
|
|
2761
|
+
*/
|
|
2762
|
+
'roleName': string;
|
|
2763
|
+
/**
|
|
2764
|
+
*
|
|
2765
|
+
* @type {Array<string>}
|
|
2766
|
+
* @memberof TimedAccessGrantResponse
|
|
2767
|
+
*/
|
|
2768
|
+
'propertyIds': Array<string>;
|
|
2769
|
+
/**
|
|
2770
|
+
*
|
|
2771
|
+
* @type {Array<string>}
|
|
2772
|
+
* @memberof TimedAccessGrantResponse
|
|
2773
|
+
*/
|
|
2774
|
+
'brandIds': Array<string>;
|
|
2775
|
+
/**
|
|
2776
|
+
*
|
|
2777
|
+
* @type {Array<string>}
|
|
2778
|
+
* @memberof TimedAccessGrantResponse
|
|
2779
|
+
*/
|
|
2780
|
+
'salesChannelIds': Array<string>;
|
|
2781
|
+
/**
|
|
2782
|
+
*
|
|
2783
|
+
* @type {string}
|
|
2784
|
+
* @memberof TimedAccessGrantResponse
|
|
2785
|
+
*/
|
|
2786
|
+
'startsAt': string;
|
|
2787
|
+
/**
|
|
2788
|
+
*
|
|
2789
|
+
* @type {string}
|
|
2790
|
+
* @memberof TimedAccessGrantResponse
|
|
2791
|
+
*/
|
|
2792
|
+
'expiresAt': string;
|
|
2793
|
+
/**
|
|
2794
|
+
*
|
|
2795
|
+
* @type {string}
|
|
2796
|
+
* @memberof TimedAccessGrantResponse
|
|
2797
|
+
*/
|
|
2798
|
+
'status': TimedAccessGrantResponseStatusEnum;
|
|
2799
|
+
}
|
|
2800
|
+
export declare const TimedAccessGrantResponsePrincipalTypeEnum: {
|
|
2801
|
+
readonly User: "User";
|
|
2802
|
+
readonly Automation: "Automation";
|
|
2803
|
+
readonly Kiosk: "Kiosk";
|
|
2804
|
+
readonly Terminal: "Terminal";
|
|
2805
|
+
};
|
|
2806
|
+
export type TimedAccessGrantResponsePrincipalTypeEnum = typeof TimedAccessGrantResponsePrincipalTypeEnum[keyof typeof TimedAccessGrantResponsePrincipalTypeEnum];
|
|
2807
|
+
export declare const TimedAccessGrantResponseStatusEnum: {
|
|
2808
|
+
readonly Active: "active";
|
|
2809
|
+
readonly Expired: "expired";
|
|
2810
|
+
};
|
|
2811
|
+
export type TimedAccessGrantResponseStatusEnum = typeof TimedAccessGrantResponseStatusEnum[keyof typeof TimedAccessGrantResponseStatusEnum];
|
|
2812
|
+
/**
|
|
2813
|
+
*
|
|
2814
|
+
* @export
|
|
2815
|
+
* @interface UnblockPrincipalAccessRequest
|
|
2816
|
+
*/
|
|
2817
|
+
export interface UnblockPrincipalAccessRequest {
|
|
2818
|
+
/**
|
|
2819
|
+
*
|
|
2820
|
+
* @type {AccessBlockStateResponseBlockedPrincipal}
|
|
2821
|
+
* @memberof UnblockPrincipalAccessRequest
|
|
2822
|
+
*/
|
|
2823
|
+
'principal': AccessBlockStateResponseBlockedPrincipal;
|
|
2824
|
+
}
|
|
2825
|
+
/**
|
|
2826
|
+
*
|
|
2827
|
+
* @export
|
|
2828
|
+
* @interface UnblockPrincipalAccessResponse
|
|
2829
|
+
*/
|
|
2830
|
+
export interface UnblockPrincipalAccessResponse {
|
|
2831
|
+
/**
|
|
2832
|
+
*
|
|
2833
|
+
* @type {AccessBlockStateResponseBlockedPrincipal}
|
|
2834
|
+
* @memberof UnblockPrincipalAccessResponse
|
|
2835
|
+
*/
|
|
2836
|
+
'principal': AccessBlockStateResponseBlockedPrincipal;
|
|
2837
|
+
/**
|
|
2838
|
+
*
|
|
2839
|
+
* @type {string}
|
|
2840
|
+
* @memberof UnblockPrincipalAccessResponse
|
|
2841
|
+
*/
|
|
2842
|
+
'status': UnblockPrincipalAccessResponseStatusEnum;
|
|
2843
|
+
}
|
|
2844
|
+
export declare const UnblockPrincipalAccessResponseStatusEnum: {
|
|
2845
|
+
readonly RestorationInProgress: "restoration_in_progress";
|
|
2846
|
+
readonly NotBlocked: "not_blocked";
|
|
2847
|
+
};
|
|
2848
|
+
export type UnblockPrincipalAccessResponseStatusEnum = typeof UnblockPrincipalAccessResponseStatusEnum[keyof typeof UnblockPrincipalAccessResponseStatusEnum];
|
|
2412
2849
|
/**
|
|
2413
2850
|
*
|
|
2414
2851
|
* @export
|
|
@@ -3151,14 +3588,15 @@ export declare class ConfigurationDataApi extends BaseAPI {
|
|
|
3151
3588
|
*/
|
|
3152
3589
|
export declare const JoinAccessApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3153
3590
|
/**
|
|
3154
|
-
* Grants
|
|
3591
|
+
* Grants access via AuthZ V2 role assignment (source join). Optional body fields override the role and property scope stored on the pending request; omitted fields use the request defaults from the invite token.
|
|
3155
3592
|
* @summary Accept a pending join access request
|
|
3156
3593
|
* @param {string} orgId
|
|
3157
3594
|
* @param {string} requestId
|
|
3595
|
+
* @param {AcceptJoinRequest} [acceptJoinRequest]
|
|
3158
3596
|
* @param {*} [options] Override http request option.
|
|
3159
3597
|
* @throws {RequiredError}
|
|
3160
3598
|
*/
|
|
3161
|
-
acceptJoinAccessRequest: (orgId: string, requestId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3599
|
+
acceptJoinAccessRequest: (orgId: string, requestId: string, acceptJoinRequest?: AcceptJoinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3162
3600
|
/**
|
|
3163
3601
|
* Mints an opaque invite token after validating the RMS terminal passport. Call again when a previous token expires to get a new one.
|
|
3164
3602
|
* @summary Create an invite token
|
|
@@ -3212,14 +3650,15 @@ export declare const JoinAccessApiAxiosParamCreator: (configuration?: Configurat
|
|
|
3212
3650
|
*/
|
|
3213
3651
|
export declare const JoinAccessApiFp: (configuration?: Configuration) => {
|
|
3214
3652
|
/**
|
|
3215
|
-
* Grants
|
|
3653
|
+
* Grants access via AuthZ V2 role assignment (source join). Optional body fields override the role and property scope stored on the pending request; omitted fields use the request defaults from the invite token.
|
|
3216
3654
|
* @summary Accept a pending join access request
|
|
3217
3655
|
* @param {string} orgId
|
|
3218
3656
|
* @param {string} requestId
|
|
3657
|
+
* @param {AcceptJoinRequest} [acceptJoinRequest]
|
|
3219
3658
|
* @param {*} [options] Override http request option.
|
|
3220
3659
|
* @throws {RequiredError}
|
|
3221
3660
|
*/
|
|
3222
|
-
acceptJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetJoinAccessRequest200Response>>;
|
|
3661
|
+
acceptJoinAccessRequest(orgId: string, requestId: string, acceptJoinRequest?: AcceptJoinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetJoinAccessRequest200Response>>;
|
|
3223
3662
|
/**
|
|
3224
3663
|
* Mints an opaque invite token after validating the RMS terminal passport. Call again when a previous token expires to get a new one.
|
|
3225
3664
|
* @summary Create an invite token
|
|
@@ -3273,14 +3712,15 @@ export declare const JoinAccessApiFp: (configuration?: Configuration) => {
|
|
|
3273
3712
|
*/
|
|
3274
3713
|
export declare const JoinAccessApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3275
3714
|
/**
|
|
3276
|
-
* Grants
|
|
3715
|
+
* Grants access via AuthZ V2 role assignment (source join). Optional body fields override the role and property scope stored on the pending request; omitted fields use the request defaults from the invite token.
|
|
3277
3716
|
* @summary Accept a pending join access request
|
|
3278
3717
|
* @param {string} orgId
|
|
3279
3718
|
* @param {string} requestId
|
|
3719
|
+
* @param {AcceptJoinRequest} [acceptJoinRequest]
|
|
3280
3720
|
* @param {*} [options] Override http request option.
|
|
3281
3721
|
* @throws {RequiredError}
|
|
3282
3722
|
*/
|
|
3283
|
-
acceptJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetJoinAccessRequest200Response>;
|
|
3723
|
+
acceptJoinAccessRequest(orgId: string, requestId: string, acceptJoinRequest?: AcceptJoinRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetJoinAccessRequest200Response>;
|
|
3284
3724
|
/**
|
|
3285
3725
|
* Mints an opaque invite token after validating the RMS terminal passport. Call again when a previous token expires to get a new one.
|
|
3286
3726
|
* @summary Create an invite token
|
|
@@ -3336,15 +3776,16 @@ export declare const JoinAccessApiFactory: (configuration?: Configuration, baseP
|
|
|
3336
3776
|
*/
|
|
3337
3777
|
export declare class JoinAccessApi extends BaseAPI {
|
|
3338
3778
|
/**
|
|
3339
|
-
* Grants
|
|
3779
|
+
* Grants access via AuthZ V2 role assignment (source join). Optional body fields override the role and property scope stored on the pending request; omitted fields use the request defaults from the invite token.
|
|
3340
3780
|
* @summary Accept a pending join access request
|
|
3341
3781
|
* @param {string} orgId
|
|
3342
3782
|
* @param {string} requestId
|
|
3783
|
+
* @param {AcceptJoinRequest} [acceptJoinRequest]
|
|
3343
3784
|
* @param {*} [options] Override http request option.
|
|
3344
3785
|
* @throws {RequiredError}
|
|
3345
3786
|
* @memberof JoinAccessApi
|
|
3346
3787
|
*/
|
|
3347
|
-
acceptJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetJoinAccessRequest200Response, any, {}, any>>;
|
|
3788
|
+
acceptJoinAccessRequest(orgId: string, requestId: string, acceptJoinRequest?: AcceptJoinRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetJoinAccessRequest200Response, any, {}, any>>;
|
|
3348
3789
|
/**
|
|
3349
3790
|
* Mints an opaque invite token after validating the RMS terminal passport. Call again when a previous token expires to get a new one.
|
|
3350
3791
|
* @summary Create an invite token
|
|
@@ -3397,6 +3838,188 @@ export declare class JoinAccessApi extends BaseAPI {
|
|
|
3397
3838
|
*/
|
|
3398
3839
|
rejectJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetJoinAccessRequest200Response, any, {}, any>>;
|
|
3399
3840
|
}
|
|
3841
|
+
/**
|
|
3842
|
+
* PrincipalAccessBlockApi - axios parameter creator
|
|
3843
|
+
* @export
|
|
3844
|
+
*/
|
|
3845
|
+
export declare const PrincipalAccessBlockApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3846
|
+
/**
|
|
3847
|
+
* Write an access_block flag and a temporary AVP forbid so authorization checks DENY. Decision-cache bust is delayed like other grant changes. Grant drain/restore runs asynchronously. Authentication still succeeds. Requires BlockPrincipalAccess.
|
|
3848
|
+
* @summary Block principal access
|
|
3849
|
+
* @param {BlockPrincipalAccessRequest} [blockPrincipalAccessRequest]
|
|
3850
|
+
* @param {*} [options] Override http request option.
|
|
3851
|
+
* @throws {RequiredError}
|
|
3852
|
+
*/
|
|
3853
|
+
blockPrincipalAccess: (blockPrincipalAccessRequest?: BlockPrincipalAccessRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3854
|
+
/**
|
|
3855
|
+
* Get the current access block for a principal. Requires BlockPrincipalAccess.
|
|
3856
|
+
* @summary Get principal access block
|
|
3857
|
+
* @param {GetPrincipalAccessBlockTypeEnum} type
|
|
3858
|
+
* @param {string} id
|
|
3859
|
+
* @param {*} [options] Override http request option.
|
|
3860
|
+
* @throws {RequiredError}
|
|
3861
|
+
*/
|
|
3862
|
+
getPrincipalAccessBlock: (type: GetPrincipalAccessBlockTypeEnum, id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3863
|
+
/**
|
|
3864
|
+
* List currently blocked principals. Optional type filter. Requires BlockPrincipalAccess.
|
|
3865
|
+
* @summary List principal access blocks
|
|
3866
|
+
* @param {ListPrincipalAccessBlocksTypeEnum} [type]
|
|
3867
|
+
* @param {*} [options] Override http request option.
|
|
3868
|
+
* @throws {RequiredError}
|
|
3869
|
+
*/
|
|
3870
|
+
listPrincipalAccessBlocks: (type?: ListPrincipalAccessBlocksTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3871
|
+
/**
|
|
3872
|
+
* Start restoring existing role assignments. The access_block flag is removed asynchronously after restoration completes, and authorization remains denied until then. Requires BlockPrincipalAccess.
|
|
3873
|
+
* @summary Unblock principal access
|
|
3874
|
+
* @param {UnblockPrincipalAccessRequest} [unblockPrincipalAccessRequest]
|
|
3875
|
+
* @param {*} [options] Override http request option.
|
|
3876
|
+
* @throws {RequiredError}
|
|
3877
|
+
*/
|
|
3878
|
+
unblockPrincipalAccess: (unblockPrincipalAccessRequest?: UnblockPrincipalAccessRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3879
|
+
};
|
|
3880
|
+
/**
|
|
3881
|
+
* PrincipalAccessBlockApi - functional programming interface
|
|
3882
|
+
* @export
|
|
3883
|
+
*/
|
|
3884
|
+
export declare const PrincipalAccessBlockApiFp: (configuration?: Configuration) => {
|
|
3885
|
+
/**
|
|
3886
|
+
* Write an access_block flag and a temporary AVP forbid so authorization checks DENY. Decision-cache bust is delayed like other grant changes. Grant drain/restore runs asynchronously. Authentication still succeeds. Requires BlockPrincipalAccess.
|
|
3887
|
+
* @summary Block principal access
|
|
3888
|
+
* @param {BlockPrincipalAccessRequest} [blockPrincipalAccessRequest]
|
|
3889
|
+
* @param {*} [options] Override http request option.
|
|
3890
|
+
* @throws {RequiredError}
|
|
3891
|
+
*/
|
|
3892
|
+
blockPrincipalAccess(blockPrincipalAccessRequest?: BlockPrincipalAccessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessBlockStateResponseBlocked>>;
|
|
3893
|
+
/**
|
|
3894
|
+
* Get the current access block for a principal. Requires BlockPrincipalAccess.
|
|
3895
|
+
* @summary Get principal access block
|
|
3896
|
+
* @param {GetPrincipalAccessBlockTypeEnum} type
|
|
3897
|
+
* @param {string} id
|
|
3898
|
+
* @param {*} [options] Override http request option.
|
|
3899
|
+
* @throws {RequiredError}
|
|
3900
|
+
*/
|
|
3901
|
+
getPrincipalAccessBlock(type: GetPrincipalAccessBlockTypeEnum, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessBlockStateResponse>>;
|
|
3902
|
+
/**
|
|
3903
|
+
* List currently blocked principals. Optional type filter. Requires BlockPrincipalAccess.
|
|
3904
|
+
* @summary List principal access blocks
|
|
3905
|
+
* @param {ListPrincipalAccessBlocksTypeEnum} [type]
|
|
3906
|
+
* @param {*} [options] Override http request option.
|
|
3907
|
+
* @throws {RequiredError}
|
|
3908
|
+
*/
|
|
3909
|
+
listPrincipalAccessBlocks(type?: ListPrincipalAccessBlocksTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPrincipalAccessBlocksResponse>>;
|
|
3910
|
+
/**
|
|
3911
|
+
* Start restoring existing role assignments. The access_block flag is removed asynchronously after restoration completes, and authorization remains denied until then. Requires BlockPrincipalAccess.
|
|
3912
|
+
* @summary Unblock principal access
|
|
3913
|
+
* @param {UnblockPrincipalAccessRequest} [unblockPrincipalAccessRequest]
|
|
3914
|
+
* @param {*} [options] Override http request option.
|
|
3915
|
+
* @throws {RequiredError}
|
|
3916
|
+
*/
|
|
3917
|
+
unblockPrincipalAccess(unblockPrincipalAccessRequest?: UnblockPrincipalAccessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UnblockPrincipalAccessResponse>>;
|
|
3918
|
+
};
|
|
3919
|
+
/**
|
|
3920
|
+
* PrincipalAccessBlockApi - factory interface
|
|
3921
|
+
* @export
|
|
3922
|
+
*/
|
|
3923
|
+
export declare const PrincipalAccessBlockApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3924
|
+
/**
|
|
3925
|
+
* Write an access_block flag and a temporary AVP forbid so authorization checks DENY. Decision-cache bust is delayed like other grant changes. Grant drain/restore runs asynchronously. Authentication still succeeds. Requires BlockPrincipalAccess.
|
|
3926
|
+
* @summary Block principal access
|
|
3927
|
+
* @param {BlockPrincipalAccessRequest} [blockPrincipalAccessRequest]
|
|
3928
|
+
* @param {*} [options] Override http request option.
|
|
3929
|
+
* @throws {RequiredError}
|
|
3930
|
+
*/
|
|
3931
|
+
blockPrincipalAccess(blockPrincipalAccessRequest?: BlockPrincipalAccessRequest, options?: RawAxiosRequestConfig): AxiosPromise<AccessBlockStateResponseBlocked>;
|
|
3932
|
+
/**
|
|
3933
|
+
* Get the current access block for a principal. Requires BlockPrincipalAccess.
|
|
3934
|
+
* @summary Get principal access block
|
|
3935
|
+
* @param {GetPrincipalAccessBlockTypeEnum} type
|
|
3936
|
+
* @param {string} id
|
|
3937
|
+
* @param {*} [options] Override http request option.
|
|
3938
|
+
* @throws {RequiredError}
|
|
3939
|
+
*/
|
|
3940
|
+
getPrincipalAccessBlock(type: GetPrincipalAccessBlockTypeEnum, id: string, options?: RawAxiosRequestConfig): AxiosPromise<AccessBlockStateResponse>;
|
|
3941
|
+
/**
|
|
3942
|
+
* List currently blocked principals. Optional type filter. Requires BlockPrincipalAccess.
|
|
3943
|
+
* @summary List principal access blocks
|
|
3944
|
+
* @param {ListPrincipalAccessBlocksTypeEnum} [type]
|
|
3945
|
+
* @param {*} [options] Override http request option.
|
|
3946
|
+
* @throws {RequiredError}
|
|
3947
|
+
*/
|
|
3948
|
+
listPrincipalAccessBlocks(type?: ListPrincipalAccessBlocksTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise<ListPrincipalAccessBlocksResponse>;
|
|
3949
|
+
/**
|
|
3950
|
+
* Start restoring existing role assignments. The access_block flag is removed asynchronously after restoration completes, and authorization remains denied until then. Requires BlockPrincipalAccess.
|
|
3951
|
+
* @summary Unblock principal access
|
|
3952
|
+
* @param {UnblockPrincipalAccessRequest} [unblockPrincipalAccessRequest]
|
|
3953
|
+
* @param {*} [options] Override http request option.
|
|
3954
|
+
* @throws {RequiredError}
|
|
3955
|
+
*/
|
|
3956
|
+
unblockPrincipalAccess(unblockPrincipalAccessRequest?: UnblockPrincipalAccessRequest, options?: RawAxiosRequestConfig): AxiosPromise<UnblockPrincipalAccessResponse>;
|
|
3957
|
+
};
|
|
3958
|
+
/**
|
|
3959
|
+
* PrincipalAccessBlockApi - object-oriented interface
|
|
3960
|
+
* @export
|
|
3961
|
+
* @class PrincipalAccessBlockApi
|
|
3962
|
+
* @extends {BaseAPI}
|
|
3963
|
+
*/
|
|
3964
|
+
export declare class PrincipalAccessBlockApi extends BaseAPI {
|
|
3965
|
+
/**
|
|
3966
|
+
* Write an access_block flag and a temporary AVP forbid so authorization checks DENY. Decision-cache bust is delayed like other grant changes. Grant drain/restore runs asynchronously. Authentication still succeeds. Requires BlockPrincipalAccess.
|
|
3967
|
+
* @summary Block principal access
|
|
3968
|
+
* @param {BlockPrincipalAccessRequest} [blockPrincipalAccessRequest]
|
|
3969
|
+
* @param {*} [options] Override http request option.
|
|
3970
|
+
* @throws {RequiredError}
|
|
3971
|
+
* @memberof PrincipalAccessBlockApi
|
|
3972
|
+
*/
|
|
3973
|
+
blockPrincipalAccess(blockPrincipalAccessRequest?: BlockPrincipalAccessRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessBlockStateResponseBlocked, any, {}, any>>;
|
|
3974
|
+
/**
|
|
3975
|
+
* Get the current access block for a principal. Requires BlockPrincipalAccess.
|
|
3976
|
+
* @summary Get principal access block
|
|
3977
|
+
* @param {GetPrincipalAccessBlockTypeEnum} type
|
|
3978
|
+
* @param {string} id
|
|
3979
|
+
* @param {*} [options] Override http request option.
|
|
3980
|
+
* @throws {RequiredError}
|
|
3981
|
+
* @memberof PrincipalAccessBlockApi
|
|
3982
|
+
*/
|
|
3983
|
+
getPrincipalAccessBlock(type: GetPrincipalAccessBlockTypeEnum, id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessBlockStateResponse, any, {}, any>>;
|
|
3984
|
+
/**
|
|
3985
|
+
* List currently blocked principals. Optional type filter. Requires BlockPrincipalAccess.
|
|
3986
|
+
* @summary List principal access blocks
|
|
3987
|
+
* @param {ListPrincipalAccessBlocksTypeEnum} [type]
|
|
3988
|
+
* @param {*} [options] Override http request option.
|
|
3989
|
+
* @throws {RequiredError}
|
|
3990
|
+
* @memberof PrincipalAccessBlockApi
|
|
3991
|
+
*/
|
|
3992
|
+
listPrincipalAccessBlocks(type?: ListPrincipalAccessBlocksTypeEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPrincipalAccessBlocksResponse, any, {}, any>>;
|
|
3993
|
+
/**
|
|
3994
|
+
* Start restoring existing role assignments. The access_block flag is removed asynchronously after restoration completes, and authorization remains denied until then. Requires BlockPrincipalAccess.
|
|
3995
|
+
* @summary Unblock principal access
|
|
3996
|
+
* @param {UnblockPrincipalAccessRequest} [unblockPrincipalAccessRequest]
|
|
3997
|
+
* @param {*} [options] Override http request option.
|
|
3998
|
+
* @throws {RequiredError}
|
|
3999
|
+
* @memberof PrincipalAccessBlockApi
|
|
4000
|
+
*/
|
|
4001
|
+
unblockPrincipalAccess(unblockPrincipalAccessRequest?: UnblockPrincipalAccessRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UnblockPrincipalAccessResponse, any, {}, any>>;
|
|
4002
|
+
}
|
|
4003
|
+
/**
|
|
4004
|
+
* @export
|
|
4005
|
+
*/
|
|
4006
|
+
export declare const GetPrincipalAccessBlockTypeEnum: {
|
|
4007
|
+
readonly User: "User";
|
|
4008
|
+
readonly Automation: "Automation";
|
|
4009
|
+
readonly Kiosk: "Kiosk";
|
|
4010
|
+
readonly Terminal: "Terminal";
|
|
4011
|
+
};
|
|
4012
|
+
export type GetPrincipalAccessBlockTypeEnum = typeof GetPrincipalAccessBlockTypeEnum[keyof typeof GetPrincipalAccessBlockTypeEnum];
|
|
4013
|
+
/**
|
|
4014
|
+
* @export
|
|
4015
|
+
*/
|
|
4016
|
+
export declare const ListPrincipalAccessBlocksTypeEnum: {
|
|
4017
|
+
readonly User: "User";
|
|
4018
|
+
readonly Automation: "Automation";
|
|
4019
|
+
readonly Kiosk: "Kiosk";
|
|
4020
|
+
readonly Terminal: "Terminal";
|
|
4021
|
+
};
|
|
4022
|
+
export type ListPrincipalAccessBlocksTypeEnum = typeof ListPrincipalAccessBlocksTypeEnum[keyof typeof ListPrincipalAccessBlocksTypeEnum];
|
|
3400
4023
|
/**
|
|
3401
4024
|
* RoleAssignmentApi - axios parameter creator
|
|
3402
4025
|
* @export
|
|
@@ -3412,7 +4035,7 @@ export declare const RoleAssignmentApiAxiosParamCreator: (configuration?: Config
|
|
|
3412
4035
|
*/
|
|
3413
4036
|
applyRoleAssignment: (orgId: string, roleAssignmentRequestBody?: RoleAssignmentRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3414
4037
|
/**
|
|
3415
|
-
*
|
|
4038
|
+
* Reconciles policy assignments for the role assignment principal: creates missing policies and revokes leftovers that materialize no longer emits
|
|
3416
4039
|
* @summary Rematerialize Role Assignment
|
|
3417
4040
|
* @param {string} orgId
|
|
3418
4041
|
* @param {RematerializeRoleAssignmentRequestBody} [rematerializeRoleAssignmentRequestBody]
|
|
@@ -3445,7 +4068,7 @@ export declare const RoleAssignmentApiFp: (configuration?: Configuration) => {
|
|
|
3445
4068
|
*/
|
|
3446
4069
|
applyRoleAssignment(orgId: string, roleAssignmentRequestBody?: RoleAssignmentRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RoleAssignmentSuccessResponse>>;
|
|
3447
4070
|
/**
|
|
3448
|
-
*
|
|
4071
|
+
* Reconciles policy assignments for the role assignment principal: creates missing policies and revokes leftovers that materialize no longer emits
|
|
3449
4072
|
* @summary Rematerialize Role Assignment
|
|
3450
4073
|
* @param {string} orgId
|
|
3451
4074
|
* @param {RematerializeRoleAssignmentRequestBody} [rematerializeRoleAssignmentRequestBody]
|
|
@@ -3478,7 +4101,7 @@ export declare const RoleAssignmentApiFactory: (configuration?: Configuration, b
|
|
|
3478
4101
|
*/
|
|
3479
4102
|
applyRoleAssignment(orgId: string, roleAssignmentRequestBody?: RoleAssignmentRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<RoleAssignmentSuccessResponse>;
|
|
3480
4103
|
/**
|
|
3481
|
-
*
|
|
4104
|
+
* Reconciles policy assignments for the role assignment principal: creates missing policies and revokes leftovers that materialize no longer emits
|
|
3482
4105
|
* @summary Rematerialize Role Assignment
|
|
3483
4106
|
* @param {string} orgId
|
|
3484
4107
|
* @param {RematerializeRoleAssignmentRequestBody} [rematerializeRoleAssignmentRequestBody]
|
|
@@ -3514,7 +4137,7 @@ export declare class RoleAssignmentApi extends BaseAPI {
|
|
|
3514
4137
|
*/
|
|
3515
4138
|
applyRoleAssignment(orgId: string, roleAssignmentRequestBody?: RoleAssignmentRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RoleAssignmentSuccessResponse, any, {}, any>>;
|
|
3516
4139
|
/**
|
|
3517
|
-
*
|
|
4140
|
+
* Reconciles policy assignments for the role assignment principal: creates missing policies and revokes leftovers that materialize no longer emits
|
|
3518
4141
|
* @summary Rematerialize Role Assignment
|
|
3519
4142
|
* @param {string} orgId
|
|
3520
4143
|
* @param {RematerializeRoleAssignmentRequestBody} [rematerializeRoleAssignmentRequestBody]
|
|
@@ -3534,6 +4157,113 @@ export declare class RoleAssignmentApi extends BaseAPI {
|
|
|
3534
4157
|
*/
|
|
3535
4158
|
removeTeammate(orgId: string, removeTeammateRequestBody?: RemoveTeammateRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RemoveTeammateSuccessResponse, any, {}, any>>;
|
|
3536
4159
|
}
|
|
4160
|
+
/**
|
|
4161
|
+
* TimedAccessApi - axios parameter creator
|
|
4162
|
+
* @export
|
|
4163
|
+
*/
|
|
4164
|
+
export declare const TimedAccessApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4165
|
+
/**
|
|
4166
|
+
* Grants the authenticated caller temporary Owner access to a single org. Requesting again while a pass is active extends it rather than creating a second one.
|
|
4167
|
+
* @summary Create a timed access pass
|
|
4168
|
+
* @param {string} orgId
|
|
4169
|
+
* @param {TimedAccessGrantRequestBody} [timedAccessGrantRequestBody]
|
|
4170
|
+
* @param {*} [options] Override http request option.
|
|
4171
|
+
* @throws {RequiredError}
|
|
4172
|
+
*/
|
|
4173
|
+
createTimedAccessGrant: (orgId: string, timedAccessGrantRequestBody?: TimedAccessGrantRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4174
|
+
/**
|
|
4175
|
+
* Returns the authenticated caller\'s active pass for the requested org.
|
|
4176
|
+
* @summary List the caller\'s active timed access pass for an org
|
|
4177
|
+
* @param {string} orgId
|
|
4178
|
+
* @param {ListMyTimedAccessGrantsStatusEnum} [status] Only active grants are returned. The caller comes from the auth context
|
|
4179
|
+
* @param {*} [options] Override http request option.
|
|
4180
|
+
* @throws {RequiredError}
|
|
4181
|
+
*/
|
|
4182
|
+
listMyTimedAccessGrants: (orgId: string, status?: ListMyTimedAccessGrantsStatusEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4183
|
+
};
|
|
4184
|
+
/**
|
|
4185
|
+
* TimedAccessApi - functional programming interface
|
|
4186
|
+
* @export
|
|
4187
|
+
*/
|
|
4188
|
+
export declare const TimedAccessApiFp: (configuration?: Configuration) => {
|
|
4189
|
+
/**
|
|
4190
|
+
* Grants the authenticated caller temporary Owner access to a single org. Requesting again while a pass is active extends it rather than creating a second one.
|
|
4191
|
+
* @summary Create a timed access pass
|
|
4192
|
+
* @param {string} orgId
|
|
4193
|
+
* @param {TimedAccessGrantRequestBody} [timedAccessGrantRequestBody]
|
|
4194
|
+
* @param {*} [options] Override http request option.
|
|
4195
|
+
* @throws {RequiredError}
|
|
4196
|
+
*/
|
|
4197
|
+
createTimedAccessGrant(orgId: string, timedAccessGrantRequestBody?: TimedAccessGrantRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimedAccessGrantResponse>>;
|
|
4198
|
+
/**
|
|
4199
|
+
* Returns the authenticated caller\'s active pass for the requested org.
|
|
4200
|
+
* @summary List the caller\'s active timed access pass for an org
|
|
4201
|
+
* @param {string} orgId
|
|
4202
|
+
* @param {ListMyTimedAccessGrantsStatusEnum} [status] Only active grants are returned. The caller comes from the auth context
|
|
4203
|
+
* @param {*} [options] Override http request option.
|
|
4204
|
+
* @throws {RequiredError}
|
|
4205
|
+
*/
|
|
4206
|
+
listMyTimedAccessGrants(orgId: string, status?: ListMyTimedAccessGrantsStatusEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTimedAccessGrantsResponse>>;
|
|
4207
|
+
};
|
|
4208
|
+
/**
|
|
4209
|
+
* TimedAccessApi - factory interface
|
|
4210
|
+
* @export
|
|
4211
|
+
*/
|
|
4212
|
+
export declare const TimedAccessApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4213
|
+
/**
|
|
4214
|
+
* Grants the authenticated caller temporary Owner access to a single org. Requesting again while a pass is active extends it rather than creating a second one.
|
|
4215
|
+
* @summary Create a timed access pass
|
|
4216
|
+
* @param {string} orgId
|
|
4217
|
+
* @param {TimedAccessGrantRequestBody} [timedAccessGrantRequestBody]
|
|
4218
|
+
* @param {*} [options] Override http request option.
|
|
4219
|
+
* @throws {RequiredError}
|
|
4220
|
+
*/
|
|
4221
|
+
createTimedAccessGrant(orgId: string, timedAccessGrantRequestBody?: TimedAccessGrantRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<TimedAccessGrantResponse>;
|
|
4222
|
+
/**
|
|
4223
|
+
* Returns the authenticated caller\'s active pass for the requested org.
|
|
4224
|
+
* @summary List the caller\'s active timed access pass for an org
|
|
4225
|
+
* @param {string} orgId
|
|
4226
|
+
* @param {ListMyTimedAccessGrantsStatusEnum} [status] Only active grants are returned. The caller comes from the auth context
|
|
4227
|
+
* @param {*} [options] Override http request option.
|
|
4228
|
+
* @throws {RequiredError}
|
|
4229
|
+
*/
|
|
4230
|
+
listMyTimedAccessGrants(orgId: string, status?: ListMyTimedAccessGrantsStatusEnum, options?: RawAxiosRequestConfig): AxiosPromise<ListTimedAccessGrantsResponse>;
|
|
4231
|
+
};
|
|
4232
|
+
/**
|
|
4233
|
+
* TimedAccessApi - object-oriented interface
|
|
4234
|
+
* @export
|
|
4235
|
+
* @class TimedAccessApi
|
|
4236
|
+
* @extends {BaseAPI}
|
|
4237
|
+
*/
|
|
4238
|
+
export declare class TimedAccessApi extends BaseAPI {
|
|
4239
|
+
/**
|
|
4240
|
+
* Grants the authenticated caller temporary Owner access to a single org. Requesting again while a pass is active extends it rather than creating a second one.
|
|
4241
|
+
* @summary Create a timed access pass
|
|
4242
|
+
* @param {string} orgId
|
|
4243
|
+
* @param {TimedAccessGrantRequestBody} [timedAccessGrantRequestBody]
|
|
4244
|
+
* @param {*} [options] Override http request option.
|
|
4245
|
+
* @throws {RequiredError}
|
|
4246
|
+
* @memberof TimedAccessApi
|
|
4247
|
+
*/
|
|
4248
|
+
createTimedAccessGrant(orgId: string, timedAccessGrantRequestBody?: TimedAccessGrantRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TimedAccessGrantResponse, any, {}, any>>;
|
|
4249
|
+
/**
|
|
4250
|
+
* Returns the authenticated caller\'s active pass for the requested org.
|
|
4251
|
+
* @summary List the caller\'s active timed access pass for an org
|
|
4252
|
+
* @param {string} orgId
|
|
4253
|
+
* @param {ListMyTimedAccessGrantsStatusEnum} [status] Only active grants are returned. The caller comes from the auth context
|
|
4254
|
+
* @param {*} [options] Override http request option.
|
|
4255
|
+
* @throws {RequiredError}
|
|
4256
|
+
* @memberof TimedAccessApi
|
|
4257
|
+
*/
|
|
4258
|
+
listMyTimedAccessGrants(orgId: string, status?: ListMyTimedAccessGrantsStatusEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTimedAccessGrantsResponse, any, {}, any>>;
|
|
4259
|
+
}
|
|
4260
|
+
/**
|
|
4261
|
+
* @export
|
|
4262
|
+
*/
|
|
4263
|
+
export declare const ListMyTimedAccessGrantsStatusEnum: {
|
|
4264
|
+
readonly Active: "active";
|
|
4265
|
+
};
|
|
4266
|
+
export type ListMyTimedAccessGrantsStatusEnum = typeof ListMyTimedAccessGrantsStatusEnum[keyof typeof ListMyTimedAccessGrantsStatusEnum];
|
|
3537
4267
|
/**
|
|
3538
4268
|
* UserManagementApi - axios parameter creator
|
|
3539
4269
|
* @export
|