@tapis/tapis-typescript-systems 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 +18 -3
- package/README.md +2 -2
- package/dist/apis/ChildSystemsApi.d.ts +54 -0
- package/dist/apis/ChildSystemsApi.js +224 -0
- package/dist/apis/CredentialsApi.d.ts +48 -15
- package/dist/apis/CredentialsApi.js +167 -16
- package/dist/apis/GeneralApi.d.ts +5 -5
- package/dist/apis/GeneralApi.js +5 -5
- package/dist/apis/PermissionsApi.d.ts +3 -11
- package/dist/apis/PermissionsApi.js +3 -11
- package/dist/apis/SchedulerProfilesApi.d.ts +5 -13
- package/dist/apis/SchedulerProfilesApi.js +6 -14
- package/dist/apis/SharingApi.d.ts +85 -0
- package/dist/apis/SharingApi.js +328 -0
- package/dist/apis/SystemsApi.d.ts +33 -44
- package/dist/apis/SystemsApi.js +84 -47
- package/dist/apis/index.d.ts +2 -0
- package/dist/apis/index.js +2 -0
- package/dist/models/AuthnEnum.d.ts +2 -1
- package/dist/models/AuthnEnum.js +2 -1
- package/dist/models/Capability.d.ts +1 -1
- package/dist/models/Capability.js +1 -1
- package/dist/models/CategoryEnum.d.ts +1 -1
- package/dist/models/CategoryEnum.js +1 -1
- package/dist/models/Credential.d.ts +19 -1
- package/dist/models/Credential.js +7 -1
- package/dist/models/DatatypeEnum.d.ts +1 -1
- package/dist/models/DatatypeEnum.js +1 -1
- package/dist/models/JobRuntime.d.ts +1 -1
- package/dist/models/JobRuntime.js +1 -1
- package/dist/models/KeyValuePair.d.ts +7 -1
- package/dist/models/KeyValuePair.js +3 -1
- package/dist/models/ListTypeEnum.d.ts +24 -0
- package/dist/models/ListTypeEnum.js +38 -0
- package/dist/models/LogicalQueue.d.ts +1 -1
- package/dist/models/LogicalQueue.js +1 -1
- package/dist/models/ModuleLoadSpec.d.ts +33 -0
- package/dist/models/ModuleLoadSpec.js +43 -0
- package/dist/models/OperationTypeEnum.d.ts +35 -0
- package/dist/models/OperationTypeEnum.js +49 -0
- package/dist/models/ReqMatchConstraints.d.ts +1 -1
- package/dist/models/ReqMatchConstraints.js +1 -1
- package/dist/models/ReqPatchSystem.d.ts +19 -1
- package/dist/models/ReqPatchSystem.js +7 -1
- package/dist/models/ReqPerms.d.ts +1 -1
- package/dist/models/ReqPerms.js +1 -1
- package/dist/models/ReqPostChildSystem.d.ts +39 -0
- package/dist/models/ReqPostChildSystem.js +45 -0
- package/dist/models/ReqPostPutCredential.d.ts +69 -0
- package/dist/models/{ReqCreateCredential.js → ReqPostPutCredential.js} +12 -8
- package/dist/models/ReqPostSchedulerProfile.d.ts +52 -0
- package/dist/models/{ReqCreateSchedulerProfile.js → ReqPostSchedulerProfile.js} +10 -12
- package/dist/models/{ReqCreateSystem.d.ts → ReqPostSystem.d.ts} +55 -43
- package/dist/models/{ReqCreateSystem.js → ReqPostSystem.js} +14 -10
- package/dist/models/ReqPutSystem.d.ts +16 -4
- package/dist/models/ReqPutSystem.js +7 -3
- package/dist/models/ReqSearchSystems.d.ts +1 -1
- package/dist/models/ReqSearchSystems.js +1 -1
- package/dist/models/ReqShareUpdate.d.ts +27 -0
- package/dist/models/ReqShareUpdate.js +40 -0
- package/dist/models/ReqUnlinkChildren.d.ts +27 -0
- package/dist/models/ReqUnlinkChildren.js +41 -0
- package/dist/models/ReqUpdateCredential.d.ts +75 -0
- package/dist/models/ReqUpdateCredential.js +57 -0
- package/dist/models/RespBasic.d.ts +13 -1
- package/dist/models/RespBasic.js +5 -1
- package/dist/models/RespBoolean.d.ts +13 -1
- package/dist/models/RespBoolean.js +5 -1
- package/dist/models/RespChangeCount.d.ts +13 -1
- package/dist/models/RespChangeCount.js +5 -1
- package/dist/models/RespCredential.d.ts +13 -1
- package/dist/models/RespCredential.js +5 -1
- package/dist/models/RespGlobusAuthUrl.d.ts +64 -0
- package/dist/models/RespGlobusAuthUrl.js +54 -0
- package/dist/models/RespNameArray.d.ts +13 -1
- package/dist/models/RespNameArray.js +5 -1
- package/dist/models/RespResourceUrl.d.ts +13 -1
- package/dist/models/RespResourceUrl.js +5 -1
- package/dist/models/RespSchedulerProfile.d.ts +13 -1
- package/dist/models/RespSchedulerProfile.js +5 -1
- package/dist/models/RespSchedulerProfiles.d.ts +13 -1
- package/dist/models/RespSchedulerProfiles.js +5 -1
- package/dist/models/RespShareInfo.d.ts +64 -0
- package/dist/models/RespShareInfo.js +54 -0
- package/dist/models/RespSystem.d.ts +13 -1
- package/dist/models/RespSystem.js +5 -1
- package/dist/models/RespSystemHistory.d.ts +64 -0
- package/dist/models/RespSystemHistory.js +54 -0
- package/dist/models/RespSystems.d.ts +13 -1
- package/dist/models/RespSystems.js +5 -1
- package/dist/models/RespSystemsMetadata.d.ts +1 -1
- package/dist/models/RespSystemsMetadata.js +1 -1
- package/dist/models/ResultBoolean.d.ts +1 -1
- package/dist/models/ResultBoolean.js +1 -1
- package/dist/models/ResultChangeCount.d.ts +1 -1
- package/dist/models/ResultChangeCount.js +1 -1
- package/dist/models/ResultGlobusAuthUrl.d.ts +33 -0
- package/dist/models/ResultGlobusAuthUrl.js +43 -0
- package/dist/models/ResultNameArray.d.ts +1 -1
- package/dist/models/ResultNameArray.js +1 -1
- package/dist/models/ResultResourceUrl.d.ts +1 -1
- package/dist/models/ResultResourceUrl.js +1 -1
- package/dist/models/RuntimeTypeEnum.d.ts +1 -1
- package/dist/models/RuntimeTypeEnum.js +1 -1
- package/dist/models/SchedulerHiddenOptionEnum.d.ts +1 -1
- package/dist/models/SchedulerHiddenOptionEnum.js +1 -1
- package/dist/models/SchedulerProfile.d.ts +4 -10
- package/dist/models/SchedulerProfile.js +3 -5
- package/dist/models/SchedulerTypeEnum.d.ts +1 -1
- package/dist/models/SchedulerTypeEnum.js +1 -1
- package/dist/models/ShareInfo.d.ts +33 -0
- package/dist/models/ShareInfo.js +42 -0
- package/dist/models/SystemHistory.d.ts +64 -0
- package/dist/models/SystemHistory.js +54 -0
- package/dist/models/SystemTypeEnum.d.ts +1 -1
- package/dist/models/SystemTypeEnum.js +1 -1
- package/dist/models/TapisSystem.d.ts +27 -3
- package/dist/models/TapisSystem.js +11 -3
- package/dist/models/index.d.ts +16 -3
- package/dist/models/index.js +16 -3
- package/dist/runtime.d.ts +1 -1
- package/dist/runtime.js +1 -1
- package/package.json +1 -1
- package/src/apis/ChildSystemsApi.ts +171 -0
- package/src/apis/CredentialsApi.ts +152 -20
- package/src/apis/GeneralApi.ts +5 -5
- package/src/apis/PermissionsApi.ts +3 -11
- package/src/apis/SchedulerProfilesApi.ts +10 -18
- package/src/apis/SharingApi.ts +250 -0
- package/src/apis/SystemsApi.ts +99 -53
- package/src/apis/index.ts +2 -0
- package/src/models/AuthnEnum.ts +2 -1
- package/src/models/Capability.ts +1 -1
- package/src/models/CategoryEnum.ts +1 -1
- package/src/models/Credential.ts +25 -1
- package/src/models/DatatypeEnum.ts +1 -1
- package/src/models/JobRuntime.ts +1 -1
- package/src/models/KeyValuePair.ts +9 -1
- package/src/models/ListTypeEnum.ts +37 -0
- package/src/models/LogicalQueue.ts +1 -1
- package/src/models/ModuleLoadSpec.ts +64 -0
- package/src/models/OperationTypeEnum.ts +48 -0
- package/src/models/ReqMatchConstraints.ts +1 -1
- package/src/models/ReqPatchSystem.ts +25 -1
- package/src/models/ReqPerms.ts +1 -1
- package/src/models/ReqPostChildSystem.ts +72 -0
- package/src/models/{ReqCreateCredential.ts → ReqPostPutCredential.ts} +29 -13
- package/src/models/{ReqCreateSchedulerProfile.ts → ReqPostSchedulerProfile.ts} +20 -24
- package/src/models/{ReqCreateSystem.ts → ReqPostSystem.ts} +65 -49
- package/src/models/ReqPutSystem.ts +25 -9
- package/src/models/ReqSearchSystems.ts +1 -1
- package/src/models/ReqShareUpdate.ts +56 -0
- package/src/models/ReqUnlinkChildren.ts +56 -0
- package/src/models/ReqUpdateCredential.ts +120 -0
- package/src/models/RespBasic.ts +17 -1
- package/src/models/RespBoolean.ts +17 -1
- package/src/models/RespChangeCount.ts +17 -1
- package/src/models/RespCredential.ts +17 -1
- package/src/models/RespGlobusAuthUrl.ts +111 -0
- package/src/models/RespNameArray.ts +17 -1
- package/src/models/RespResourceUrl.ts +17 -1
- package/src/models/RespSchedulerProfile.ts +17 -1
- package/src/models/RespSchedulerProfiles.ts +17 -1
- package/src/models/RespShareInfo.ts +111 -0
- package/src/models/RespSystem.ts +17 -1
- package/src/models/RespSystemHistory.ts +111 -0
- package/src/models/RespSystems.ts +17 -1
- package/src/models/RespSystemsMetadata.ts +1 -1
- package/src/models/ResultBoolean.ts +1 -1
- package/src/models/ResultChangeCount.ts +1 -1
- package/src/models/ResultGlobusAuthUrl.ts +64 -0
- package/src/models/ResultNameArray.ts +1 -1
- package/src/models/ResultResourceUrl.ts +1 -1
- package/src/models/RuntimeTypeEnum.ts +1 -1
- package/src/models/SchedulerHiddenOptionEnum.ts +1 -1
- package/src/models/SchedulerProfile.ts +9 -13
- package/src/models/SchedulerTypeEnum.ts +1 -1
- package/src/models/ShareInfo.ts +64 -0
- package/src/models/SystemHistory.ts +111 -0
- package/src/models/SystemTypeEnum.ts +1 -1
- package/src/models/TapisSystem.ts +37 -5
- package/src/models/index.ts +16 -3
- package/src/runtime.ts +1 -1
- package/dist/models/ReqCreateCredential.d.ts +0 -57
- package/dist/models/ReqCreateSchedulerProfile.d.ts +0 -58
package/dist/models/index.js
CHANGED
|
@@ -12,33 +12,46 @@ __export(require("./Credential"));
|
|
|
12
12
|
__export(require("./DatatypeEnum"));
|
|
13
13
|
__export(require("./JobRuntime"));
|
|
14
14
|
__export(require("./KeyValuePair"));
|
|
15
|
+
__export(require("./ListTypeEnum"));
|
|
15
16
|
__export(require("./LogicalQueue"));
|
|
16
|
-
__export(require("./
|
|
17
|
-
__export(require("./
|
|
18
|
-
__export(require("./ReqCreateSystem"));
|
|
17
|
+
__export(require("./ModuleLoadSpec"));
|
|
18
|
+
__export(require("./OperationTypeEnum"));
|
|
19
19
|
__export(require("./ReqMatchConstraints"));
|
|
20
20
|
__export(require("./ReqPatchSystem"));
|
|
21
21
|
__export(require("./ReqPerms"));
|
|
22
|
+
__export(require("./ReqPostChildSystem"));
|
|
23
|
+
__export(require("./ReqPostPutCredential"));
|
|
24
|
+
__export(require("./ReqPostSchedulerProfile"));
|
|
25
|
+
__export(require("./ReqPostSystem"));
|
|
22
26
|
__export(require("./ReqPutSystem"));
|
|
23
27
|
__export(require("./ReqSearchSystems"));
|
|
28
|
+
__export(require("./ReqShareUpdate"));
|
|
29
|
+
__export(require("./ReqUnlinkChildren"));
|
|
30
|
+
__export(require("./ReqUpdateCredential"));
|
|
24
31
|
__export(require("./RespBasic"));
|
|
25
32
|
__export(require("./RespBoolean"));
|
|
26
33
|
__export(require("./RespChangeCount"));
|
|
27
34
|
__export(require("./RespCredential"));
|
|
35
|
+
__export(require("./RespGlobusAuthUrl"));
|
|
28
36
|
__export(require("./RespNameArray"));
|
|
29
37
|
__export(require("./RespResourceUrl"));
|
|
30
38
|
__export(require("./RespSchedulerProfile"));
|
|
31
39
|
__export(require("./RespSchedulerProfiles"));
|
|
40
|
+
__export(require("./RespShareInfo"));
|
|
32
41
|
__export(require("./RespSystem"));
|
|
42
|
+
__export(require("./RespSystemHistory"));
|
|
33
43
|
__export(require("./RespSystems"));
|
|
34
44
|
__export(require("./RespSystemsMetadata"));
|
|
35
45
|
__export(require("./ResultBoolean"));
|
|
36
46
|
__export(require("./ResultChangeCount"));
|
|
47
|
+
__export(require("./ResultGlobusAuthUrl"));
|
|
37
48
|
__export(require("./ResultNameArray"));
|
|
38
49
|
__export(require("./ResultResourceUrl"));
|
|
39
50
|
__export(require("./RuntimeTypeEnum"));
|
|
40
51
|
__export(require("./SchedulerHiddenOptionEnum"));
|
|
41
52
|
__export(require("./SchedulerProfile"));
|
|
42
53
|
__export(require("./SchedulerTypeEnum"));
|
|
54
|
+
__export(require("./ShareInfo"));
|
|
55
|
+
__export(require("./SystemHistory"));
|
|
43
56
|
__export(require("./SystemTypeEnum"));
|
|
44
57
|
__export(require("./TapisSystem"));
|
package/dist/runtime.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Tapis Systems API
|
|
3
3
|
* The Tapis Systems API provides for management of Tapis Systems including permissions, credentials and Scheduler Profiles.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.3
|
|
6
6
|
* Contact: cicsupport@tacc.utexas.edu
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/runtime.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Tapis Systems API
|
|
6
6
|
* The Tapis Systems API provides for management of Tapis Systems including permissions, credentials and Scheduler Profiles.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.3.3
|
|
9
9
|
* Contact: cicsupport@tacc.utexas.edu
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/package.json
CHANGED
|
@@ -0,0 +1,171 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Tapis Systems API
|
|
5
|
+
* The Tapis Systems API provides for management of Tapis Systems including permissions, credentials and Scheduler Profiles.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.3.3
|
|
8
|
+
* Contact: cicsupport@tacc.utexas.edu
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
import * as runtime from '../runtime';
|
|
17
|
+
import {
|
|
18
|
+
ReqPostChildSystem,
|
|
19
|
+
ReqPostChildSystemFromJSON,
|
|
20
|
+
ReqPostChildSystemToJSON,
|
|
21
|
+
ReqUnlinkChildren,
|
|
22
|
+
ReqUnlinkChildrenFromJSON,
|
|
23
|
+
ReqUnlinkChildrenToJSON,
|
|
24
|
+
RespBasic,
|
|
25
|
+
RespBasicFromJSON,
|
|
26
|
+
RespBasicToJSON,
|
|
27
|
+
RespChangeCount,
|
|
28
|
+
RespChangeCountFromJSON,
|
|
29
|
+
RespChangeCountToJSON,
|
|
30
|
+
RespResourceUrl,
|
|
31
|
+
RespResourceUrlFromJSON,
|
|
32
|
+
RespResourceUrlToJSON,
|
|
33
|
+
} from '../models';
|
|
34
|
+
|
|
35
|
+
export interface CreateChildSystemRequest {
|
|
36
|
+
parentId: string;
|
|
37
|
+
reqPostChildSystem: ReqPostChildSystem;
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
export interface UnlinkChildrenRequest {
|
|
41
|
+
parentSystemId: string;
|
|
42
|
+
all?: boolean;
|
|
43
|
+
reqUnlinkChildren?: ReqUnlinkChildren;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
export interface UnlinkFromParentRequest {
|
|
47
|
+
childSystemId: string;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
*
|
|
52
|
+
*/
|
|
53
|
+
export class ChildSystemsApi extends runtime.BaseAPI {
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* Create a child system. The child system gets all of it\'s attributes from it\'s parent except for the following fields: - *id* - *effectiveUserId* - *rootDir* - *owner* The owner will be the user who is creating the system. The caller must have read permission to the parent system.
|
|
57
|
+
*/
|
|
58
|
+
async createChildSystemRaw(requestParameters: CreateChildSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespResourceUrl>> {
|
|
59
|
+
if (requestParameters.parentId === null || requestParameters.parentId === undefined) {
|
|
60
|
+
throw new runtime.RequiredError('parentId','Required parameter requestParameters.parentId was null or undefined when calling createChildSystem.');
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
if (requestParameters.reqPostChildSystem === null || requestParameters.reqPostChildSystem === undefined) {
|
|
64
|
+
throw new runtime.RequiredError('reqPostChildSystem','Required parameter requestParameters.reqPostChildSystem was null or undefined when calling createChildSystem.');
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
const queryParameters: any = {};
|
|
68
|
+
|
|
69
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
70
|
+
|
|
71
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
72
|
+
|
|
73
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
74
|
+
headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
const response = await this.request({
|
|
78
|
+
path: `/v3/systems/{parentId}/createChildSystem`.replace(`{${"parentId"}}`, encodeURIComponent(String(requestParameters.parentId))),
|
|
79
|
+
method: 'POST',
|
|
80
|
+
headers: headerParameters,
|
|
81
|
+
query: queryParameters,
|
|
82
|
+
body: ReqPostChildSystemToJSON(requestParameters.reqPostChildSystem),
|
|
83
|
+
}, initOverrides);
|
|
84
|
+
|
|
85
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => RespResourceUrlFromJSON(jsonValue));
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
/**
|
|
89
|
+
* Create a child system. The child system gets all of it\'s attributes from it\'s parent except for the following fields: - *id* - *effectiveUserId* - *rootDir* - *owner* The owner will be the user who is creating the system. The caller must have read permission to the parent system.
|
|
90
|
+
*/
|
|
91
|
+
async createChildSystem(requestParameters: CreateChildSystemRequest, initOverrides?: RequestInit): Promise<RespResourceUrl> {
|
|
92
|
+
const response = await this.createChildSystemRaw(requestParameters, initOverrides);
|
|
93
|
+
return await response.value();
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
/**
|
|
97
|
+
* Make a child system a standalone system. This will break the connection with it\'s parent, and from this point on, the child system will not be connected to the parent. This is similar to unlinkFromParent, but permissions are required for the parent system rather than the child system. Warning, this cannot be undone.
|
|
98
|
+
*/
|
|
99
|
+
async unlinkChildrenRaw(requestParameters: UnlinkChildrenRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>> {
|
|
100
|
+
if (requestParameters.parentSystemId === null || requestParameters.parentSystemId === undefined) {
|
|
101
|
+
throw new runtime.RequiredError('parentSystemId','Required parameter requestParameters.parentSystemId was null or undefined when calling unlinkChildren.');
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
const queryParameters: any = {};
|
|
105
|
+
|
|
106
|
+
if (requestParameters.all !== undefined) {
|
|
107
|
+
queryParameters['all'] = requestParameters.all;
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
111
|
+
|
|
112
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
113
|
+
|
|
114
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
115
|
+
headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
const response = await this.request({
|
|
119
|
+
path: `/v3/systems/{parentSystemId}/unlinkChildren`.replace(`{${"parentSystemId"}}`, encodeURIComponent(String(requestParameters.parentSystemId))),
|
|
120
|
+
method: 'POST',
|
|
121
|
+
headers: headerParameters,
|
|
122
|
+
query: queryParameters,
|
|
123
|
+
body: ReqUnlinkChildrenToJSON(requestParameters.reqUnlinkChildren),
|
|
124
|
+
}, initOverrides);
|
|
125
|
+
|
|
126
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => RespChangeCountFromJSON(jsonValue));
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
/**
|
|
130
|
+
* Make a child system a standalone system. This will break the connection with it\'s parent, and from this point on, the child system will not be connected to the parent. This is similar to unlinkFromParent, but permissions are required for the parent system rather than the child system. Warning, this cannot be undone.
|
|
131
|
+
*/
|
|
132
|
+
async unlinkChildren(requestParameters: UnlinkChildrenRequest, initOverrides?: RequestInit): Promise<RespChangeCount> {
|
|
133
|
+
const response = await this.unlinkChildrenRaw(requestParameters, initOverrides);
|
|
134
|
+
return await response.value();
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
/**
|
|
138
|
+
* Make a child system a standalone system. This will break the connection with it\'s parent, and from this point on, the child system will not be connected to the parent. Warning, this cannot be undone.
|
|
139
|
+
*/
|
|
140
|
+
async unlinkFromParentRaw(requestParameters: UnlinkFromParentRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>> {
|
|
141
|
+
if (requestParameters.childSystemId === null || requestParameters.childSystemId === undefined) {
|
|
142
|
+
throw new runtime.RequiredError('childSystemId','Required parameter requestParameters.childSystemId was null or undefined when calling unlinkFromParent.');
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
const queryParameters: any = {};
|
|
146
|
+
|
|
147
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
148
|
+
|
|
149
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
150
|
+
headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
const response = await this.request({
|
|
154
|
+
path: `/v3/systems/{childSystemId}/unlinkFromParent`.replace(`{${"childSystemId"}}`, encodeURIComponent(String(requestParameters.childSystemId))),
|
|
155
|
+
method: 'POST',
|
|
156
|
+
headers: headerParameters,
|
|
157
|
+
query: queryParameters,
|
|
158
|
+
}, initOverrides);
|
|
159
|
+
|
|
160
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => RespChangeCountFromJSON(jsonValue));
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
/**
|
|
164
|
+
* Make a child system a standalone system. This will break the connection with it\'s parent, and from this point on, the child system will not be connected to the parent. Warning, this cannot be undone.
|
|
165
|
+
*/
|
|
166
|
+
async unlinkFromParent(requestParameters: UnlinkFromParentRequest, initOverrides?: RequestInit): Promise<RespChangeCount> {
|
|
167
|
+
const response = await this.unlinkFromParentRaw(requestParameters, initOverrides);
|
|
168
|
+
return await response.value();
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
}
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Tapis Systems API
|
|
5
5
|
* The Tapis Systems API provides for management of Tapis Systems including permissions, credentials and Scheduler Profiles.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.3
|
|
8
8
|
* Contact: cicsupport@tacc.utexas.edu
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -15,24 +15,40 @@
|
|
|
15
15
|
|
|
16
16
|
import * as runtime from '../runtime';
|
|
17
17
|
import {
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
18
|
+
ReqUpdateCredential,
|
|
19
|
+
ReqUpdateCredentialFromJSON,
|
|
20
|
+
ReqUpdateCredentialToJSON,
|
|
21
21
|
RespBasic,
|
|
22
22
|
RespBasicFromJSON,
|
|
23
23
|
RespBasicToJSON,
|
|
24
24
|
RespCredential,
|
|
25
25
|
RespCredentialFromJSON,
|
|
26
26
|
RespCredentialToJSON,
|
|
27
|
+
RespGlobusAuthUrl,
|
|
28
|
+
RespGlobusAuthUrlFromJSON,
|
|
29
|
+
RespGlobusAuthUrlToJSON,
|
|
27
30
|
} from '../models';
|
|
28
31
|
|
|
32
|
+
export interface CheckUserCredentialRequest {
|
|
33
|
+
systemId: string;
|
|
34
|
+
userName: string;
|
|
35
|
+
authnMethod?: string;
|
|
36
|
+
}
|
|
37
|
+
|
|
29
38
|
export interface CreateUserCredentialRequest {
|
|
30
39
|
systemId: string;
|
|
31
40
|
userName: string;
|
|
32
|
-
|
|
41
|
+
reqUpdateCredential: ReqUpdateCredential;
|
|
33
42
|
skipCredentialCheck?: boolean;
|
|
34
43
|
}
|
|
35
44
|
|
|
45
|
+
export interface GenerateGlobusTokensRequest {
|
|
46
|
+
systemId: string;
|
|
47
|
+
userName: string;
|
|
48
|
+
authCode: string;
|
|
49
|
+
sessionId: string;
|
|
50
|
+
}
|
|
51
|
+
|
|
36
52
|
export interface GetUserCredentialRequest {
|
|
37
53
|
systemId: string;
|
|
38
54
|
userName: string;
|
|
@@ -50,8 +66,49 @@ export interface RemoveUserCredentialRequest {
|
|
|
50
66
|
export class CredentialsApi extends runtime.BaseAPI {
|
|
51
67
|
|
|
52
68
|
/**
|
|
53
|
-
*
|
|
54
|
-
|
|
69
|
+
* Check user credentials by connecting to the system host. Not supported for all system types. Currently supported for LINUX and S3 type systems. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then *{userName}* is interpreted as a Tapis user and a search is made for credentials associated with *{userName}*. If the *effectiveUserId* for the system is static (i.e. not *${apiUserId}*) then *{userName}* is ignored and a search is made for credentials associated with *effectiveUserId*. Operation is allowed if requester is the system owner or a tenant administrator. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then the operation is allowed if *{userName}* is the Tapis user making the request. Desired authentication method may be specified using query parameter authnMethod=<method>. If not specified then credentials for the system\'s default authentication method are verified.
|
|
70
|
+
*/
|
|
71
|
+
async checkUserCredentialRaw(requestParameters: CheckUserCredentialRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>> {
|
|
72
|
+
if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
|
|
73
|
+
throw new runtime.RequiredError('systemId','Required parameter requestParameters.systemId was null or undefined when calling checkUserCredential.');
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
if (requestParameters.userName === null || requestParameters.userName === undefined) {
|
|
77
|
+
throw new runtime.RequiredError('userName','Required parameter requestParameters.userName was null or undefined when calling checkUserCredential.');
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
const queryParameters: any = {};
|
|
81
|
+
|
|
82
|
+
if (requestParameters.authnMethod !== undefined) {
|
|
83
|
+
queryParameters['authnMethod'] = requestParameters.authnMethod;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
87
|
+
|
|
88
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
89
|
+
headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
const response = await this.request({
|
|
93
|
+
path: `/v3/systems/credential/{systemId}/user/{userName}/check`.replace(`{${"systemId"}}`, encodeURIComponent(String(requestParameters.systemId))).replace(`{${"userName"}}`, encodeURIComponent(String(requestParameters.userName))),
|
|
94
|
+
method: 'POST',
|
|
95
|
+
headers: headerParameters,
|
|
96
|
+
query: queryParameters,
|
|
97
|
+
}, initOverrides);
|
|
98
|
+
|
|
99
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => RespBasicFromJSON(jsonValue));
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
/**
|
|
103
|
+
* Check user credentials by connecting to the system host. Not supported for all system types. Currently supported for LINUX and S3 type systems. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then *{userName}* is interpreted as a Tapis user and a search is made for credentials associated with *{userName}*. If the *effectiveUserId* for the system is static (i.e. not *${apiUserId}*) then *{userName}* is ignored and a search is made for credentials associated with *effectiveUserId*. Operation is allowed if requester is the system owner or a tenant administrator. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then the operation is allowed if *{userName}* is the Tapis user making the request. Desired authentication method may be specified using query parameter authnMethod=<method>. If not specified then credentials for the system\'s default authentication method are verified.
|
|
104
|
+
*/
|
|
105
|
+
async checkUserCredential(requestParameters: CheckUserCredentialRequest, initOverrides?: RequestInit): Promise<RespBasic> {
|
|
106
|
+
const response = await this.checkUserCredentialRaw(requestParameters, initOverrides);
|
|
107
|
+
return await response.value();
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
/**
|
|
111
|
+
* Create or update credentials in the Security Kernel for given system and target *userName* using a request body. Credentials for multiple authentication methods may be provided. The Systems service does not store the secrets in its database, they are persisted in the Security Kernel. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then *{userName}* is interpreted as a Tapis user and the request body may contain the optional attribute *loginUser* which will be used to map the Tapis user to a username to be used when accessing the system. If the login user is not provided then there is no mapping and the Tapis user is always used when accessing the system. If the *effectiveUserId* for the system is static (i.e. not *${apiUserId}*) then *{userName}* is interpreted as the login user to be used when accessing the host. Operation is allowed if requester is the system owner or a tenant administrator. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then the operation is allowed if *{userName}* is the Tapis user making the request. By default credentials for LINUX and S3 type systems are verified. Use query parameter *skipCredentialCheck=true* to bypass initial credential validation.
|
|
55
112
|
*/
|
|
56
113
|
async createUserCredentialRaw(requestParameters: CreateUserCredentialRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>> {
|
|
57
114
|
if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
|
|
@@ -62,8 +119,8 @@ export class CredentialsApi extends runtime.BaseAPI {
|
|
|
62
119
|
throw new runtime.RequiredError('userName','Required parameter requestParameters.userName was null or undefined when calling createUserCredential.');
|
|
63
120
|
}
|
|
64
121
|
|
|
65
|
-
if (requestParameters.
|
|
66
|
-
throw new runtime.RequiredError('
|
|
122
|
+
if (requestParameters.reqUpdateCredential === null || requestParameters.reqUpdateCredential === undefined) {
|
|
123
|
+
throw new runtime.RequiredError('reqUpdateCredential','Required parameter requestParameters.reqUpdateCredential was null or undefined when calling createUserCredential.');
|
|
67
124
|
}
|
|
68
125
|
|
|
69
126
|
const queryParameters: any = {};
|
|
@@ -85,15 +142,14 @@ export class CredentialsApi extends runtime.BaseAPI {
|
|
|
85
142
|
method: 'POST',
|
|
86
143
|
headers: headerParameters,
|
|
87
144
|
query: queryParameters,
|
|
88
|
-
body:
|
|
145
|
+
body: ReqUpdateCredentialToJSON(requestParameters.reqUpdateCredential),
|
|
89
146
|
}, initOverrides);
|
|
90
147
|
|
|
91
148
|
return new runtime.JSONApiResponse(response, (jsonValue) => RespBasicFromJSON(jsonValue));
|
|
92
149
|
}
|
|
93
150
|
|
|
94
151
|
/**
|
|
95
|
-
* Create or update credentials in the Security Kernel for given system and
|
|
96
|
-
* Create or update user credentials for a system and target user
|
|
152
|
+
* Create or update credentials in the Security Kernel for given system and target *userName* using a request body. Credentials for multiple authentication methods may be provided. The Systems service does not store the secrets in its database, they are persisted in the Security Kernel. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then *{userName}* is interpreted as a Tapis user and the request body may contain the optional attribute *loginUser* which will be used to map the Tapis user to a username to be used when accessing the system. If the login user is not provided then there is no mapping and the Tapis user is always used when accessing the system. If the *effectiveUserId* for the system is static (i.e. not *${apiUserId}*) then *{userName}* is interpreted as the login user to be used when accessing the host. Operation is allowed if requester is the system owner or a tenant administrator. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then the operation is allowed if *{userName}* is the Tapis user making the request. By default credentials for LINUX and S3 type systems are verified. Use query parameter *skipCredentialCheck=true* to bypass initial credential validation.
|
|
97
153
|
*/
|
|
98
154
|
async createUserCredential(requestParameters: CreateUserCredentialRequest, initOverrides?: RequestInit): Promise<RespBasic> {
|
|
99
155
|
const response = await this.createUserCredentialRaw(requestParameters, initOverrides);
|
|
@@ -101,8 +157,87 @@ export class CredentialsApi extends runtime.BaseAPI {
|
|
|
101
157
|
}
|
|
102
158
|
|
|
103
159
|
/**
|
|
104
|
-
*
|
|
105
|
-
*
|
|
160
|
+
* Use a Globus *Native App Authorization Code* and a Tapis session Id to generate a pair of access and refresh tokens. The Systems service will use the Tapis Security Kernel to store the tokens for the given system and user. The session Id is a Tapis Id that is used to track the oauth2 flow that is started when a call to the getGlobusAuthUrl endpoint is made. Note that the authorization code as per Globus documentation is valid for 10 minutes.
|
|
161
|
+
* Use a Globus authorization code + Tapis session Id to generate tokens
|
|
162
|
+
*/
|
|
163
|
+
async generateGlobusTokensRaw(requestParameters: GenerateGlobusTokensRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>> {
|
|
164
|
+
if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
|
|
165
|
+
throw new runtime.RequiredError('systemId','Required parameter requestParameters.systemId was null or undefined when calling generateGlobusTokens.');
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
if (requestParameters.userName === null || requestParameters.userName === undefined) {
|
|
169
|
+
throw new runtime.RequiredError('userName','Required parameter requestParameters.userName was null or undefined when calling generateGlobusTokens.');
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
if (requestParameters.authCode === null || requestParameters.authCode === undefined) {
|
|
173
|
+
throw new runtime.RequiredError('authCode','Required parameter requestParameters.authCode was null or undefined when calling generateGlobusTokens.');
|
|
174
|
+
}
|
|
175
|
+
|
|
176
|
+
if (requestParameters.sessionId === null || requestParameters.sessionId === undefined) {
|
|
177
|
+
throw new runtime.RequiredError('sessionId','Required parameter requestParameters.sessionId was null or undefined when calling generateGlobusTokens.');
|
|
178
|
+
}
|
|
179
|
+
|
|
180
|
+
const queryParameters: any = {};
|
|
181
|
+
|
|
182
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
183
|
+
|
|
184
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
185
|
+
headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
|
|
186
|
+
}
|
|
187
|
+
|
|
188
|
+
const response = await this.request({
|
|
189
|
+
path: `/v3/systems/credential/{systemId}/user/{userName}/globus/tokens/{authCode}/{sessionId}`.replace(`{${"systemId"}}`, encodeURIComponent(String(requestParameters.systemId))).replace(`{${"userName"}}`, encodeURIComponent(String(requestParameters.userName))).replace(`{${"authCode"}}`, encodeURIComponent(String(requestParameters.authCode))).replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters.sessionId))),
|
|
190
|
+
method: 'POST',
|
|
191
|
+
headers: headerParameters,
|
|
192
|
+
query: queryParameters,
|
|
193
|
+
}, initOverrides);
|
|
194
|
+
|
|
195
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => RespBasicFromJSON(jsonValue));
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
/**
|
|
199
|
+
* Use a Globus *Native App Authorization Code* and a Tapis session Id to generate a pair of access and refresh tokens. The Systems service will use the Tapis Security Kernel to store the tokens for the given system and user. The session Id is a Tapis Id that is used to track the oauth2 flow that is started when a call to the getGlobusAuthUrl endpoint is made. Note that the authorization code as per Globus documentation is valid for 10 minutes.
|
|
200
|
+
* Use a Globus authorization code + Tapis session Id to generate tokens
|
|
201
|
+
*/
|
|
202
|
+
async generateGlobusTokens(requestParameters: GenerateGlobusTokensRequest, initOverrides?: RequestInit): Promise<RespBasic> {
|
|
203
|
+
const response = await this.generateGlobusTokensRaw(requestParameters, initOverrides);
|
|
204
|
+
return await response.value();
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
/**
|
|
208
|
+
* Retrieve a Globus URL + Session Id that can be used to generate an oauth2 authorization code. In Globus the code is referred to as a *Native App Authorization Code*. The host property of the system is used as the Endpoint Id. Once a user has obtained an authorization code the corresponding Systems endpoint for generating Globus tokens should be called to exchange the code + sessionId for a pair of access and refresh tokens. The session Id is a Tapis Id that is used to track the oauth2 flow that is started when this call is made. Note that the authorization code as per Globus documentation is valid for 10 minutes.
|
|
209
|
+
* Retrieve a Globus URL that can be used to generate an authorization code for an OAuth2 flow.
|
|
210
|
+
*/
|
|
211
|
+
async getGlobusAuthUrlRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespGlobusAuthUrl>> {
|
|
212
|
+
const queryParameters: any = {};
|
|
213
|
+
|
|
214
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
215
|
+
|
|
216
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
217
|
+
headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
|
|
218
|
+
}
|
|
219
|
+
|
|
220
|
+
const response = await this.request({
|
|
221
|
+
path: `/v3/systems/credential/globus/authUrl`,
|
|
222
|
+
method: 'GET',
|
|
223
|
+
headers: headerParameters,
|
|
224
|
+
query: queryParameters,
|
|
225
|
+
}, initOverrides);
|
|
226
|
+
|
|
227
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => RespGlobusAuthUrlFromJSON(jsonValue));
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
/**
|
|
231
|
+
* Retrieve a Globus URL + Session Id that can be used to generate an oauth2 authorization code. In Globus the code is referred to as a *Native App Authorization Code*. The host property of the system is used as the Endpoint Id. Once a user has obtained an authorization code the corresponding Systems endpoint for generating Globus tokens should be called to exchange the code + sessionId for a pair of access and refresh tokens. The session Id is a Tapis Id that is used to track the oauth2 flow that is started when this call is made. Note that the authorization code as per Globus documentation is valid for 10 minutes.
|
|
232
|
+
* Retrieve a Globus URL that can be used to generate an authorization code for an OAuth2 flow.
|
|
233
|
+
*/
|
|
234
|
+
async getGlobusAuthUrl(initOverrides?: RequestInit): Promise<RespGlobusAuthUrl> {
|
|
235
|
+
const response = await this.getGlobusAuthUrlRaw(initOverrides);
|
|
236
|
+
return await response.value();
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
/**
|
|
240
|
+
* Restricted. Only certain Tapis services authorized. Retrieve credentials for given system, target *userName* and authentication method. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then *{userName}* is interpreted as a Tapis user. Note that their may me a mapping of the Tapis user to a host *loginUser*. If the *effectiveUserId* for the system is static (i.e. not *${apiUserId}*) then *{userName}* is interpreted as the host *loginUser* that is used when accessing the host. Desired authentication method may be specified using query parameter authnMethod=<method>. If desired authentication method not specified then credentials for the system\'s default authentication method are returned. The result includes the attribute *authnMethod* indicating the authentication method associated with the returned credentials.
|
|
106
241
|
*/
|
|
107
242
|
async getUserCredentialRaw(requestParameters: GetUserCredentialRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespCredential>> {
|
|
108
243
|
if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
|
|
@@ -136,8 +271,7 @@ export class CredentialsApi extends runtime.BaseAPI {
|
|
|
136
271
|
}
|
|
137
272
|
|
|
138
273
|
/**
|
|
139
|
-
*
|
|
140
|
-
* Retrieve user credentials for a system and target user
|
|
274
|
+
* Restricted. Only certain Tapis services authorized. Retrieve credentials for given system, target *userName* and authentication method. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then *{userName}* is interpreted as a Tapis user. Note that their may me a mapping of the Tapis user to a host *loginUser*. If the *effectiveUserId* for the system is static (i.e. not *${apiUserId}*) then *{userName}* is interpreted as the host *loginUser* that is used when accessing the host. Desired authentication method may be specified using query parameter authnMethod=<method>. If desired authentication method not specified then credentials for the system\'s default authentication method are returned. The result includes the attribute *authnMethod* indicating the authentication method associated with the returned credentials.
|
|
141
275
|
*/
|
|
142
276
|
async getUserCredential(requestParameters: GetUserCredentialRequest, initOverrides?: RequestInit): Promise<RespCredential> {
|
|
143
277
|
const response = await this.getUserCredentialRaw(requestParameters, initOverrides);
|
|
@@ -145,8 +279,7 @@ export class CredentialsApi extends runtime.BaseAPI {
|
|
|
145
279
|
}
|
|
146
280
|
|
|
147
281
|
/**
|
|
148
|
-
* Remove credentials from the Security Kernel for given system and *target user*. Requester must be owner of the system.
|
|
149
|
-
* Remove user credentials for a system and target user
|
|
282
|
+
* Remove credentials from the Security Kernel for given system and *target user*. Requester must be owner of the system. Operation is allowed if requester the system owner or a tenant administrator. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then the operation is allowed if *{userName}* is the Tapis user making the request.
|
|
150
283
|
*/
|
|
151
284
|
async removeUserCredentialRaw(requestParameters: RemoveUserCredentialRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>> {
|
|
152
285
|
if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
|
|
@@ -176,8 +309,7 @@ export class CredentialsApi extends runtime.BaseAPI {
|
|
|
176
309
|
}
|
|
177
310
|
|
|
178
311
|
/**
|
|
179
|
-
* Remove credentials from the Security Kernel for given system and *target user*. Requester must be owner of the system.
|
|
180
|
-
* Remove user credentials for a system and target user
|
|
312
|
+
* Remove credentials from the Security Kernel for given system and *target user*. Requester must be owner of the system. Operation is allowed if requester the system owner or a tenant administrator. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then the operation is allowed if *{userName}* is the Tapis user making the request.
|
|
181
313
|
*/
|
|
182
314
|
async removeUserCredential(requestParameters: RemoveUserCredentialRequest, initOverrides?: RequestInit): Promise<RespBasic> {
|
|
183
315
|
const response = await this.removeUserCredentialRaw(requestParameters, initOverrides);
|
package/src/apis/GeneralApi.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Tapis Systems API
|
|
5
5
|
* The Tapis Systems API provides for management of Tapis Systems including permissions, credentials and Scheduler Profiles.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.3
|
|
8
8
|
* Contact: cicsupport@tacc.utexas.edu
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -26,7 +26,7 @@ import {
|
|
|
26
26
|
export class GeneralApi extends runtime.BaseAPI {
|
|
27
27
|
|
|
28
28
|
/**
|
|
29
|
-
* Health check.
|
|
29
|
+
* Health check. Lightweight non-authenticated check that service is alive.
|
|
30
30
|
*/
|
|
31
31
|
async healthCheckRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>> {
|
|
32
32
|
const queryParameters: any = {};
|
|
@@ -48,7 +48,7 @@ export class GeneralApi extends runtime.BaseAPI {
|
|
|
48
48
|
}
|
|
49
49
|
|
|
50
50
|
/**
|
|
51
|
-
* Health check.
|
|
51
|
+
* Health check. Lightweight non-authenticated check that service is alive.
|
|
52
52
|
*/
|
|
53
53
|
async healthCheck(initOverrides?: RequestInit): Promise<RespBasic> {
|
|
54
54
|
const response = await this.healthCheckRaw(initOverrides);
|
|
@@ -56,7 +56,7 @@ export class GeneralApi extends runtime.BaseAPI {
|
|
|
56
56
|
}
|
|
57
57
|
|
|
58
58
|
/**
|
|
59
|
-
* Ready check.
|
|
59
|
+
* Ready check. Non-authenticated check that service is ready to do work.
|
|
60
60
|
*/
|
|
61
61
|
async readyCheckRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>> {
|
|
62
62
|
const queryParameters: any = {};
|
|
@@ -78,7 +78,7 @@ export class GeneralApi extends runtime.BaseAPI {
|
|
|
78
78
|
}
|
|
79
79
|
|
|
80
80
|
/**
|
|
81
|
-
* Ready check.
|
|
81
|
+
* Ready check. Non-authenticated check that service is ready to do work.
|
|
82
82
|
*/
|
|
83
83
|
async readyCheck(initOverrides?: RequestInit): Promise<RespBasic> {
|
|
84
84
|
const response = await this.readyCheckRaw(initOverrides);
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Tapis Systems API
|
|
5
5
|
* The Tapis Systems API provides for management of Tapis Systems including permissions, credentials and Scheduler Profiles.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.3
|
|
8
8
|
* Contact: cicsupport@tacc.utexas.edu
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -56,7 +56,6 @@ export class PermissionsApi extends runtime.BaseAPI {
|
|
|
56
56
|
|
|
57
57
|
/**
|
|
58
58
|
* Retrieve all system related permissions for a given system and user.
|
|
59
|
-
* Retrieve system user permissions
|
|
60
59
|
*/
|
|
61
60
|
async getUserPermsRaw(requestParameters: GetUserPermsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespNameArray>> {
|
|
62
61
|
if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
|
|
@@ -87,7 +86,6 @@ export class PermissionsApi extends runtime.BaseAPI {
|
|
|
87
86
|
|
|
88
87
|
/**
|
|
89
88
|
* Retrieve all system related permissions for a given system and user.
|
|
90
|
-
* Retrieve system user permissions
|
|
91
89
|
*/
|
|
92
90
|
async getUserPerms(requestParameters: GetUserPermsRequest, initOverrides?: RequestInit): Promise<RespNameArray> {
|
|
93
91
|
const response = await this.getUserPermsRaw(requestParameters, initOverrides);
|
|
@@ -95,8 +93,7 @@ export class PermissionsApi extends runtime.BaseAPI {
|
|
|
95
93
|
}
|
|
96
94
|
|
|
97
95
|
/**
|
|
98
|
-
* Create permissions in the Security Kernel for a user. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE.
|
|
99
|
-
* Grant system user permissions
|
|
96
|
+
* Create permissions in the Security Kernel for a user. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE. MODIFY implies READ.
|
|
100
97
|
*/
|
|
101
98
|
async grantUserPermsRaw(requestParameters: GrantUserPermsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>> {
|
|
102
99
|
if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
|
|
@@ -133,8 +130,7 @@ export class PermissionsApi extends runtime.BaseAPI {
|
|
|
133
130
|
}
|
|
134
131
|
|
|
135
132
|
/**
|
|
136
|
-
* Create permissions in the Security Kernel for a user. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE.
|
|
137
|
-
* Grant system user permissions
|
|
133
|
+
* Create permissions in the Security Kernel for a user. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE. MODIFY implies READ.
|
|
138
134
|
*/
|
|
139
135
|
async grantUserPerms(requestParameters: GrantUserPermsRequest, initOverrides?: RequestInit): Promise<RespBasic> {
|
|
140
136
|
const response = await this.grantUserPermsRaw(requestParameters, initOverrides);
|
|
@@ -143,7 +139,6 @@ export class PermissionsApi extends runtime.BaseAPI {
|
|
|
143
139
|
|
|
144
140
|
/**
|
|
145
141
|
* Remove system user permission from the Security Kernel. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE.
|
|
146
|
-
* Revoke system user permission
|
|
147
142
|
*/
|
|
148
143
|
async revokeUserPermRaw(requestParameters: RevokeUserPermRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>> {
|
|
149
144
|
if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
|
|
@@ -178,7 +173,6 @@ export class PermissionsApi extends runtime.BaseAPI {
|
|
|
178
173
|
|
|
179
174
|
/**
|
|
180
175
|
* Remove system user permission from the Security Kernel. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE.
|
|
181
|
-
* Revoke system user permission
|
|
182
176
|
*/
|
|
183
177
|
async revokeUserPerm(requestParameters: RevokeUserPermRequest, initOverrides?: RequestInit): Promise<RespBasic> {
|
|
184
178
|
const response = await this.revokeUserPermRaw(requestParameters, initOverrides);
|
|
@@ -187,7 +181,6 @@ export class PermissionsApi extends runtime.BaseAPI {
|
|
|
187
181
|
|
|
188
182
|
/**
|
|
189
183
|
* Remove permissions from the Security Kernel for a user. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE.
|
|
190
|
-
* Revoke system user permissions
|
|
191
184
|
*/
|
|
192
185
|
async revokeUserPermsRaw(requestParameters: RevokeUserPermsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>> {
|
|
193
186
|
if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
|
|
@@ -225,7 +218,6 @@ export class PermissionsApi extends runtime.BaseAPI {
|
|
|
225
218
|
|
|
226
219
|
/**
|
|
227
220
|
* Remove permissions from the Security Kernel for a user. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE.
|
|
228
|
-
* Revoke system user permissions
|
|
229
221
|
*/
|
|
230
222
|
async revokeUserPerms(requestParameters: RevokeUserPermsRequest, initOverrides?: RequestInit): Promise<RespBasic> {
|
|
231
223
|
const response = await this.revokeUserPermsRaw(requestParameters, initOverrides);
|