@tapis/tapis-typescript-sk 0.0.2 → 0.0.3
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 +16 -6
- package/.openapi-generator/VERSION +1 -1
- package/README.md +5 -4
- package/dist/apis/AdminApi.d.ts +26 -0
- package/dist/apis/AdminApi.js +128 -0
- package/dist/apis/GeneralApi.d.ts +25 -16
- package/dist/apis/GeneralApi.js +72 -23
- package/dist/apis/RoleApi.d.ts +99 -76
- package/dist/apis/RoleApi.js +540 -340
- package/dist/apis/ShareApi.d.ts +110 -0
- package/dist/apis/ShareApi.js +469 -0
- package/dist/apis/UserApi.d.ts +84 -126
- package/dist/apis/UserApi.js +467 -538
- package/dist/apis/VaultApi.d.ts +52 -49
- package/dist/apis/VaultApi.js +413 -341
- package/dist/apis/index.d.ts +2 -0
- package/dist/apis/index.js +20 -7
- package/dist/index.d.ts +2 -2
- package/dist/index.js +17 -6
- package/dist/models/Options.d.ts +8 -3
- package/dist/models/Options.js +23 -15
- package/dist/models/ReqAddChildRole.d.ts +11 -6
- package/dist/models/ReqAddChildRole.js +33 -19
- package/dist/models/ReqAddRolePermission.d.ts +18 -6
- package/dist/models/ReqAddRolePermission.js +36 -19
- package/dist/models/ReqCreateRole.d.ts +18 -6
- package/dist/models/ReqCreateRole.js +36 -19
- package/dist/models/ReqGrantRole.d.ts +51 -0
- package/dist/models/ReqGrantRole.js +62 -0
- package/dist/models/ReqGrantRoleWithPermission.d.ts +57 -0
- package/dist/models/ReqGrantRoleWithPermission.js +66 -0
- package/dist/models/ReqGrantUserPermission.d.ts +11 -6
- package/dist/models/ReqGrantUserPermission.js +33 -19
- package/dist/models/ReqPreviewPathPrefix.d.ts +19 -7
- package/dist/models/ReqPreviewPathPrefix.js +46 -27
- package/dist/models/ReqRemoveChildRole.d.ts +11 -6
- package/dist/models/ReqRemoveChildRole.js +33 -19
- package/dist/models/ReqRemovePermissionFromAllRoles.d.ts +38 -0
- package/dist/models/ReqRemovePermissionFromAllRoles.js +55 -0
- package/dist/models/ReqRemoveRolePermission.d.ts +18 -6
- package/dist/models/ReqRemoveRolePermission.js +36 -19
- package/dist/models/ReqReplacePathPrefix.d.ts +19 -7
- package/dist/models/ReqReplacePathPrefix.js +46 -27
- package/dist/models/ReqRevokeRole.d.ts +51 -0
- package/dist/models/ReqRevokeRole.js +62 -0
- package/dist/models/ReqRevokeUserPermission.d.ts +11 -6
- package/dist/models/ReqRevokeUserPermission.js +33 -19
- package/dist/models/ReqRolePermits.d.ts +45 -0
- package/dist/models/ReqRolePermits.js +60 -0
- package/dist/models/ReqShareResource.d.ts +68 -0
- package/dist/models/ReqShareResource.js +73 -0
- package/dist/models/ReqUpdateRoleDescription.d.ts +17 -5
- package/dist/models/ReqUpdateRoleDescription.js +32 -17
- package/dist/models/ReqUpdateRoleName.d.ts +17 -5
- package/dist/models/ReqUpdateRoleName.js +32 -17
- package/dist/models/ReqUpdateRoleOwner.d.ts +17 -5
- package/dist/models/ReqUpdateRoleOwner.js +34 -19
- package/dist/models/ReqUserHasRole.d.ts +18 -6
- package/dist/models/ReqUserHasRole.js +38 -21
- package/dist/models/ReqUserHasRoleMulti.d.ts +11 -6
- package/dist/models/ReqUserHasRoleMulti.js +35 -21
- package/dist/models/ReqUserIsAdmin.d.ts +10 -5
- package/dist/models/ReqUserIsAdmin.js +29 -17
- package/dist/models/ReqUserIsPermitted.d.ts +11 -6
- package/dist/models/ReqUserIsPermitted.js +35 -21
- package/dist/models/ReqUserIsPermittedMulti.d.ts +11 -6
- package/dist/models/ReqUserIsPermittedMulti.js +35 -21
- package/dist/models/ReqValidatePwd.d.ts +44 -0
- package/dist/models/ReqValidatePwd.js +59 -0
- package/dist/models/ReqVersions.d.ts +11 -6
- package/dist/models/ReqVersions.js +33 -19
- package/dist/models/ReqWriteSecret.d.ts +12 -7
- package/dist/models/ReqWriteSecret.js +36 -22
- package/dist/models/RespAuthorized.d.ts +27 -4
- package/dist/models/RespAuthorized.js +36 -22
- package/dist/models/RespBasic.d.ts +26 -3
- package/dist/models/RespBasic.js +35 -21
- package/dist/models/RespBoolean.d.ts +69 -0
- package/dist/models/RespBoolean.js +62 -0
- package/dist/models/RespChangeCount.d.ts +27 -4
- package/dist/models/RespChangeCount.js +36 -22
- package/dist/models/RespName.d.ts +27 -4
- package/dist/models/RespName.js +36 -22
- package/dist/models/RespNameArray.d.ts +27 -4
- package/dist/models/RespNameArray.js +36 -22
- package/dist/models/RespPathPrefixes.d.ts +27 -4
- package/dist/models/RespPathPrefixes.js +36 -22
- package/dist/models/RespProbe.d.ts +27 -4
- package/dist/models/RespProbe.js +36 -22
- package/dist/models/RespResourceUrl.d.ts +27 -4
- package/dist/models/RespResourceUrl.js +36 -22
- package/dist/models/RespRole.d.ts +27 -4
- package/dist/models/RespRole.js +36 -22
- package/dist/models/RespSecret.d.ts +27 -4
- package/dist/models/RespSecret.js +36 -22
- package/dist/models/RespSecretList.d.ts +27 -4
- package/dist/models/RespSecretList.js +36 -22
- package/dist/models/RespSecretMeta.d.ts +27 -4
- package/dist/models/RespSecretMeta.js +36 -22
- package/dist/models/RespSecretVersionMetadata.d.ts +27 -4
- package/dist/models/RespSecretVersionMetadata.js +36 -22
- package/dist/models/RespShare.d.ts +69 -0
- package/dist/models/RespShare.js +62 -0
- package/dist/models/RespShareList.d.ts +69 -0
- package/dist/models/RespShareList.js +62 -0
- package/dist/models/RespVersions.d.ts +26 -3
- package/dist/models/RespVersions.js +35 -21
- package/dist/models/ResultAuthorized.d.ts +8 -3
- package/dist/models/ResultAuthorized.js +23 -15
- package/dist/models/ResultBoolean.d.ts +32 -0
- package/dist/models/ResultBoolean.js +49 -0
- package/dist/models/ResultChangeCount.d.ts +8 -3
- package/dist/models/ResultChangeCount.js +23 -15
- package/dist/models/ResultName.d.ts +8 -3
- package/dist/models/ResultName.js +23 -15
- package/dist/models/ResultNameArray.d.ts +8 -3
- package/dist/models/ResultNameArray.js +23 -15
- package/dist/models/ResultResourceUrl.d.ts +8 -3
- package/dist/models/ResultResourceUrl.js +23 -15
- package/dist/models/RoleTypeEnum.d.ts +28 -0
- package/dist/models/RoleTypeEnum.js +54 -0
- package/dist/models/SkProbe.d.ts +8 -21
- package/dist/models/SkProbe.js +23 -21
- package/dist/models/SkRole.d.ts +19 -7
- package/dist/models/SkRole.js +48 -37
- package/dist/models/SkSecret.d.ts +9 -4
- package/dist/models/SkSecret.js +26 -18
- package/dist/models/SkSecretList.d.ts +8 -3
- package/dist/models/SkSecretList.js +25 -17
- package/dist/models/SkSecretMetadata.d.ts +8 -3
- package/dist/models/SkSecretMetadata.js +29 -21
- package/dist/models/SkSecretVersion.d.ts +8 -3
- package/dist/models/SkSecretVersion.js +29 -21
- package/dist/models/SkSecretVersionMetadata.d.ts +9 -4
- package/dist/models/SkSecretVersionMetadata.js +34 -26
- package/dist/models/SkShare.d.ts +92 -0
- package/dist/models/SkShare.js +69 -0
- package/dist/models/SkShareList.d.ts +33 -0
- package/dist/models/SkShareList.js +50 -0
- package/dist/models/Transformation.d.ts +8 -3
- package/dist/models/Transformation.js +27 -19
- package/dist/models/index.d.ts +14 -6
- package/dist/models/index.js +75 -56
- package/dist/runtime.d.ts +80 -38
- package/dist/runtime.js +313 -171
- package/package.json +6 -2
- package/src/apis/AdminApi.ts +63 -0
- package/src/apis/GeneralApi.ts +48 -24
- package/src/apis/RoleApi.ts +374 -220
- package/src/apis/ShareApi.ts +418 -0
- package/src/apis/UserApi.ts +258 -383
- package/src/apis/VaultApi.ts +347 -275
- package/src/apis/index.ts +2 -0
- package/src/index.ts +2 -2
- package/src/models/Options.ts +21 -12
- package/src/models/ReqAddChildRole.ts +31 -19
- package/src/models/ReqAddRolePermission.ts +49 -19
- package/src/models/ReqCreateRole.ts +49 -19
- package/src/models/ReqGrantRole.ts +102 -0
- package/src/models/ReqGrantRoleWithPermission.ts +111 -0
- package/src/models/ReqGrantUserPermission.ts +31 -19
- package/src/models/ReqPreviewPathPrefix.ts +59 -28
- package/src/models/ReqRemoveChildRole.ts +31 -19
- package/src/models/ReqRemovePermissionFromAllRoles.ts +75 -0
- package/src/models/ReqRemoveRolePermission.ts +49 -19
- package/src/models/ReqReplacePathPrefix.ts +59 -28
- package/src/models/ReqRevokeRole.ts +102 -0
- package/src/models/ReqRevokeUserPermission.ts +31 -19
- package/src/models/ReqRolePermits.ts +94 -0
- package/src/models/ReqShareResource.ts +119 -0
- package/src/models/ReqUpdateRoleDescription.ts +45 -16
- package/src/models/ReqUpdateRoleName.ts +45 -16
- package/src/models/ReqUpdateRoleOwner.ts +47 -18
- package/src/models/ReqUserHasRole.ts +51 -21
- package/src/models/ReqUserHasRoleMulti.ts +33 -21
- package/src/models/ReqUserIsAdmin.ts +27 -16
- package/src/models/ReqUserIsPermitted.ts +33 -21
- package/src/models/ReqUserIsPermittedMulti.ts +33 -21
- package/src/models/ReqValidatePwd.ts +84 -0
- package/src/models/ReqVersions.ts +31 -19
- package/src/models/ReqWriteSecret.ts +36 -23
- package/src/models/RespAuthorized.ts +54 -20
- package/src/models/RespBasic.ts +51 -18
- package/src/models/RespBoolean.ts +121 -0
- package/src/models/RespChangeCount.ts +54 -20
- package/src/models/RespName.ts +54 -20
- package/src/models/RespNameArray.ts +54 -20
- package/src/models/RespPathPrefixes.ts +54 -20
- package/src/models/RespProbe.ts +54 -20
- package/src/models/RespResourceUrl.ts +54 -20
- package/src/models/RespRole.ts +54 -20
- package/src/models/RespSecret.ts +54 -20
- package/src/models/RespSecretList.ts +54 -20
- package/src/models/RespSecretMeta.ts +54 -20
- package/src/models/RespSecretVersionMetadata.ts +54 -20
- package/src/models/RespShare.ts +121 -0
- package/src/models/RespShareList.ts +121 -0
- package/src/models/RespVersions.ts +51 -18
- package/src/models/ResultAuthorized.ts +21 -12
- package/src/models/ResultBoolean.ts +65 -0
- package/src/models/ResultChangeCount.ts +21 -12
- package/src/models/ResultName.ts +21 -12
- package/src/models/ResultNameArray.ts +21 -12
- package/src/models/ResultResourceUrl.ts +21 -12
- package/src/models/RoleTypeEnum.ts +56 -0
- package/src/models/SkProbe.ts +21 -36
- package/src/models/SkRole.ts +65 -38
- package/src/models/SkSecret.ts +26 -16
- package/src/models/SkSecretList.ts +23 -14
- package/src/models/SkSecretMetadata.ts +27 -18
- package/src/models/SkSecretVersion.ts +27 -18
- package/src/models/SkSecretVersionMetadata.ts +34 -24
- package/src/models/SkShare.ts +145 -0
- package/src/models/SkShareList.ts +73 -0
- package/src/models/Transformation.ts +25 -16
- package/src/models/index.ts +14 -6
- package/src/runtime.ts +219 -108
- package/dist/models/ReqGrantAdminRole.d.ts +0 -33
- package/dist/models/ReqGrantAdminRole.js +0 -43
- package/dist/models/ReqGrantUserRole.d.ts +0 -39
- package/dist/models/ReqGrantUserRole.js +0 -45
- package/dist/models/ReqGrantUserRoleWithPermission.d.ts +0 -45
- package/dist/models/ReqGrantUserRoleWithPermission.js +0 -47
- package/dist/models/ReqRevokeAdminRole.d.ts +0 -33
- package/dist/models/ReqRevokeAdminRole.js +0 -43
- package/dist/models/ReqRevokeUserRole.d.ts +0 -39
- package/dist/models/ReqRevokeUserRole.js +0 -45
- package/dist/models/ReqValidateServicePwd.d.ts +0 -39
- package/dist/models/ReqValidateServicePwd.js +0 -45
- package/src/models/ReqGrantAdminRole.ts +0 -64
- package/src/models/ReqGrantUserRole.ts +0 -72
- package/src/models/ReqGrantUserRoleWithPermission.ts +0 -80
- package/src/models/ReqRevokeAdminRole.ts +0 -64
- package/src/models/ReqRevokeUserRole.ts +0 -72
- package/src/models/ReqValidateServicePwd.ts +0 -72
package/dist/apis/UserApi.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Tapis Security API
|
|
3
|
-
* The Tapis Security API provides
|
|
3
|
+
* The Tapis Security API provides for management of Security Kernel (SK) role-based authorization and secrets resources.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 1.8.2
|
|
6
6
|
* Contact: cicsupport@tacc.utexas.edu
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -10,267 +10,225 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import {
|
|
13
|
+
import type { ReqGrantRole, ReqGrantRoleWithPermission, ReqGrantUserPermission, ReqRevokeRole, ReqRevokeUserPermission, ReqUserHasRole, ReqUserHasRoleMulti, ReqUserIsAdmin, ReqUserIsPermitted, ReqUserIsPermittedMulti, RespAuthorized, RespChangeCount, RespName, RespNameArray, RoleTypeEnum } from '../models/index';
|
|
14
14
|
export interface GetAdminsRequest {
|
|
15
15
|
tenant: string;
|
|
16
|
-
pretty?: boolean;
|
|
17
16
|
}
|
|
18
17
|
export interface GetDefaultUserRole1Request {
|
|
19
18
|
user: string;
|
|
20
|
-
pretty?: boolean;
|
|
21
19
|
}
|
|
22
20
|
export interface GetUserNamesRequest {
|
|
23
21
|
tenant?: string;
|
|
24
|
-
pretty?: boolean;
|
|
25
22
|
}
|
|
26
23
|
export interface GetUserPermsRequest {
|
|
27
24
|
user: string;
|
|
28
25
|
tenant?: string;
|
|
29
26
|
implies?: string;
|
|
30
27
|
impliedBy?: string;
|
|
31
|
-
pretty?: boolean;
|
|
32
28
|
}
|
|
33
29
|
export interface GetUserRolesRequest {
|
|
34
30
|
user: string;
|
|
35
31
|
tenant?: string;
|
|
36
|
-
pretty?: boolean;
|
|
37
32
|
}
|
|
38
33
|
export interface GetUsersWithPermissionRequest {
|
|
39
34
|
permSpec: string;
|
|
40
35
|
tenant?: string;
|
|
41
|
-
pretty?: boolean;
|
|
42
36
|
}
|
|
43
37
|
export interface GetUsersWithRoleRequest {
|
|
44
38
|
roleName: string;
|
|
45
39
|
tenant?: string;
|
|
46
|
-
|
|
47
|
-
}
|
|
48
|
-
export interface GrantAdminRoleRequest {
|
|
49
|
-
reqGrantAdminRole: ReqGrantAdminRole;
|
|
50
|
-
pretty?: boolean;
|
|
40
|
+
roleType?: RoleTypeEnum;
|
|
51
41
|
}
|
|
52
42
|
export interface GrantRoleRequest {
|
|
53
|
-
|
|
54
|
-
pretty?: boolean;
|
|
43
|
+
reqGrantRole: ReqGrantRole;
|
|
55
44
|
}
|
|
56
45
|
export interface GrantRoleWithPermissionRequest {
|
|
57
|
-
|
|
58
|
-
pretty?: boolean;
|
|
46
|
+
reqGrantRoleWithPermission: ReqGrantRoleWithPermission;
|
|
59
47
|
}
|
|
60
48
|
export interface GrantUserPermissionRequest {
|
|
61
49
|
reqGrantUserPermission: ReqGrantUserPermission;
|
|
62
|
-
pretty?: boolean;
|
|
63
50
|
}
|
|
64
51
|
export interface HasRoleRequest {
|
|
65
52
|
reqUserHasRole: ReqUserHasRole;
|
|
66
|
-
pretty?: boolean;
|
|
67
53
|
}
|
|
68
54
|
export interface HasRoleAllRequest {
|
|
69
55
|
reqUserHasRoleMulti: ReqUserHasRoleMulti;
|
|
70
|
-
pretty?: boolean;
|
|
71
56
|
}
|
|
72
57
|
export interface HasRoleAnyRequest {
|
|
73
58
|
reqUserHasRoleMulti: ReqUserHasRoleMulti;
|
|
74
|
-
pretty?: boolean;
|
|
75
59
|
}
|
|
76
60
|
export interface IsAdminRequest {
|
|
77
61
|
reqUserIsAdmin: ReqUserIsAdmin;
|
|
78
|
-
pretty?: boolean;
|
|
79
62
|
}
|
|
80
63
|
export interface IsPermittedRequest {
|
|
81
64
|
reqUserIsPermitted: ReqUserIsPermitted;
|
|
82
|
-
pretty?: boolean;
|
|
83
65
|
}
|
|
84
66
|
export interface IsPermittedAllRequest {
|
|
85
67
|
reqUserIsPermittedMulti: ReqUserIsPermittedMulti;
|
|
86
|
-
pretty?: boolean;
|
|
87
68
|
}
|
|
88
69
|
export interface IsPermittedAnyRequest {
|
|
89
70
|
reqUserIsPermittedMulti: ReqUserIsPermittedMulti;
|
|
90
|
-
pretty?: boolean;
|
|
91
71
|
}
|
|
92
|
-
export interface
|
|
93
|
-
|
|
94
|
-
pretty?: boolean;
|
|
72
|
+
export interface RevokeRoleRequest {
|
|
73
|
+
reqRevokeRole: ReqRevokeRole;
|
|
95
74
|
}
|
|
96
75
|
export interface RevokeUserPermissionRequest {
|
|
97
76
|
reqRevokeUserPermission: ReqRevokeUserPermission;
|
|
98
|
-
pretty?: boolean;
|
|
99
|
-
}
|
|
100
|
-
export interface RevokeUserRoleRequest {
|
|
101
|
-
reqRevokeUserRole: ReqRevokeUserRole;
|
|
102
|
-
pretty?: boolean;
|
|
103
77
|
}
|
|
104
78
|
/**
|
|
105
79
|
*
|
|
106
80
|
*/
|
|
107
81
|
export declare class UserApi extends runtime.BaseAPI {
|
|
108
82
|
/**
|
|
109
|
-
* Get all users assigned the tenant administrator role ($!tenant_admin). This request is authorized if the requestor is a user that has access to the specified tenant
|
|
110
|
-
*/
|
|
111
|
-
getAdminsRaw(requestParameters: GetAdminsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespNameArray>>;
|
|
112
|
-
/**
|
|
113
|
-
* Get all users assigned the tenant administrator role ($!tenant_admin). This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
|
|
114
|
-
*/
|
|
115
|
-
getAdmins(requestParameters: GetAdminsRequest, initOverrides?: RequestInit): Promise<RespNameArray>;
|
|
116
|
-
/**
|
|
117
|
-
* Get a user\'s default role. The default role is implicitly created by the system when needed if it doesn\'t already exist. No authorization required. A user\'s default role is constructed by prepending \'$$\' to the user\'s name. This implies the maximum length of a user name is 58 since role names are limited to 60 characters.
|
|
118
|
-
*/
|
|
119
|
-
getDefaultUserRole1Raw(requestParameters: GetDefaultUserRole1Request, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespName>>;
|
|
120
|
-
/**
|
|
121
|
-
* Get a user\'s default role. The default role is implicitly created by the system when needed if it doesn\'t already exist. No authorization required. A user\'s default role is constructed by prepending \'$$\' to the user\'s name. This implies the maximum length of a user name is 58 since role names are limited to 60 characters.
|
|
122
|
-
*/
|
|
123
|
-
getDefaultUserRole1(requestParameters: GetDefaultUserRole1Request, initOverrides?: RequestInit): Promise<RespName>;
|
|
124
|
-
/**
|
|
125
|
-
* Get the names of all users in the tenant that have been granted a role or permission. This request is authorized if the requestor is a user that has access to the specified tenant or if the requestor is a service.
|
|
83
|
+
* Get all users assigned the tenant administrator role ($!tenant_admin). This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
126
84
|
*/
|
|
127
|
-
|
|
85
|
+
getAdminsRaw(requestParameters: GetAdminsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespNameArray>>;
|
|
128
86
|
/**
|
|
129
|
-
* Get
|
|
87
|
+
* Get all users assigned the tenant administrator role ($!tenant_admin). This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
130
88
|
*/
|
|
131
|
-
|
|
89
|
+
getAdmins(requestParameters: GetAdminsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespNameArray>;
|
|
132
90
|
/**
|
|
133
|
-
* Get
|
|
91
|
+
* Get a user\'s default role. The default role is implicitly created by the system when needed if it doesn\'t already exist. No authorization required. A user\'s default role is constructed by prepending \'$$\' to the user\'s name. This implies the maximum length of a user name is 58 since role names are limited to 60 characters.
|
|
134
92
|
*/
|
|
135
|
-
|
|
93
|
+
getDefaultUserRole1Raw(requestParameters: GetDefaultUserRole1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespName>>;
|
|
136
94
|
/**
|
|
137
|
-
* Get
|
|
95
|
+
* Get a user\'s default role. The default role is implicitly created by the system when needed if it doesn\'t already exist. No authorization required. A user\'s default role is constructed by prepending \'$$\' to the user\'s name. This implies the maximum length of a user name is 58 since role names are limited to 60 characters.
|
|
138
96
|
*/
|
|
139
|
-
|
|
97
|
+
getDefaultUserRole1(requestParameters: GetDefaultUserRole1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespName>;
|
|
140
98
|
/**
|
|
141
|
-
* Get the
|
|
99
|
+
* Get the names of all users in the tenant that have been granted a role or permission. This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
142
100
|
*/
|
|
143
|
-
|
|
101
|
+
getUserNamesRaw(requestParameters: GetUserNamesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespNameArray>>;
|
|
144
102
|
/**
|
|
145
|
-
* Get the
|
|
103
|
+
* Get the names of all users in the tenant that have been granted a role or permission. This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
146
104
|
*/
|
|
147
|
-
|
|
105
|
+
getUserNames(requestParameters?: GetUserNamesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespNameArray>;
|
|
148
106
|
/**
|
|
149
|
-
* Get
|
|
107
|
+
* Get the permissions assigned to a user in a tenant, including those assigned transively. The result list can be optionally filtered by the one or both of the query parameters: implies and impliedBy. When implies is set, the filter _implies_ each entry in the result set. When impliedBy is set, each entry in the result set is _implied by_ the filter. Below are some examples. Consider a user that is assigned these permissions: stream:dev:read:project1 stream:dev:read,write:project1 stream:dev:read,write,exec:project1 **Using the *implies* Query Parameter** When _implies=stream:dev:*:project1_, this endpoint returns: stream:dev:read:project1 stream:dev:read,write:project1 stream:dev:read,write,exec:project1 When _implies=stream:dev:write:project1_, this endpoint returns an empty list. **Using the *impliedBy* Query Parameter** When _impliedBy=stream:dev:*:project1_, this endpoint returns an empty list. When _impliedBy=stream:dev:write:project1_, this endpoint returns: stream:dev:read,write:project1 stream:dev:read,write,exec:project1 This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
150
108
|
*/
|
|
151
|
-
|
|
109
|
+
getUserPermsRaw(requestParameters: GetUserPermsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespNameArray>>;
|
|
152
110
|
/**
|
|
153
|
-
* Get
|
|
111
|
+
* Get the permissions assigned to a user in a tenant, including those assigned transively. The result list can be optionally filtered by the one or both of the query parameters: implies and impliedBy. When implies is set, the filter _implies_ each entry in the result set. When impliedBy is set, each entry in the result set is _implied by_ the filter. Below are some examples. Consider a user that is assigned these permissions: stream:dev:read:project1 stream:dev:read,write:project1 stream:dev:read,write,exec:project1 **Using the *implies* Query Parameter** When _implies=stream:dev:*:project1_, this endpoint returns: stream:dev:read:project1 stream:dev:read,write:project1 stream:dev:read,write,exec:project1 When _implies=stream:dev:write:project1_, this endpoint returns an empty list. **Using the *impliedBy* Query Parameter** When _impliedBy=stream:dev:*:project1_, this endpoint returns an empty list. When _impliedBy=stream:dev:write:project1_, this endpoint returns: stream:dev:read,write:project1 stream:dev:read,write,exec:project1 This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
154
112
|
*/
|
|
155
|
-
|
|
113
|
+
getUserPerms(requestParameters: GetUserPermsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespNameArray>;
|
|
156
114
|
/**
|
|
157
|
-
* Get
|
|
115
|
+
* Get the roles assigned to a user in the specified tenant, including those assigned transively. This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
158
116
|
*/
|
|
159
|
-
|
|
117
|
+
getUserRolesRaw(requestParameters: GetUserRolesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespNameArray>>;
|
|
160
118
|
/**
|
|
161
|
-
* Get
|
|
119
|
+
* Get the roles assigned to a user in the specified tenant, including those assigned transively. This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
162
120
|
*/
|
|
163
|
-
|
|
121
|
+
getUserRoles(requestParameters: GetUserRolesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespNameArray>;
|
|
164
122
|
/**
|
|
165
|
-
*
|
|
123
|
+
* Get all users in a tenant assigned a permission. The permSpec parameter is a permission specification that uses colons as separators, the asterisk as a wildcard character and commas to define lists. Here are examples of permission specifications: system:mytenant:read:mysystem system:mytenant:*:mysystem system:mytenant files:mytenant:read,write:mysystems This method recognizes the percent sign (%) as a string wildcard only in the context of database searching. If a percent sign (%) appears in the permSpec it is interpreted as a zero or more character wildcard. For example, the following specification would match the first three of the above example specifications but not the fourth: system:mytenant:% The wildcard character cannot appear as the first character in the permSpec. This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
166
124
|
*/
|
|
167
|
-
|
|
125
|
+
getUsersWithPermissionRaw(requestParameters: GetUsersWithPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespNameArray>>;
|
|
168
126
|
/**
|
|
169
|
-
*
|
|
127
|
+
* Get all users in a tenant assigned a permission. The permSpec parameter is a permission specification that uses colons as separators, the asterisk as a wildcard character and commas to define lists. Here are examples of permission specifications: system:mytenant:read:mysystem system:mytenant:*:mysystem system:mytenant files:mytenant:read,write:mysystems This method recognizes the percent sign (%) as a string wildcard only in the context of database searching. If a percent sign (%) appears in the permSpec it is interpreted as a zero or more character wildcard. For example, the following specification would match the first three of the above example specifications but not the fourth: system:mytenant:% The wildcard character cannot appear as the first character in the permSpec. This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
170
128
|
*/
|
|
171
|
-
|
|
129
|
+
getUsersWithPermission(requestParameters: GetUsersWithPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespNameArray>;
|
|
172
130
|
/**
|
|
173
|
-
*
|
|
131
|
+
* Get all users assigned a role. The role must exist in the tenant. This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
174
132
|
*/
|
|
175
|
-
|
|
133
|
+
getUsersWithRoleRaw(requestParameters: GetUsersWithRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespNameArray>>;
|
|
176
134
|
/**
|
|
177
|
-
*
|
|
135
|
+
* Get all users assigned a role. The role must exist in the tenant. This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
178
136
|
*/
|
|
179
|
-
|
|
137
|
+
getUsersWithRole(requestParameters: GetUsersWithRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespNameArray>;
|
|
180
138
|
/**
|
|
181
|
-
* Grant a user the specified role
|
|
139
|
+
* Grant a user the specified role. A valid tenant and user must be specified in the request body. The type of role to grant may be specified in the request body. Allowed types are USER, TENANT_ADMIN and RESTRICTED_SVC. Default type is USER. The user and the role must be in the same tenant. For roles of type USER the request is authorized only if the requestor is the role owner, a tenant administrator or a site administrator. For roles of type TENANT_ADMIN the requestor must a tenant or site administrator. For roles of type RESTRICTED_SVC the requestor must a site administrator.
|
|
182
140
|
*/
|
|
183
|
-
|
|
141
|
+
grantRoleRaw(requestParameters: GrantRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
184
142
|
/**
|
|
185
|
-
* Grant a user the specified role
|
|
143
|
+
* Grant a user the specified role. A valid tenant and user must be specified in the request body. The type of role to grant may be specified in the request body. Allowed types are USER, TENANT_ADMIN and RESTRICTED_SVC. Default type is USER. The user and the role must be in the same tenant. For roles of type USER the request is authorized only if the requestor is the role owner, a tenant administrator or a site administrator. For roles of type TENANT_ADMIN the requestor must a tenant or site administrator. For roles of type RESTRICTED_SVC the requestor must a site administrator.
|
|
186
144
|
*/
|
|
187
|
-
|
|
145
|
+
grantRole(requestParameters: GrantRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespChangeCount>;
|
|
188
146
|
/**
|
|
189
|
-
* Grant a user the specified
|
|
147
|
+
* Grant a user the specified role containing the specified permission. This compound request first adds the permission to the role if it is not already a member of the role and then assigns the role to the user. The change count returned can range from zero to two depending on how many insertions were actually required. The user and the role must be in the same tenant. For roles of type USER the request is authorized only if the requestor is the role owner, a tenant administrator or a site administrator. For roles of type TENANT_ADMIN the requestor must a tenant or site administrator. For roles of type RESTRICTED_SVC the requestor must a site administrator.
|
|
190
148
|
*/
|
|
191
|
-
|
|
149
|
+
grantRoleWithPermissionRaw(requestParameters: GrantRoleWithPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
192
150
|
/**
|
|
193
|
-
* Grant a user the specified
|
|
151
|
+
* Grant a user the specified role containing the specified permission. This compound request first adds the permission to the role if it is not already a member of the role and then assigns the role to the user. The change count returned can range from zero to two depending on how many insertions were actually required. The user and the role must be in the same tenant. For roles of type USER the request is authorized only if the requestor is the role owner, a tenant administrator or a site administrator. For roles of type TENANT_ADMIN the requestor must a tenant or site administrator. For roles of type RESTRICTED_SVC the requestor must a site administrator.
|
|
194
152
|
*/
|
|
195
|
-
|
|
153
|
+
grantRoleWithPermission(requestParameters: GrantRoleWithPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespChangeCount>;
|
|
196
154
|
/**
|
|
197
|
-
*
|
|
155
|
+
* Grant a user the specified permission by assigning that permission to to the user\'s default role. If the user\'s default role does not exist it will be created. A user\'s default role name is discoverable by calling either of the user/defaultRole or role/defaultRole endpoints. The change count returned can range from zero to three depending on how many insertions and updates were actually required. The caller must be an administrator or service allowed to perform updates in the user\'s tenant.
|
|
198
156
|
*/
|
|
199
|
-
|
|
157
|
+
grantUserPermissionRaw(requestParameters: GrantUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
200
158
|
/**
|
|
201
|
-
*
|
|
159
|
+
* Grant a user the specified permission by assigning that permission to to the user\'s default role. If the user\'s default role does not exist it will be created. A user\'s default role name is discoverable by calling either of the user/defaultRole or role/defaultRole endpoints. The change count returned can range from zero to three depending on how many insertions and updates were actually required. The caller must be an administrator or service allowed to perform updates in the user\'s tenant.
|
|
202
160
|
*/
|
|
203
|
-
|
|
161
|
+
grantUserPermission(requestParameters: GrantUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespChangeCount>;
|
|
204
162
|
/**
|
|
205
|
-
* Check whether a user in a tenant has been assigned
|
|
163
|
+
* Check whether a user in a tenant has been assigned the specified role, either directly or transitively. This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
206
164
|
*/
|
|
207
|
-
|
|
165
|
+
hasRoleRaw(requestParameters: HasRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespAuthorized>>;
|
|
208
166
|
/**
|
|
209
|
-
* Check whether a user in a tenant has been assigned
|
|
167
|
+
* Check whether a user in a tenant has been assigned the specified role, either directly or transitively. This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
210
168
|
*/
|
|
211
|
-
|
|
169
|
+
hasRole(requestParameters: HasRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespAuthorized>;
|
|
212
170
|
/**
|
|
213
|
-
* Check whether a user in a tenant has been assigned
|
|
171
|
+
* Check whether a user in a tenant has been assigned all of the roles specified in the request body. This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
214
172
|
*/
|
|
215
|
-
|
|
173
|
+
hasRoleAllRaw(requestParameters: HasRoleAllRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespAuthorized>>;
|
|
216
174
|
/**
|
|
217
|
-
* Check whether a user in a tenant has been assigned
|
|
175
|
+
* Check whether a user in a tenant has been assigned all of the roles specified in the request body. This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
218
176
|
*/
|
|
219
|
-
|
|
177
|
+
hasRoleAll(requestParameters: HasRoleAllRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespAuthorized>;
|
|
220
178
|
/**
|
|
221
|
-
* Check whether a user in a tenant has been assigned the
|
|
179
|
+
* Check whether a user in a tenant has been assigned any of the roles specified in the request body. This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
222
180
|
*/
|
|
223
|
-
|
|
181
|
+
hasRoleAnyRaw(requestParameters: HasRoleAnyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespAuthorized>>;
|
|
224
182
|
/**
|
|
225
|
-
* Check whether a user in a tenant has been assigned the
|
|
183
|
+
* Check whether a user in a tenant has been assigned any of the roles specified in the request body. This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
226
184
|
*/
|
|
227
|
-
|
|
185
|
+
hasRoleAny(requestParameters: HasRoleAnyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespAuthorized>;
|
|
228
186
|
/**
|
|
229
|
-
* Check whether
|
|
187
|
+
* Check whether a user in a tenant has been assigned the tenant administrator role, either directly or transitively. This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
230
188
|
*/
|
|
231
|
-
|
|
189
|
+
isAdminRaw(requestParameters: IsAdminRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespAuthorized>>;
|
|
232
190
|
/**
|
|
233
|
-
* Check whether
|
|
191
|
+
* Check whether a user in a tenant has been assigned the tenant administrator role, either directly or transitively. This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
234
192
|
*/
|
|
235
|
-
|
|
193
|
+
isAdmin(requestParameters: IsAdminRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespAuthorized>;
|
|
236
194
|
/**
|
|
237
|
-
* Check whether
|
|
195
|
+
* Check whether specified permission matches a permission assigned to the user, either directly or transitively. This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
238
196
|
*/
|
|
239
|
-
|
|
197
|
+
isPermittedRaw(requestParameters: IsPermittedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespAuthorized>>;
|
|
240
198
|
/**
|
|
241
|
-
* Check whether
|
|
199
|
+
* Check whether specified permission matches a permission assigned to the user, either directly or transitively. This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
242
200
|
*/
|
|
243
|
-
|
|
201
|
+
isPermitted(requestParameters: IsPermittedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespAuthorized>;
|
|
244
202
|
/**
|
|
245
|
-
* Check whether a user\'s permissions satisfy
|
|
203
|
+
* Check whether a user\'s permissions satisfy all of the permission specifications contained in the request body. This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
246
204
|
*/
|
|
247
|
-
|
|
205
|
+
isPermittedAllRaw(requestParameters: IsPermittedAllRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespAuthorized>>;
|
|
248
206
|
/**
|
|
249
|
-
* Check whether a user\'s permissions satisfy
|
|
207
|
+
* Check whether a user\'s permissions satisfy all of the permission specifications contained in the request body. This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
250
208
|
*/
|
|
251
|
-
|
|
209
|
+
isPermittedAll(requestParameters: IsPermittedAllRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespAuthorized>;
|
|
252
210
|
/**
|
|
253
|
-
*
|
|
211
|
+
* Check whether a user\'s permissions satisfy any of the permission specifications contained in the request body. This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
254
212
|
*/
|
|
255
|
-
|
|
213
|
+
isPermittedAnyRaw(requestParameters: IsPermittedAnyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespAuthorized>>;
|
|
256
214
|
/**
|
|
257
|
-
*
|
|
215
|
+
* Check whether a user\'s permissions satisfy any of the permission specifications contained in the request body. This request is authorized if the requestor is a service or a user that has access to the specified tenant.
|
|
258
216
|
*/
|
|
259
|
-
|
|
217
|
+
isPermittedAny(requestParameters: IsPermittedAnyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespAuthorized>;
|
|
260
218
|
/**
|
|
261
|
-
* Revoke
|
|
219
|
+
* Revoke a previously granted role from a user. No action is taken if the user is not currently assigned the role. This request is idempotent. The type of role to grant may be specified in the request body. Allowed types are USER, TENANT_ADMIN and RESTRICTED_SVC. Default type is USER. The user and the role must be in the same tenant. For roles of type USER the request is authorized only if the requestor is the role owner, a tenant administrator or a site administrator. For roles of type TENANT_ADMIN the requestor must a tenant or site administrator. For roles of type RESTRICTED_SVC the requestor must a site administrator.
|
|
262
220
|
*/
|
|
263
|
-
|
|
221
|
+
revokeRoleRaw(requestParameters: RevokeRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
264
222
|
/**
|
|
265
|
-
* Revoke
|
|
223
|
+
* Revoke a previously granted role from a user. No action is taken if the user is not currently assigned the role. This request is idempotent. The type of role to grant may be specified in the request body. Allowed types are USER, TENANT_ADMIN and RESTRICTED_SVC. Default type is USER. The user and the role must be in the same tenant. For roles of type USER the request is authorized only if the requestor is the role owner, a tenant administrator or a site administrator. For roles of type TENANT_ADMIN the requestor must a tenant or site administrator. For roles of type RESTRICTED_SVC the requestor must a site administrator.
|
|
266
224
|
*/
|
|
267
|
-
|
|
225
|
+
revokeRole(requestParameters: RevokeRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespChangeCount>;
|
|
268
226
|
/**
|
|
269
|
-
* Revoke
|
|
227
|
+
* Revoke the specified permission from the user\'s default role. A user\'s default role is constructed by prepending \'$$\' to the user\'s name. Default roles are created on demand. If the role does not exist when this method is called no error is reported and no changes occur. The change count returned can be zero or one depending on how many permissions were revoked. A valid tenant and user must be specified in the request body. The caller must be an administrator, a service or the user themselves.
|
|
270
228
|
*/
|
|
271
|
-
|
|
229
|
+
revokeUserPermissionRaw(requestParameters: RevokeUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
272
230
|
/**
|
|
273
|
-
* Revoke
|
|
231
|
+
* Revoke the specified permission from the user\'s default role. A user\'s default role is constructed by prepending \'$$\' to the user\'s name. Default roles are created on demand. If the role does not exist when this method is called no error is reported and no changes occur. The change count returned can be zero or one depending on how many permissions were revoked. A valid tenant and user must be specified in the request body. The caller must be an administrator, a service or the user themselves.
|
|
274
232
|
*/
|
|
275
|
-
|
|
233
|
+
revokeUserPermission(requestParameters: RevokeUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespChangeCount>;
|
|
276
234
|
}
|