@flipdish/authorization 0.2.57 → 0.2.58-rc.1790855819
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 +479 -31
- package/configuration.ts +1 -1
- package/dist/api.d.ts +307 -31
- package/dist/api.js +429 -2
- package/dist/configuration.js +1 -1
- package/package.json +1 -1
package/configuration.ts
CHANGED
|
@@ -100,7 +100,7 @@ export class Configuration {
|
|
|
100
100
|
|
|
101
101
|
const extraHeaders = param.useDefaultUserAgent ? {} : {
|
|
102
102
|
headers: {
|
|
103
|
-
"user-agent": "Flipdish authorization typescript SDK / 0.2.
|
|
103
|
+
"user-agent": "Flipdish authorization typescript SDK / 0.2.58-rc.1790855819"
|
|
104
104
|
}
|
|
105
105
|
};
|
|
106
106
|
|
package/dist/api.d.ts
CHANGED
|
@@ -40,6 +40,7 @@ export declare const AcceptJoinRequestRoleNameEnum: {
|
|
|
40
40
|
readonly PropertyManager: "PropertyManager";
|
|
41
41
|
readonly FinanceManager: "FinanceManager";
|
|
42
42
|
readonly StaffMember: "StaffMember";
|
|
43
|
+
readonly Courier: "Courier";
|
|
43
44
|
readonly Kiosk: "Kiosk";
|
|
44
45
|
readonly Terminal: "Terminal";
|
|
45
46
|
};
|
|
@@ -257,6 +258,7 @@ export declare const AccessRequestResponseRoleNameEnum: {
|
|
|
257
258
|
readonly PropertyManager: "PropertyManager";
|
|
258
259
|
readonly FinanceManager: "FinanceManager";
|
|
259
260
|
readonly StaffMember: "StaffMember";
|
|
261
|
+
readonly Courier: "Courier";
|
|
260
262
|
readonly Kiosk: "Kiosk";
|
|
261
263
|
readonly Terminal: "Terminal";
|
|
262
264
|
};
|
|
@@ -1317,6 +1319,7 @@ export declare const GetJoinAccessRequest200ResponseRoleNameEnum: {
|
|
|
1317
1319
|
readonly PropertyManager: "PropertyManager";
|
|
1318
1320
|
readonly FinanceManager: "FinanceManager";
|
|
1319
1321
|
readonly StaffMember: "StaffMember";
|
|
1322
|
+
readonly Courier: "Courier";
|
|
1320
1323
|
readonly Kiosk: "Kiosk";
|
|
1321
1324
|
readonly Terminal: "Terminal";
|
|
1322
1325
|
};
|
|
@@ -1382,6 +1385,83 @@ export type GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = ty
|
|
|
1382
1385
|
*/
|
|
1383
1386
|
export interface GetUserPermissionsSuccessResponseResourcesValueResourceId {
|
|
1384
1387
|
}
|
|
1388
|
+
/**
|
|
1389
|
+
* Successful user roles retrieval response
|
|
1390
|
+
* @export
|
|
1391
|
+
* @interface GetUserRolesSuccessResponse
|
|
1392
|
+
*/
|
|
1393
|
+
export interface GetUserRolesSuccessResponse {
|
|
1394
|
+
/**
|
|
1395
|
+
*
|
|
1396
|
+
* @type {GetUserRolesSuccessResponseOrgId}
|
|
1397
|
+
* @memberof GetUserRolesSuccessResponse
|
|
1398
|
+
*/
|
|
1399
|
+
'orgId': GetUserRolesSuccessResponseOrgId;
|
|
1400
|
+
/**
|
|
1401
|
+
* List of roles that are assigned to the user in the org
|
|
1402
|
+
* @type {Array<string>}
|
|
1403
|
+
* @memberof GetUserRolesSuccessResponse
|
|
1404
|
+
*/
|
|
1405
|
+
'roles': Array<GetUserRolesSuccessResponseRolesEnum>;
|
|
1406
|
+
/**
|
|
1407
|
+
* Optional permission set keys applied to the roles
|
|
1408
|
+
* @type {Array<string>}
|
|
1409
|
+
* @memberof GetUserRolesSuccessResponse
|
|
1410
|
+
*/
|
|
1411
|
+
'optionalPermissionSetKeys'?: Array<string>;
|
|
1412
|
+
/**
|
|
1413
|
+
* Property IDs, or * for all properties, the roles are scoped to
|
|
1414
|
+
* @type {Array<GetJoinAccessRequest200ResponsePropertyIdsInner>}
|
|
1415
|
+
* @memberof GetUserRolesSuccessResponse
|
|
1416
|
+
*/
|
|
1417
|
+
'properties'?: Array<GetJoinAccessRequest200ResponsePropertyIdsInner>;
|
|
1418
|
+
/**
|
|
1419
|
+
* Brand IDs, or * for all brands, the roles are scoped to
|
|
1420
|
+
* @type {Array<GetUserRolesSuccessResponseBrandsInner>}
|
|
1421
|
+
* @memberof GetUserRolesSuccessResponse
|
|
1422
|
+
*/
|
|
1423
|
+
'brands'?: Array<GetUserRolesSuccessResponseBrandsInner>;
|
|
1424
|
+
/**
|
|
1425
|
+
* Sales channel IDs, or * for all sales channels, the roles are scoped to
|
|
1426
|
+
* @type {Array<GetUserRolesSuccessResponseSalesChannelsInner>}
|
|
1427
|
+
* @memberof GetUserRolesSuccessResponse
|
|
1428
|
+
*/
|
|
1429
|
+
'salesChannels'?: Array<GetUserRolesSuccessResponseSalesChannelsInner>;
|
|
1430
|
+
}
|
|
1431
|
+
export declare const GetUserRolesSuccessResponseRolesEnum: {
|
|
1432
|
+
readonly Owner: "Owner";
|
|
1433
|
+
readonly PropertyOwner: "PropertyOwner";
|
|
1434
|
+
readonly ManagedOwner: "ManagedOwner";
|
|
1435
|
+
readonly Integrator: "Integrator";
|
|
1436
|
+
readonly PropertyManager: "PropertyManager";
|
|
1437
|
+
readonly FinanceManager: "FinanceManager";
|
|
1438
|
+
readonly StaffMember: "StaffMember";
|
|
1439
|
+
readonly Courier: "Courier";
|
|
1440
|
+
readonly Kiosk: "Kiosk";
|
|
1441
|
+
readonly Terminal: "Terminal";
|
|
1442
|
+
};
|
|
1443
|
+
export type GetUserRolesSuccessResponseRolesEnum = typeof GetUserRolesSuccessResponseRolesEnum[keyof typeof GetUserRolesSuccessResponseRolesEnum];
|
|
1444
|
+
/**
|
|
1445
|
+
*
|
|
1446
|
+
* @export
|
|
1447
|
+
* @interface GetUserRolesSuccessResponseBrandsInner
|
|
1448
|
+
*/
|
|
1449
|
+
export interface GetUserRolesSuccessResponseBrandsInner {
|
|
1450
|
+
}
|
|
1451
|
+
/**
|
|
1452
|
+
* ID of the org the roles are assigned in
|
|
1453
|
+
* @export
|
|
1454
|
+
* @interface GetUserRolesSuccessResponseOrgId
|
|
1455
|
+
*/
|
|
1456
|
+
export interface GetUserRolesSuccessResponseOrgId {
|
|
1457
|
+
}
|
|
1458
|
+
/**
|
|
1459
|
+
*
|
|
1460
|
+
* @export
|
|
1461
|
+
* @interface GetUserRolesSuccessResponseSalesChannelsInner
|
|
1462
|
+
*/
|
|
1463
|
+
export interface GetUserRolesSuccessResponseSalesChannelsInner {
|
|
1464
|
+
}
|
|
1385
1465
|
/**
|
|
1386
1466
|
*
|
|
1387
1467
|
* @export
|
|
@@ -1715,6 +1795,7 @@ export declare const InviteTokenResponseRoleNameEnum: {
|
|
|
1715
1795
|
readonly PropertyManager: "PropertyManager";
|
|
1716
1796
|
readonly FinanceManager: "FinanceManager";
|
|
1717
1797
|
readonly StaffMember: "StaffMember";
|
|
1798
|
+
readonly Courier: "Courier";
|
|
1718
1799
|
readonly Kiosk: "Kiosk";
|
|
1719
1800
|
readonly Terminal: "Terminal";
|
|
1720
1801
|
};
|
|
@@ -1785,6 +1866,19 @@ export declare const JoinAccessErrorResponseCodeEnum: {
|
|
|
1785
1866
|
readonly AlreadyMember: "ALREADY_MEMBER";
|
|
1786
1867
|
};
|
|
1787
1868
|
export type JoinAccessErrorResponseCodeEnum = typeof JoinAccessErrorResponseCodeEnum[keyof typeof JoinAccessErrorResponseCodeEnum];
|
|
1869
|
+
/**
|
|
1870
|
+
* Caller removed from org
|
|
1871
|
+
* @export
|
|
1872
|
+
* @interface LeaveOrgSuccessResponse
|
|
1873
|
+
*/
|
|
1874
|
+
export interface LeaveOrgSuccessResponse {
|
|
1875
|
+
/**
|
|
1876
|
+
*
|
|
1877
|
+
* @type {string}
|
|
1878
|
+
* @memberof LeaveOrgSuccessResponse
|
|
1879
|
+
*/
|
|
1880
|
+
'message': string;
|
|
1881
|
+
}
|
|
1788
1882
|
/**
|
|
1789
1883
|
* An org\'s expired timed access grants, most recent first
|
|
1790
1884
|
* @export
|
|
@@ -1830,6 +1924,25 @@ export interface ListJoinRequestsResponse {
|
|
|
1830
1924
|
*/
|
|
1831
1925
|
'items': Array<GetJoinAccessRequest200Response>;
|
|
1832
1926
|
}
|
|
1927
|
+
/**
|
|
1928
|
+
* The named roles held by a user
|
|
1929
|
+
* @export
|
|
1930
|
+
* @interface ListNamedRolesResponse
|
|
1931
|
+
*/
|
|
1932
|
+
export interface ListNamedRolesResponse {
|
|
1933
|
+
/**
|
|
1934
|
+
*
|
|
1935
|
+
* @type {string}
|
|
1936
|
+
* @memberof ListNamedRolesResponse
|
|
1937
|
+
*/
|
|
1938
|
+
'userId': string;
|
|
1939
|
+
/**
|
|
1940
|
+
* The named roles currently held by this user
|
|
1941
|
+
* @type {Array<RoleNames>}
|
|
1942
|
+
* @memberof ListNamedRolesResponse
|
|
1943
|
+
*/
|
|
1944
|
+
'roles': Array<RoleNames>;
|
|
1945
|
+
}
|
|
1833
1946
|
/**
|
|
1834
1947
|
*
|
|
1835
1948
|
* @export
|
|
@@ -1838,10 +1951,10 @@ export interface ListJoinRequestsResponse {
|
|
|
1838
1951
|
export interface ListOrgRolesSuccessResponseValue {
|
|
1839
1952
|
/**
|
|
1840
1953
|
*
|
|
1841
|
-
* @type {
|
|
1954
|
+
* @type {GetUserRolesSuccessResponseOrgId}
|
|
1842
1955
|
* @memberof ListOrgRolesSuccessResponseValue
|
|
1843
1956
|
*/
|
|
1844
|
-
'orgId':
|
|
1957
|
+
'orgId': GetUserRolesSuccessResponseOrgId;
|
|
1845
1958
|
/**
|
|
1846
1959
|
* List of roles that are assigned to the user in the org
|
|
1847
1960
|
* @type {Array<string>}
|
|
@@ -1862,16 +1975,16 @@ export interface ListOrgRolesSuccessResponseValue {
|
|
|
1862
1975
|
'properties'?: Array<GetJoinAccessRequest200ResponsePropertyIdsInner>;
|
|
1863
1976
|
/**
|
|
1864
1977
|
* Brand IDs, or * for all brands, the roles are scoped to
|
|
1865
|
-
* @type {Array<
|
|
1978
|
+
* @type {Array<GetUserRolesSuccessResponseBrandsInner>}
|
|
1866
1979
|
* @memberof ListOrgRolesSuccessResponseValue
|
|
1867
1980
|
*/
|
|
1868
|
-
'brands'?: Array<
|
|
1981
|
+
'brands'?: Array<GetUserRolesSuccessResponseBrandsInner>;
|
|
1869
1982
|
/**
|
|
1870
1983
|
* Sales channel IDs, or * for all sales channels, the roles are scoped to
|
|
1871
|
-
* @type {Array<
|
|
1984
|
+
* @type {Array<GetUserRolesSuccessResponseSalesChannelsInner>}
|
|
1872
1985
|
* @memberof ListOrgRolesSuccessResponseValue
|
|
1873
1986
|
*/
|
|
1874
|
-
'salesChannels'?: Array<
|
|
1987
|
+
'salesChannels'?: Array<GetUserRolesSuccessResponseSalesChannelsInner>;
|
|
1875
1988
|
}
|
|
1876
1989
|
export declare const ListOrgRolesSuccessResponseValueRolesEnum: {
|
|
1877
1990
|
readonly Owner: "Owner";
|
|
@@ -1881,31 +1994,11 @@ export declare const ListOrgRolesSuccessResponseValueRolesEnum: {
|
|
|
1881
1994
|
readonly PropertyManager: "PropertyManager";
|
|
1882
1995
|
readonly FinanceManager: "FinanceManager";
|
|
1883
1996
|
readonly StaffMember: "StaffMember";
|
|
1997
|
+
readonly Courier: "Courier";
|
|
1884
1998
|
readonly Kiosk: "Kiosk";
|
|
1885
1999
|
readonly Terminal: "Terminal";
|
|
1886
2000
|
};
|
|
1887
2001
|
export type ListOrgRolesSuccessResponseValueRolesEnum = typeof ListOrgRolesSuccessResponseValueRolesEnum[keyof typeof ListOrgRolesSuccessResponseValueRolesEnum];
|
|
1888
|
-
/**
|
|
1889
|
-
*
|
|
1890
|
-
* @export
|
|
1891
|
-
* @interface ListOrgRolesSuccessResponseValueBrandsInner
|
|
1892
|
-
*/
|
|
1893
|
-
export interface ListOrgRolesSuccessResponseValueBrandsInner {
|
|
1894
|
-
}
|
|
1895
|
-
/**
|
|
1896
|
-
* ID of the org the roles are assigned in
|
|
1897
|
-
* @export
|
|
1898
|
-
* @interface ListOrgRolesSuccessResponseValueOrgId
|
|
1899
|
-
*/
|
|
1900
|
-
export interface ListOrgRolesSuccessResponseValueOrgId {
|
|
1901
|
-
}
|
|
1902
|
-
/**
|
|
1903
|
-
*
|
|
1904
|
-
* @export
|
|
1905
|
-
* @interface ListOrgRolesSuccessResponseValueSalesChannelsInner
|
|
1906
|
-
*/
|
|
1907
|
-
export interface ListOrgRolesSuccessResponseValueSalesChannelsInner {
|
|
1908
|
-
}
|
|
1909
2002
|
/**
|
|
1910
2003
|
* Successful permissions retrieval response
|
|
1911
2004
|
* @export
|
|
@@ -1978,6 +2071,7 @@ export declare const ListRoleDefinitionsSuccessResponseRolesInnerNameEnum: {
|
|
|
1978
2071
|
readonly PropertyManager: "PropertyManager";
|
|
1979
2072
|
readonly FinanceManager: "FinanceManager";
|
|
1980
2073
|
readonly StaffMember: "StaffMember";
|
|
2074
|
+
readonly Courier: "Courier";
|
|
1981
2075
|
readonly Kiosk: "Kiosk";
|
|
1982
2076
|
readonly Terminal: "Terminal";
|
|
1983
2077
|
};
|
|
@@ -2091,6 +2185,7 @@ export declare const Permissions: {
|
|
|
2091
2185
|
readonly CreateTeammatePropertyManager: "CreateTeammatePropertyManager";
|
|
2092
2186
|
readonly CreateTeammatePropertyOwner: "CreateTeammatePropertyOwner";
|
|
2093
2187
|
readonly CreateTeammateStaffMember: "CreateTeammateStaffMember";
|
|
2188
|
+
readonly CreateTeammateCourier: "CreateTeammateCourier";
|
|
2094
2189
|
readonly ViewApmConfigurations: "ViewApmConfigurations";
|
|
2095
2190
|
readonly EditApmConfigurations: "EditApmConfigurations";
|
|
2096
2191
|
readonly ViewCampaignsConfigurations: "ViewCampaignsConfigurations";
|
|
@@ -2134,6 +2229,7 @@ export declare const Permissions: {
|
|
|
2134
2229
|
readonly CreateGlobalApiKey: "CreateGlobalAPIKey";
|
|
2135
2230
|
readonly ListGlobalApiKeys: "ListGlobalAPIKeys";
|
|
2136
2231
|
readonly BlockPrincipalAccess: "BlockPrincipalAccess";
|
|
2232
|
+
readonly ListPrincipalOrgs: "ListPrincipalOrgs";
|
|
2137
2233
|
readonly CreateMenu: "CreateMenu";
|
|
2138
2234
|
readonly UpdateMenu: "UpdateMenu";
|
|
2139
2235
|
readonly DeleteMenu: "DeleteMenu";
|
|
@@ -2304,6 +2400,7 @@ export declare const Permissions: {
|
|
|
2304
2400
|
readonly ViewWebhooks: "ViewWebhooks";
|
|
2305
2401
|
readonly EditWebhooks: "EditWebhooks";
|
|
2306
2402
|
readonly ViewOwnPermissions: "ViewOwnPermissions";
|
|
2403
|
+
readonly LeaveOrg: "LeaveOrg";
|
|
2307
2404
|
readonly CreatePosSale: "CreatePosSale";
|
|
2308
2405
|
readonly ComplimentPosItems: "ComplimentPosItems";
|
|
2309
2406
|
readonly ApplyPosDiscounts: "ApplyPosDiscounts";
|
|
@@ -2324,6 +2421,7 @@ export declare const Permissions: {
|
|
|
2324
2421
|
readonly SnoozePosItem: "SnoozePosItem";
|
|
2325
2422
|
readonly SnoozePosItemIndefinitely: "SnoozePosItemIndefinitely";
|
|
2326
2423
|
readonly SnoozePosProperty: "SnoozePosProperty";
|
|
2424
|
+
readonly SendSmsToCustomers: "SendSmsToCustomers";
|
|
2327
2425
|
readonly RoleAdmin: "RoleAdmin";
|
|
2328
2426
|
readonly RoleFactory: "RoleFactory";
|
|
2329
2427
|
readonly RoleAuthDeveloper: "RoleAuthDeveloper";
|
|
@@ -2380,6 +2478,25 @@ export declare const PrincipalInOrgTypeEnum: {
|
|
|
2380
2478
|
readonly Terminal: "Terminal";
|
|
2381
2479
|
};
|
|
2382
2480
|
export type PrincipalInOrgTypeEnum = typeof PrincipalInOrgTypeEnum[keyof typeof PrincipalInOrgTypeEnum];
|
|
2481
|
+
/**
|
|
2482
|
+
* A principal and its org memberships, read straight from the principals store. These are the orgs the principal holds permission assignments in, which is a superset of the orgs any given action is allowed on. No policy evaluation is performed.
|
|
2483
|
+
* @export
|
|
2484
|
+
* @interface PrincipalOrgsResponse
|
|
2485
|
+
*/
|
|
2486
|
+
export interface PrincipalOrgsResponse {
|
|
2487
|
+
/**
|
|
2488
|
+
*
|
|
2489
|
+
* @type {AuthorizationRequestPrincipal}
|
|
2490
|
+
* @memberof PrincipalOrgsResponse
|
|
2491
|
+
*/
|
|
2492
|
+
'principal': AuthorizationRequestPrincipal;
|
|
2493
|
+
/**
|
|
2494
|
+
* Org ids the principal holds permission assignments in, ascending
|
|
2495
|
+
* @type {Array<string>}
|
|
2496
|
+
* @memberof PrincipalOrgsResponse
|
|
2497
|
+
*/
|
|
2498
|
+
'orgIds': Array<string>;
|
|
2499
|
+
}
|
|
2383
2500
|
/**
|
|
2384
2501
|
* Principals in org
|
|
2385
2502
|
* @export
|
|
@@ -2639,16 +2756,16 @@ export interface RoleAssignmentRequestBody {
|
|
|
2639
2756
|
'properties'?: Array<GetJoinAccessRequest200ResponsePropertyIdsInner>;
|
|
2640
2757
|
/**
|
|
2641
2758
|
* Brand resource ids (e.g. b123) when scoped to brands
|
|
2642
|
-
* @type {Array<
|
|
2759
|
+
* @type {Array<GetUserRolesSuccessResponseBrandsInner>}
|
|
2643
2760
|
* @memberof RoleAssignmentRequestBody
|
|
2644
2761
|
*/
|
|
2645
|
-
'brands'?: Array<
|
|
2762
|
+
'brands'?: Array<GetUserRolesSuccessResponseBrandsInner>;
|
|
2646
2763
|
/**
|
|
2647
2764
|
* Sales channel resource ids (e.g. sc123) when scoped to sales channels
|
|
2648
|
-
* @type {Array<
|
|
2765
|
+
* @type {Array<GetUserRolesSuccessResponseSalesChannelsInner>}
|
|
2649
2766
|
* @memberof RoleAssignmentRequestBody
|
|
2650
2767
|
*/
|
|
2651
|
-
'salesChannels'?: Array<
|
|
2768
|
+
'salesChannels'?: Array<GetUserRolesSuccessResponseSalesChannelsInner>;
|
|
2652
2769
|
/**
|
|
2653
2770
|
* Optional permission set keys to apply to this role assignment
|
|
2654
2771
|
* @type {Array<string>}
|
|
@@ -2670,6 +2787,7 @@ export declare const RoleAssignmentRequestBodyRoleNameEnum: {
|
|
|
2670
2787
|
readonly PropertyManager: "PropertyManager";
|
|
2671
2788
|
readonly FinanceManager: "FinanceManager";
|
|
2672
2789
|
readonly StaffMember: "StaffMember";
|
|
2790
|
+
readonly Courier: "Courier";
|
|
2673
2791
|
readonly Kiosk: "Kiosk";
|
|
2674
2792
|
readonly Terminal: "Terminal";
|
|
2675
2793
|
};
|
|
@@ -4183,6 +4301,14 @@ export declare const NamedRolesApiAxiosParamCreator: (configuration?: Configurat
|
|
|
4183
4301
|
* @throws {RequiredError}
|
|
4184
4302
|
*/
|
|
4185
4303
|
applyNamedRole: (applyNamedRoleRequestBody?: ApplyNamedRoleRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4304
|
+
/**
|
|
4305
|
+
* Lists the named roles currently held by the given user. No org context needed, since named roles are global. Caller must hold Admin, Factory, or AuthDeveloper.
|
|
4306
|
+
* @summary List named roles for a user
|
|
4307
|
+
* @param {string} principalId
|
|
4308
|
+
* @param {*} [options] Override http request option.
|
|
4309
|
+
* @throws {RequiredError}
|
|
4310
|
+
*/
|
|
4311
|
+
listNamedRoles: (principalId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4186
4312
|
/**
|
|
4187
4313
|
* Removes the named role given in the body so the user can no longer act as it. Does not end passes already held; those run to their own expiry. Subject to the same privilege-level gate and AuthDeveloper block as assignment. Mirrors /orgs/{orgId}/roleAssignments/remove.
|
|
4188
4314
|
* @summary Remove a named role
|
|
@@ -4205,6 +4331,14 @@ export declare const NamedRolesApiFp: (configuration?: Configuration) => {
|
|
|
4205
4331
|
* @throws {RequiredError}
|
|
4206
4332
|
*/
|
|
4207
4333
|
applyNamedRole(applyNamedRoleRequestBody?: ApplyNamedRoleRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NamedRoleAssignmentResponse>>;
|
|
4334
|
+
/**
|
|
4335
|
+
* Lists the named roles currently held by the given user. No org context needed, since named roles are global. Caller must hold Admin, Factory, or AuthDeveloper.
|
|
4336
|
+
* @summary List named roles for a user
|
|
4337
|
+
* @param {string} principalId
|
|
4338
|
+
* @param {*} [options] Override http request option.
|
|
4339
|
+
* @throws {RequiredError}
|
|
4340
|
+
*/
|
|
4341
|
+
listNamedRoles(principalId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListNamedRolesResponse>>;
|
|
4208
4342
|
/**
|
|
4209
4343
|
* Removes the named role given in the body so the user can no longer act as it. Does not end passes already held; those run to their own expiry. Subject to the same privilege-level gate and AuthDeveloper block as assignment. Mirrors /orgs/{orgId}/roleAssignments/remove.
|
|
4210
4344
|
* @summary Remove a named role
|
|
@@ -4227,6 +4361,14 @@ export declare const NamedRolesApiFactory: (configuration?: Configuration, baseP
|
|
|
4227
4361
|
* @throws {RequiredError}
|
|
4228
4362
|
*/
|
|
4229
4363
|
applyNamedRole(applyNamedRoleRequestBody?: ApplyNamedRoleRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<NamedRoleAssignmentResponse>;
|
|
4364
|
+
/**
|
|
4365
|
+
* Lists the named roles currently held by the given user. No org context needed, since named roles are global. Caller must hold Admin, Factory, or AuthDeveloper.
|
|
4366
|
+
* @summary List named roles for a user
|
|
4367
|
+
* @param {string} principalId
|
|
4368
|
+
* @param {*} [options] Override http request option.
|
|
4369
|
+
* @throws {RequiredError}
|
|
4370
|
+
*/
|
|
4371
|
+
listNamedRoles(principalId: string, options?: RawAxiosRequestConfig): AxiosPromise<ListNamedRolesResponse>;
|
|
4230
4372
|
/**
|
|
4231
4373
|
* Removes the named role given in the body so the user can no longer act as it. Does not end passes already held; those run to their own expiry. Subject to the same privilege-level gate and AuthDeveloper block as assignment. Mirrors /orgs/{orgId}/roleAssignments/remove.
|
|
4232
4374
|
* @summary Remove a named role
|
|
@@ -4252,6 +4394,15 @@ export declare class NamedRolesApi extends BaseAPI {
|
|
|
4252
4394
|
* @memberof NamedRolesApi
|
|
4253
4395
|
*/
|
|
4254
4396
|
applyNamedRole(applyNamedRoleRequestBody?: ApplyNamedRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NamedRoleAssignmentResponse, any, {}, any>>;
|
|
4397
|
+
/**
|
|
4398
|
+
* Lists the named roles currently held by the given user. No org context needed, since named roles are global. Caller must hold Admin, Factory, or AuthDeveloper.
|
|
4399
|
+
* @summary List named roles for a user
|
|
4400
|
+
* @param {string} principalId
|
|
4401
|
+
* @param {*} [options] Override http request option.
|
|
4402
|
+
* @throws {RequiredError}
|
|
4403
|
+
* @memberof NamedRolesApi
|
|
4404
|
+
*/
|
|
4405
|
+
listNamedRoles(principalId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListNamedRolesResponse, any, {}, any>>;
|
|
4255
4406
|
/**
|
|
4256
4407
|
* Removes the named role given in the body so the user can no longer act as it. Does not end passes already held; those run to their own expiry. Subject to the same privilege-level gate and AuthDeveloper block as assignment. Mirrors /orgs/{orgId}/roleAssignments/remove.
|
|
4257
4408
|
* @summary Remove a named role
|
|
@@ -4444,6 +4595,65 @@ export declare const ListPrincipalAccessBlocksTypeEnum: {
|
|
|
4444
4595
|
readonly Terminal: "Terminal";
|
|
4445
4596
|
};
|
|
4446
4597
|
export type ListPrincipalAccessBlocksTypeEnum = typeof ListPrincipalAccessBlocksTypeEnum[keyof typeof ListPrincipalAccessBlocksTypeEnum];
|
|
4598
|
+
/**
|
|
4599
|
+
* PrincipalsApi - axios parameter creator
|
|
4600
|
+
* @export
|
|
4601
|
+
*/
|
|
4602
|
+
export declare const PrincipalsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4603
|
+
/**
|
|
4604
|
+
* Returns the principal and the orgs it holds permission assignments in, read from the principals store with no policy evaluation. This is a superset of the orgs any single action is allowed on, so it is a sound negative filter (no membership means no permission) but not an authoritative allow. Intended as a cheap prefilter ahead of /authorize/batch/checks; use /getAuthorizedOrgs when you need a per-action answer. Requires ListPrincipalOrgs.
|
|
4605
|
+
* @summary Get principal org memberships
|
|
4606
|
+
* @param {string} principalId
|
|
4607
|
+
* @param {*} [options] Override http request option.
|
|
4608
|
+
* @throws {RequiredError}
|
|
4609
|
+
*/
|
|
4610
|
+
getPrincipalOrgs: (principalId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4611
|
+
};
|
|
4612
|
+
/**
|
|
4613
|
+
* PrincipalsApi - functional programming interface
|
|
4614
|
+
* @export
|
|
4615
|
+
*/
|
|
4616
|
+
export declare const PrincipalsApiFp: (configuration?: Configuration) => {
|
|
4617
|
+
/**
|
|
4618
|
+
* Returns the principal and the orgs it holds permission assignments in, read from the principals store with no policy evaluation. This is a superset of the orgs any single action is allowed on, so it is a sound negative filter (no membership means no permission) but not an authoritative allow. Intended as a cheap prefilter ahead of /authorize/batch/checks; use /getAuthorizedOrgs when you need a per-action answer. Requires ListPrincipalOrgs.
|
|
4619
|
+
* @summary Get principal org memberships
|
|
4620
|
+
* @param {string} principalId
|
|
4621
|
+
* @param {*} [options] Override http request option.
|
|
4622
|
+
* @throws {RequiredError}
|
|
4623
|
+
*/
|
|
4624
|
+
getPrincipalOrgs(principalId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PrincipalOrgsResponse>>;
|
|
4625
|
+
};
|
|
4626
|
+
/**
|
|
4627
|
+
* PrincipalsApi - factory interface
|
|
4628
|
+
* @export
|
|
4629
|
+
*/
|
|
4630
|
+
export declare const PrincipalsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4631
|
+
/**
|
|
4632
|
+
* Returns the principal and the orgs it holds permission assignments in, read from the principals store with no policy evaluation. This is a superset of the orgs any single action is allowed on, so it is a sound negative filter (no membership means no permission) but not an authoritative allow. Intended as a cheap prefilter ahead of /authorize/batch/checks; use /getAuthorizedOrgs when you need a per-action answer. Requires ListPrincipalOrgs.
|
|
4633
|
+
* @summary Get principal org memberships
|
|
4634
|
+
* @param {string} principalId
|
|
4635
|
+
* @param {*} [options] Override http request option.
|
|
4636
|
+
* @throws {RequiredError}
|
|
4637
|
+
*/
|
|
4638
|
+
getPrincipalOrgs(principalId: string, options?: RawAxiosRequestConfig): AxiosPromise<PrincipalOrgsResponse>;
|
|
4639
|
+
};
|
|
4640
|
+
/**
|
|
4641
|
+
* PrincipalsApi - object-oriented interface
|
|
4642
|
+
* @export
|
|
4643
|
+
* @class PrincipalsApi
|
|
4644
|
+
* @extends {BaseAPI}
|
|
4645
|
+
*/
|
|
4646
|
+
export declare class PrincipalsApi extends BaseAPI {
|
|
4647
|
+
/**
|
|
4648
|
+
* Returns the principal and the orgs it holds permission assignments in, read from the principals store with no policy evaluation. This is a superset of the orgs any single action is allowed on, so it is a sound negative filter (no membership means no permission) but not an authoritative allow. Intended as a cheap prefilter ahead of /authorize/batch/checks; use /getAuthorizedOrgs when you need a per-action answer. Requires ListPrincipalOrgs.
|
|
4649
|
+
* @summary Get principal org memberships
|
|
4650
|
+
* @param {string} principalId
|
|
4651
|
+
* @param {*} [options] Override http request option.
|
|
4652
|
+
* @throws {RequiredError}
|
|
4653
|
+
* @memberof PrincipalsApi
|
|
4654
|
+
*/
|
|
4655
|
+
getPrincipalOrgs(principalId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PrincipalOrgsResponse, any, {}, any>>;
|
|
4656
|
+
}
|
|
4447
4657
|
/**
|
|
4448
4658
|
* RoleAssignmentApi - axios parameter creator
|
|
4449
4659
|
* @export
|
|
@@ -4458,6 +4668,14 @@ export declare const RoleAssignmentApiAxiosParamCreator: (configuration?: Config
|
|
|
4458
4668
|
* @throws {RequiredError}
|
|
4459
4669
|
*/
|
|
4460
4670
|
applyRoleAssignment: (orgId: string, roleAssignmentRequestBody?: RoleAssignmentRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4671
|
+
/**
|
|
4672
|
+
* Removes the caller from the org: revokes all of their V2 role assignments, reconciles away their policies, and removes them from the org user list. Does not change their Zeus teammate record.
|
|
4673
|
+
* @summary Leave org
|
|
4674
|
+
* @param {string} orgId
|
|
4675
|
+
* @param {*} [options] Override http request option.
|
|
4676
|
+
* @throws {RequiredError}
|
|
4677
|
+
*/
|
|
4678
|
+
leaveOrg: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4461
4679
|
/**
|
|
4462
4680
|
* Reconciles policy assignments for the role assignment principal: creates missing policies and revokes leftovers that materialize no longer emits
|
|
4463
4681
|
* @summary Rematerialize Role Assignment
|
|
@@ -4491,6 +4709,14 @@ export declare const RoleAssignmentApiFp: (configuration?: Configuration) => {
|
|
|
4491
4709
|
* @throws {RequiredError}
|
|
4492
4710
|
*/
|
|
4493
4711
|
applyRoleAssignment(orgId: string, roleAssignmentRequestBody?: RoleAssignmentRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RoleAssignmentSuccessResponse>>;
|
|
4712
|
+
/**
|
|
4713
|
+
* Removes the caller from the org: revokes all of their V2 role assignments, reconciles away their policies, and removes them from the org user list. Does not change their Zeus teammate record.
|
|
4714
|
+
* @summary Leave org
|
|
4715
|
+
* @param {string} orgId
|
|
4716
|
+
* @param {*} [options] Override http request option.
|
|
4717
|
+
* @throws {RequiredError}
|
|
4718
|
+
*/
|
|
4719
|
+
leaveOrg(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LeaveOrgSuccessResponse>>;
|
|
4494
4720
|
/**
|
|
4495
4721
|
* Reconciles policy assignments for the role assignment principal: creates missing policies and revokes leftovers that materialize no longer emits
|
|
4496
4722
|
* @summary Rematerialize Role Assignment
|
|
@@ -4524,6 +4750,14 @@ export declare const RoleAssignmentApiFactory: (configuration?: Configuration, b
|
|
|
4524
4750
|
* @throws {RequiredError}
|
|
4525
4751
|
*/
|
|
4526
4752
|
applyRoleAssignment(orgId: string, roleAssignmentRequestBody?: RoleAssignmentRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<RoleAssignmentSuccessResponse>;
|
|
4753
|
+
/**
|
|
4754
|
+
* Removes the caller from the org: revokes all of their V2 role assignments, reconciles away their policies, and removes them from the org user list. Does not change their Zeus teammate record.
|
|
4755
|
+
* @summary Leave org
|
|
4756
|
+
* @param {string} orgId
|
|
4757
|
+
* @param {*} [options] Override http request option.
|
|
4758
|
+
* @throws {RequiredError}
|
|
4759
|
+
*/
|
|
4760
|
+
leaveOrg(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<LeaveOrgSuccessResponse>;
|
|
4527
4761
|
/**
|
|
4528
4762
|
* Reconciles policy assignments for the role assignment principal: creates missing policies and revokes leftovers that materialize no longer emits
|
|
4529
4763
|
* @summary Rematerialize Role Assignment
|
|
@@ -4560,6 +4794,15 @@ export declare class RoleAssignmentApi extends BaseAPI {
|
|
|
4560
4794
|
* @memberof RoleAssignmentApi
|
|
4561
4795
|
*/
|
|
4562
4796
|
applyRoleAssignment(orgId: string, roleAssignmentRequestBody?: RoleAssignmentRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RoleAssignmentSuccessResponse, any, {}, any>>;
|
|
4797
|
+
/**
|
|
4798
|
+
* Removes the caller from the org: revokes all of their V2 role assignments, reconciles away their policies, and removes them from the org user list. Does not change their Zeus teammate record.
|
|
4799
|
+
* @summary Leave org
|
|
4800
|
+
* @param {string} orgId
|
|
4801
|
+
* @param {*} [options] Override http request option.
|
|
4802
|
+
* @throws {RequiredError}
|
|
4803
|
+
* @memberof RoleAssignmentApi
|
|
4804
|
+
*/
|
|
4805
|
+
leaveOrg(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LeaveOrgSuccessResponse, any, {}, any>>;
|
|
4563
4806
|
/**
|
|
4564
4807
|
* Reconciles policy assignments for the role assignment principal: creates missing policies and revokes leftovers that materialize no longer emits
|
|
4565
4808
|
* @summary Rematerialize Role Assignment
|
|
@@ -4817,6 +5060,14 @@ export declare const UserPermissionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
4817
5060
|
* @throws {RequiredError}
|
|
4818
5061
|
*/
|
|
4819
5062
|
listOwnPermissions: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5063
|
+
/**
|
|
5064
|
+
* List the role assignments for the current user in the org
|
|
5065
|
+
* @summary List Own Roles
|
|
5066
|
+
* @param {string} orgId
|
|
5067
|
+
* @param {*} [options] Override http request option.
|
|
5068
|
+
* @throws {RequiredError}
|
|
5069
|
+
*/
|
|
5070
|
+
listOwnRoles: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4820
5071
|
/**
|
|
4821
5072
|
* List the available permissions for a given user
|
|
4822
5073
|
* @summary List User Permissions
|
|
@@ -4862,6 +5113,14 @@ export declare const UserPermissionsApiFp: (configuration?: Configuration) => {
|
|
|
4862
5113
|
* @throws {RequiredError}
|
|
4863
5114
|
*/
|
|
4864
5115
|
listOwnPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUserPermissionsSuccessResponse>>;
|
|
5116
|
+
/**
|
|
5117
|
+
* List the role assignments for the current user in the org
|
|
5118
|
+
* @summary List Own Roles
|
|
5119
|
+
* @param {string} orgId
|
|
5120
|
+
* @param {*} [options] Override http request option.
|
|
5121
|
+
* @throws {RequiredError}
|
|
5122
|
+
*/
|
|
5123
|
+
listOwnRoles(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUserRolesSuccessResponse>>;
|
|
4865
5124
|
/**
|
|
4866
5125
|
* List the available permissions for a given user
|
|
4867
5126
|
* @summary List User Permissions
|
|
@@ -4907,6 +5166,14 @@ export declare const UserPermissionsApiFactory: (configuration?: Configuration,
|
|
|
4907
5166
|
* @throws {RequiredError}
|
|
4908
5167
|
*/
|
|
4909
5168
|
listOwnPermissions(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetUserPermissionsSuccessResponse>;
|
|
5169
|
+
/**
|
|
5170
|
+
* List the role assignments for the current user in the org
|
|
5171
|
+
* @summary List Own Roles
|
|
5172
|
+
* @param {string} orgId
|
|
5173
|
+
* @param {*} [options] Override http request option.
|
|
5174
|
+
* @throws {RequiredError}
|
|
5175
|
+
*/
|
|
5176
|
+
listOwnRoles(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetUserRolesSuccessResponse>;
|
|
4910
5177
|
/**
|
|
4911
5178
|
* List the available permissions for a given user
|
|
4912
5179
|
* @summary List User Permissions
|
|
@@ -4957,6 +5224,15 @@ export declare class UserPermissionsApi extends BaseAPI {
|
|
|
4957
5224
|
* @memberof UserPermissionsApi
|
|
4958
5225
|
*/
|
|
4959
5226
|
listOwnPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any, {}, any>>;
|
|
5227
|
+
/**
|
|
5228
|
+
* List the role assignments for the current user in the org
|
|
5229
|
+
* @summary List Own Roles
|
|
5230
|
+
* @param {string} orgId
|
|
5231
|
+
* @param {*} [options] Override http request option.
|
|
5232
|
+
* @throws {RequiredError}
|
|
5233
|
+
* @memberof UserPermissionsApi
|
|
5234
|
+
*/
|
|
5235
|
+
listOwnRoles(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserRolesSuccessResponse, any, {}, any>>;
|
|
4960
5236
|
/**
|
|
4961
5237
|
* List the available permissions for a given user
|
|
4962
5238
|
* @summary List User Permissions
|