@tapis/tapis-typescript-systems 0.0.6 → 0.0.7
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 +3 -0
- package/.openapi-generator/VERSION +1 -1
- package/README.md +5 -4
- package/dist/apis/ChildSystemsApi.d.ts +10 -10
- package/dist/apis/ChildSystemsApi.js +84 -65
- package/dist/apis/CredentialsApi.d.ts +25 -24
- package/dist/apis/CredentialsApi.js +172 -138
- package/dist/apis/GeneralApi.d.ts +6 -6
- package/dist/apis/GeneralApi.js +18 -11
- package/dist/apis/PermissionsApi.d.ts +10 -10
- package/dist/apis/PermissionsApi.js +112 -89
- package/dist/apis/SchedulerProfilesApi.d.ts +10 -10
- package/dist/apis/SchedulerProfilesApi.js +95 -72
- package/dist/apis/SharingApi.d.ts +12 -12
- package/dist/apis/SharingApi.js +122 -95
- package/dist/apis/SystemsApi.d.ts +61 -46
- package/dist/apis/SystemsApi.js +473 -341
- package/dist/apis/index.js +21 -10
- package/dist/index.d.ts +2 -2
- package/dist/index.js +17 -6
- package/dist/models/AuthnEnum.d.ts +12 -9
- package/dist/models/AuthnEnum.js +28 -13
- package/dist/models/Capability.d.ts +9 -3
- package/dist/models/Capability.js +37 -22
- package/dist/models/CategoryEnum.d.ts +14 -12
- package/dist/models/CategoryEnum.js +30 -16
- package/dist/models/Credential.d.ts +26 -3
- package/dist/models/Credential.js +47 -33
- package/dist/models/DatatypeEnum.d.ts +11 -9
- package/dist/models/DatatypeEnum.js +27 -13
- package/dist/models/JobRuntime.d.ts +8 -3
- package/dist/models/JobRuntime.js +27 -17
- package/dist/models/KeyValueInputModeEnum.d.ts +10 -8
- package/dist/models/KeyValueInputModeEnum.js +26 -12
- package/dist/models/KeyValuePair.d.ts +8 -3
- package/dist/models/KeyValuePair.js +32 -22
- package/dist/models/ListTypeEnum.d.ts +9 -7
- package/dist/models/ListTypeEnum.js +25 -11
- package/dist/models/LogicalQueue.d.ts +13 -2
- package/dist/models/LogicalQueue.js +48 -34
- package/dist/models/ModuleLoadSpec.d.ts +7 -2
- package/dist/models/ModuleLoadSpec.js +25 -15
- package/dist/models/OperationTypeEnum.d.ts +20 -18
- package/dist/models/OperationTypeEnum.js +36 -22
- package/dist/models/ReqMatchConstraints.d.ts +7 -2
- package/dist/models/ReqMatchConstraints.js +23 -12
- package/dist/models/ReqPatchSystem.d.ts +13 -3
- package/dist/models/ReqPatchSystem.js +76 -63
- package/dist/models/ReqPerms.d.ts +7 -2
- package/dist/models/ReqPerms.js +23 -12
- package/dist/models/ReqPostChildSystem.d.ts +7 -2
- package/dist/models/ReqPostChildSystem.js +28 -16
- package/dist/models/ReqPostPutCredential.d.ts +7 -2
- package/dist/models/ReqPostPutCredential.js +36 -28
- package/dist/models/ReqPostSchedulerProfile.d.ts +9 -3
- package/dist/models/ReqPostSchedulerProfile.js +33 -22
- package/dist/models/ReqPostSystem.d.ts +15 -3
- package/dist/models/ReqPostSystem.js +101 -76
- package/dist/models/ReqPutSystem.d.ts +13 -3
- package/dist/models/ReqPutSystem.js +74 -61
- package/dist/models/ReqSearchSystems.d.ts +7 -2
- package/dist/models/ReqSearchSystems.js +23 -12
- package/dist/models/ReqShareUpdate.d.ts +7 -2
- package/dist/models/ReqShareUpdate.js +23 -12
- package/dist/models/ReqUnlinkChildren.d.ts +7 -2
- package/dist/models/ReqUnlinkChildren.js +22 -14
- package/dist/models/ReqUpdateCredential.d.ts +7 -2
- package/dist/models/ReqUpdateCredential.js +38 -30
- package/dist/models/RespBasic.d.ts +7 -2
- package/dist/models/RespBasic.js +34 -26
- package/dist/models/RespBoolean.d.ts +8 -3
- package/dist/models/RespBoolean.js +35 -27
- package/dist/models/RespChangeCount.d.ts +8 -3
- package/dist/models/RespChangeCount.js +35 -27
- package/dist/models/RespCredential.d.ts +8 -3
- package/dist/models/RespCredential.js +35 -27
- package/dist/models/RespGlobusAuthUrl.d.ts +8 -3
- package/dist/models/RespGlobusAuthUrl.js +35 -27
- package/dist/models/RespName.d.ts +69 -0
- package/dist/models/RespName.js +62 -0
- package/dist/models/RespNameArray.d.ts +8 -3
- package/dist/models/RespNameArray.js +35 -27
- package/dist/models/RespResourceUrl.d.ts +8 -3
- package/dist/models/RespResourceUrl.js +35 -27
- package/dist/models/RespSchedulerProfile.d.ts +8 -3
- package/dist/models/RespSchedulerProfile.js +35 -27
- package/dist/models/RespSchedulerProfiles.d.ts +8 -3
- package/dist/models/RespSchedulerProfiles.js +35 -27
- package/dist/models/RespShareInfo.d.ts +8 -3
- package/dist/models/RespShareInfo.js +35 -27
- package/dist/models/RespSystem.d.ts +8 -3
- package/dist/models/RespSystem.js +35 -27
- package/dist/models/RespSystemHistory.d.ts +8 -3
- package/dist/models/RespSystemHistory.js +35 -27
- package/dist/models/RespSystems.d.ts +9 -3
- package/dist/models/RespSystems.js +36 -27
- package/dist/models/RespSystemsMetadata.d.ts +7 -2
- package/dist/models/RespSystemsMetadata.js +32 -24
- package/dist/models/ResultBoolean.d.ts +7 -2
- package/dist/models/ResultBoolean.js +22 -14
- package/dist/models/ResultChangeCount.d.ts +7 -2
- package/dist/models/ResultChangeCount.js +22 -14
- package/dist/models/ResultGlobusAuthUrl.d.ts +7 -2
- package/dist/models/ResultGlobusAuthUrl.js +26 -18
- package/dist/models/ResultName.d.ts +32 -0
- package/dist/models/ResultName.js +49 -0
- package/dist/models/ResultNameArray.d.ts +7 -2
- package/dist/models/ResultNameArray.js +22 -14
- package/dist/models/ResultResourceUrl.d.ts +7 -2
- package/dist/models/ResultResourceUrl.js +22 -14
- package/dist/models/RuntimeTypeEnum.d.ts +9 -7
- package/dist/models/RuntimeTypeEnum.js +25 -11
- package/dist/models/SchedulerHiddenOptionEnum.d.ts +8 -5
- package/dist/models/SchedulerHiddenOptionEnum.js +24 -9
- package/dist/models/SchedulerProfile.d.ts +9 -3
- package/dist/models/SchedulerProfile.js +35 -24
- package/dist/models/SchedulerTypeEnum.d.ts +12 -10
- package/dist/models/SchedulerTypeEnum.js +28 -14
- package/dist/models/ShareInfo.d.ts +14 -2
- package/dist/models/ShareInfo.js +29 -13
- package/dist/models/SkShareRecord.d.ts +86 -0
- package/dist/models/SkShareRecord.js +67 -0
- package/dist/models/SystemHistory.d.ts +8 -3
- package/dist/models/SystemHistory.js +35 -27
- package/dist/models/SystemTypeEnum.d.ts +10 -8
- package/dist/models/SystemTypeEnum.js +26 -12
- package/dist/models/TapisSystem.d.ts +39 -21
- package/dist/models/TapisSystem.js +114 -97
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +68 -54
- package/dist/runtime.d.ts +79 -37
- package/dist/runtime.js +311 -169
- package/package.json +6 -2
- package/src/apis/ChildSystemsApi.ts +47 -33
- package/src/apis/CredentialsApi.ts +124 -75
- package/src/apis/GeneralApi.ts +9 -7
- package/src/apis/PermissionsApi.ts +80 -45
- package/src/apis/SchedulerProfilesApi.ts +40 -29
- package/src/apis/SharingApi.ts +64 -41
- package/src/apis/SystemsApi.ts +306 -189
- package/src/index.ts +2 -2
- package/src/models/AuthnEnum.ts +26 -8
- package/src/models/Capability.ts +37 -19
- package/src/models/CategoryEnum.ts +28 -11
- package/src/models/Credential.ts +67 -31
- package/src/models/DatatypeEnum.ts +25 -8
- package/src/models/JobRuntime.ts +27 -14
- package/src/models/KeyValueInputModeEnum.ts +24 -7
- package/src/models/KeyValuePair.ts +33 -20
- package/src/models/ListTypeEnum.ts +23 -6
- package/src/models/LogicalQueue.ts +50 -31
- package/src/models/ModuleLoadSpec.ts +22 -12
- package/src/models/OperationTypeEnum.ts +34 -17
- package/src/models/ReqMatchConstraints.ts +20 -10
- package/src/models/ReqPatchSystem.ts +96 -69
- package/src/models/ReqPerms.ts +20 -10
- package/src/models/ReqPostChildSystem.ts +24 -13
- package/src/models/ReqPostPutCredential.ts +34 -25
- package/src/models/ReqPostSchedulerProfile.ts +38 -24
- package/src/models/ReqPostSystem.ts +123 -85
- package/src/models/ReqPutSystem.ts +94 -67
- package/src/models/ReqSearchSystems.ts +20 -10
- package/src/models/ReqShareUpdate.ts +20 -10
- package/src/models/ReqUnlinkChildren.ts +20 -11
- package/src/models/ReqUpdateCredential.ts +36 -27
- package/src/models/RespBasic.ts +32 -23
- package/src/models/RespBoolean.ts +35 -25
- package/src/models/RespChangeCount.ts +35 -25
- package/src/models/RespCredential.ts +35 -25
- package/src/models/RespGlobusAuthUrl.ts +35 -25
- package/src/models/RespName.ts +121 -0
- package/src/models/RespNameArray.ts +35 -25
- package/src/models/RespResourceUrl.ts +35 -25
- package/src/models/RespSchedulerProfile.ts +35 -25
- package/src/models/RespSchedulerProfiles.ts +35 -25
- package/src/models/RespShareInfo.ts +35 -25
- package/src/models/RespSystem.ts +35 -25
- package/src/models/RespSystemHistory.ts +35 -25
- package/src/models/RespSystems.ts +42 -29
- package/src/models/RespSystemsMetadata.ts +30 -21
- package/src/models/ResultBoolean.ts +20 -11
- package/src/models/ResultChangeCount.ts +20 -11
- package/src/models/ResultGlobusAuthUrl.ts +24 -15
- package/src/models/ResultName.ts +65 -0
- package/src/models/ResultNameArray.ts +20 -11
- package/src/models/ResultResourceUrl.ts +20 -11
- package/src/models/RuntimeTypeEnum.ts +23 -6
- package/src/models/SchedulerHiddenOptionEnum.ts +22 -4
- package/src/models/SchedulerProfile.ts +40 -26
- package/src/models/SchedulerTypeEnum.ts +26 -9
- package/src/models/ShareInfo.ts +38 -11
- package/src/models/SkShareRecord.ts +137 -0
- package/src/models/SystemHistory.ts +37 -25
- package/src/models/SystemTypeEnum.ts +24 -7
- package/src/models/TapisSystem.ts +167 -126
- package/src/models/index.ts +3 -0
- package/src/runtime.ts +217 -106
|
@@ -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:
|
|
8
|
+
* The version of the OpenAPI document: 25Q4.2
|
|
9
9
|
* Contact: cicsupport@tacc.utexas.edu
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -13,30 +13,36 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
var __extends = (this && this.__extends) || (function () {
|
|
16
|
-
var extendStatics =
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
var extendStatics = function (d, b) {
|
|
17
|
+
extendStatics = Object.setPrototypeOf ||
|
|
18
|
+
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
19
|
+
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
20
|
+
return extendStatics(d, b);
|
|
21
|
+
};
|
|
19
22
|
return function (d, b) {
|
|
23
|
+
if (typeof b !== "function" && b !== null)
|
|
24
|
+
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
20
25
|
extendStatics(d, b);
|
|
21
26
|
function __() { this.constructor = d; }
|
|
22
27
|
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
23
28
|
};
|
|
24
29
|
})();
|
|
25
30
|
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
31
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
26
32
|
return new (P || (P = Promise))(function (resolve, reject) {
|
|
27
33
|
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
28
34
|
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
29
|
-
function step(result) { result.done ? resolve(result.value) :
|
|
35
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
30
36
|
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
31
37
|
});
|
|
32
38
|
};
|
|
33
39
|
var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
34
|
-
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
|
|
35
|
-
return g =
|
|
40
|
+
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
|
|
41
|
+
return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
36
42
|
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
37
43
|
function step(op) {
|
|
38
44
|
if (f) throw new TypeError("Generator is already executing.");
|
|
39
|
-
while (_) try {
|
|
45
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
40
46
|
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
41
47
|
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
42
48
|
switch (op[0]) {
|
|
@@ -58,8 +64,9 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
|
58
64
|
}
|
|
59
65
|
};
|
|
60
66
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
67
|
+
exports.CredentialsApi = void 0;
|
|
61
68
|
var runtime = require("../runtime");
|
|
62
|
-
var
|
|
69
|
+
var index_1 = require("../models/index");
|
|
63
70
|
/**
|
|
64
71
|
*
|
|
65
72
|
*/
|
|
@@ -69,43 +76,47 @@ var CredentialsApi = /** @class */ (function (_super) {
|
|
|
69
76
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
70
77
|
}
|
|
71
78
|
/**
|
|
72
|
-
* 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 interpreted as the login user to be used when accessing the host. Note that this would typically be the current *effectiveUserId* defined for the system, but that is not a requirement. This allows for registering and checking credentials for a login user prior to updating the system definition. 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*. If not specified, then credentials for the system\'s default authentication method are verified.
|
|
79
|
+
* 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}*. Note that the Tapis user *{userName}* may have a mapping to a host *loginUser* in which case the *loginUser* will be used when verifying the credentials. Note that what we call the *Tapis user* comes from the username claim in the Tapis JWT. 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. Note that this would typically be the current *effectiveUserId* defined for the system, but that is not a requirement. This allows for registering and checking credentials for a login user prior to updating the system definition. 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*. If not specified, then credentials for the system\'s default authentication method are verified.
|
|
73
80
|
*/
|
|
74
81
|
CredentialsApi.prototype.checkUserCredentialRaw = function (requestParameters, initOverrides) {
|
|
75
82
|
return __awaiter(this, void 0, void 0, function () {
|
|
76
|
-
var queryParameters, headerParameters, response;
|
|
77
|
-
return __generator(this, function (
|
|
78
|
-
switch (
|
|
83
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
84
|
+
return __generator(this, function (_c) {
|
|
85
|
+
switch (_c.label) {
|
|
79
86
|
case 0:
|
|
80
|
-
if (requestParameters
|
|
81
|
-
throw new runtime.RequiredError('systemId', 'Required parameter
|
|
87
|
+
if (requestParameters['systemId'] == null) {
|
|
88
|
+
throw new runtime.RequiredError('systemId', 'Required parameter "systemId" was null or undefined when calling checkUserCredential().');
|
|
82
89
|
}
|
|
83
|
-
if (requestParameters
|
|
84
|
-
throw new runtime.RequiredError('userName', 'Required parameter
|
|
90
|
+
if (requestParameters['userName'] == null) {
|
|
91
|
+
throw new runtime.RequiredError('userName', 'Required parameter "userName" was null or undefined when calling checkUserCredential().');
|
|
85
92
|
}
|
|
86
93
|
queryParameters = {};
|
|
87
|
-
if (requestParameters
|
|
88
|
-
queryParameters['authnMethod'] = requestParameters
|
|
94
|
+
if (requestParameters['authnMethod'] != null) {
|
|
95
|
+
queryParameters['authnMethod'] = requestParameters['authnMethod'];
|
|
89
96
|
}
|
|
90
97
|
headerParameters = {};
|
|
91
|
-
if (this.configuration && this.configuration.apiKey)
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
return [4 /*yield*/, this.
|
|
95
|
-
path: "/v3/systems/credential/{systemId}/user/{userName}/check".replace("{" + "systemId" + "}", encodeURIComponent(String(requestParameters.systemId))).replace("{" + "userName" + "}", encodeURIComponent(String(requestParameters.userName))),
|
|
96
|
-
method: 'POST',
|
|
97
|
-
headers: headerParameters,
|
|
98
|
-
query: queryParameters,
|
|
99
|
-
}, initOverrides)];
|
|
98
|
+
if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
|
|
99
|
+
_a = headerParameters;
|
|
100
|
+
_b = "X-Tapis-Token";
|
|
101
|
+
return [4 /*yield*/, this.configuration.apiKey("X-Tapis-Token")];
|
|
100
102
|
case 1:
|
|
101
|
-
|
|
102
|
-
|
|
103
|
+
_a[_b] = _c.sent(); // TapisJWT authentication
|
|
104
|
+
_c.label = 2;
|
|
105
|
+
case 2: return [4 /*yield*/, this.request({
|
|
106
|
+
path: "/v3/systems/credential/{systemId}/user/{userName}/check".replace("{".concat("systemId", "}"), encodeURIComponent(String(requestParameters['systemId']))).replace("{".concat("userName", "}"), encodeURIComponent(String(requestParameters['userName']))),
|
|
107
|
+
method: 'POST',
|
|
108
|
+
headers: headerParameters,
|
|
109
|
+
query: queryParameters,
|
|
110
|
+
}, initOverrides)];
|
|
111
|
+
case 3:
|
|
112
|
+
response = _c.sent();
|
|
113
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.RespBasicFromJSON)(jsonValue); })];
|
|
103
114
|
}
|
|
104
115
|
});
|
|
105
116
|
});
|
|
106
117
|
};
|
|
107
118
|
/**
|
|
108
|
-
* 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 interpreted as the login user to be used when accessing the host. Note that this would typically be the current *effectiveUserId* defined for the system, but that is not a requirement. This allows for registering and checking credentials for a login user prior to updating the system definition. 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*. If not specified, then credentials for the system\'s default authentication method are verified.
|
|
119
|
+
* 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}*. Note that the Tapis user *{userName}* may have a mapping to a host *loginUser* in which case the *loginUser* will be used when verifying the credentials. Note that what we call the *Tapis user* comes from the username claim in the Tapis JWT. 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. Note that this would typically be the current *effectiveUserId* defined for the system, but that is not a requirement. This allows for registering and checking credentials for a login user prior to updating the system definition. 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*. If not specified, then credentials for the system\'s default authentication method are verified.
|
|
109
120
|
*/
|
|
110
121
|
CredentialsApi.prototype.checkUserCredential = function (requestParameters, initOverrides) {
|
|
111
122
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -122,48 +133,55 @@ var CredentialsApi = /** @class */ (function (_super) {
|
|
|
122
133
|
});
|
|
123
134
|
};
|
|
124
135
|
/**
|
|
125
|
-
* 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. Note that there is support for only one set of credentials per user per system. Updating credentials overwrites previously registered data. 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.
|
|
136
|
+
* 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. Note that there is support for only one set of credentials per user per system. Updating credentials overwrites previously registered data. 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. Note that what we call the *Tapis user* comes from the username claim in the Tapis JWT. 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. Please note that if there is a *loginUser* field in the request body, TAPIS will reject the request because the static effective user is always the login user. 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. Use query parameter *createTmsKeys=true* to have the service call a Trust Manager System (TMS) server to create and store an ssh keypair. Default is *false*. Please note that the following restrictions apply: - Tapis installation for your site must be configured to support the Trust Manager System (TMS). - The host for the system must have the sshd configuration set up to use TMS. - The *effectiveUserId* must be dynamic. - Mapping of user using *loginUser* is not supported. By default credentials for LINUX and S3 type systems are verified. Use query parameter *skipCredentialCheck=true* to bypass initial credential validation.
|
|
126
137
|
*/
|
|
127
138
|
CredentialsApi.prototype.createUserCredentialRaw = function (requestParameters, initOverrides) {
|
|
128
139
|
return __awaiter(this, void 0, void 0, function () {
|
|
129
|
-
var queryParameters, headerParameters, response;
|
|
130
|
-
return __generator(this, function (
|
|
131
|
-
switch (
|
|
140
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
141
|
+
return __generator(this, function (_c) {
|
|
142
|
+
switch (_c.label) {
|
|
132
143
|
case 0:
|
|
133
|
-
if (requestParameters
|
|
134
|
-
throw new runtime.RequiredError('systemId', 'Required parameter
|
|
144
|
+
if (requestParameters['systemId'] == null) {
|
|
145
|
+
throw new runtime.RequiredError('systemId', 'Required parameter "systemId" was null or undefined when calling createUserCredential().');
|
|
135
146
|
}
|
|
136
|
-
if (requestParameters
|
|
137
|
-
throw new runtime.RequiredError('userName', 'Required parameter
|
|
147
|
+
if (requestParameters['userName'] == null) {
|
|
148
|
+
throw new runtime.RequiredError('userName', 'Required parameter "userName" was null or undefined when calling createUserCredential().');
|
|
138
149
|
}
|
|
139
|
-
if (requestParameters
|
|
140
|
-
throw new runtime.RequiredError('reqUpdateCredential', 'Required parameter
|
|
150
|
+
if (requestParameters['reqUpdateCredential'] == null) {
|
|
151
|
+
throw new runtime.RequiredError('reqUpdateCredential', 'Required parameter "reqUpdateCredential" was null or undefined when calling createUserCredential().');
|
|
141
152
|
}
|
|
142
153
|
queryParameters = {};
|
|
143
|
-
if (requestParameters
|
|
144
|
-
queryParameters['
|
|
154
|
+
if (requestParameters['createTmsKeys'] != null) {
|
|
155
|
+
queryParameters['createTmsKeys'] = requestParameters['createTmsKeys'];
|
|
156
|
+
}
|
|
157
|
+
if (requestParameters['skipCredentialCheck'] != null) {
|
|
158
|
+
queryParameters['skipCredentialCheck'] = requestParameters['skipCredentialCheck'];
|
|
145
159
|
}
|
|
146
160
|
headerParameters = {};
|
|
147
161
|
headerParameters['Content-Type'] = 'application/json';
|
|
148
|
-
if (this.configuration && this.configuration.apiKey)
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
return [4 /*yield*/, this.
|
|
152
|
-
path: "/v3/systems/credential/{systemId}/user/{userName}".replace("{" + "systemId" + "}", encodeURIComponent(String(requestParameters.systemId))).replace("{" + "userName" + "}", encodeURIComponent(String(requestParameters.userName))),
|
|
153
|
-
method: 'POST',
|
|
154
|
-
headers: headerParameters,
|
|
155
|
-
query: queryParameters,
|
|
156
|
-
body: models_1.ReqUpdateCredentialToJSON(requestParameters.reqUpdateCredential),
|
|
157
|
-
}, initOverrides)];
|
|
162
|
+
if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
|
|
163
|
+
_a = headerParameters;
|
|
164
|
+
_b = "X-Tapis-Token";
|
|
165
|
+
return [4 /*yield*/, this.configuration.apiKey("X-Tapis-Token")];
|
|
158
166
|
case 1:
|
|
159
|
-
|
|
160
|
-
|
|
167
|
+
_a[_b] = _c.sent(); // TapisJWT authentication
|
|
168
|
+
_c.label = 2;
|
|
169
|
+
case 2: return [4 /*yield*/, this.request({
|
|
170
|
+
path: "/v3/systems/credential/{systemId}/user/{userName}".replace("{".concat("systemId", "}"), encodeURIComponent(String(requestParameters['systemId']))).replace("{".concat("userName", "}"), encodeURIComponent(String(requestParameters['userName']))),
|
|
171
|
+
method: 'POST',
|
|
172
|
+
headers: headerParameters,
|
|
173
|
+
query: queryParameters,
|
|
174
|
+
body: (0, index_1.ReqUpdateCredentialToJSON)(requestParameters['reqUpdateCredential']),
|
|
175
|
+
}, initOverrides)];
|
|
176
|
+
case 3:
|
|
177
|
+
response = _c.sent();
|
|
178
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.RespBasicFromJSON)(jsonValue); })];
|
|
161
179
|
}
|
|
162
180
|
});
|
|
163
181
|
});
|
|
164
182
|
};
|
|
165
183
|
/**
|
|
166
|
-
* 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. Note that there is support for only one set of credentials per user per system. Updating credentials overwrites previously registered data. 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.
|
|
184
|
+
* 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. Note that there is support for only one set of credentials per user per system. Updating credentials overwrites previously registered data. 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. Note that what we call the *Tapis user* comes from the username claim in the Tapis JWT. 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. Please note that if there is a *loginUser* field in the request body, TAPIS will reject the request because the static effective user is always the login user. 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. Use query parameter *createTmsKeys=true* to have the service call a Trust Manager System (TMS) server to create and store an ssh keypair. Default is *false*. Please note that the following restrictions apply: - Tapis installation for your site must be configured to support the Trust Manager System (TMS). - The host for the system must have the sshd configuration set up to use TMS. - The *effectiveUserId* must be dynamic. - Mapping of user using *loginUser* is not supported. By default credentials for LINUX and S3 type systems are verified. Use query parameter *skipCredentialCheck=true* to bypass initial credential validation.
|
|
167
185
|
*/
|
|
168
186
|
CredentialsApi.prototype.createUserCredential = function (requestParameters, initOverrides) {
|
|
169
187
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -180,47 +198,51 @@ var CredentialsApi = /** @class */ (function (_super) {
|
|
|
180
198
|
});
|
|
181
199
|
};
|
|
182
200
|
/**
|
|
183
|
-
* 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. The authorization code, as per Globus documentation, is valid for 10 minutes. Please note that the Tapis installation for your site must be configured by the site administrator to support systems of type GLOBUS.
|
|
201
|
+
* Use a Globus *Native App Authorization Code* and a Tapis session Id to generate a pair of access and refresh tokens. System must be of type GLOBUS. The Systems service will use the Tapis Security Kernel to store the tokens for the given system and user. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then *{userName}* must be set to the Tapis user. Note that what we call the *Tapis user* comes from the username claim in the Tapis JWT. If the *effectiveUserId* for the system is static (i.e. not *${apiUserId}*) then *{userName}* must be set to the static *effectiveUserId*. 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. The authorization code, as per Globus documentation, is valid for 10 minutes. Please note that the Tapis installation for your site must be configured by the site administrator to support systems of type GLOBUS.
|
|
184
202
|
* Use a Globus authorization code + Tapis session Id to generate tokens
|
|
185
203
|
*/
|
|
186
204
|
CredentialsApi.prototype.generateGlobusTokensRaw = function (requestParameters, initOverrides) {
|
|
187
205
|
return __awaiter(this, void 0, void 0, function () {
|
|
188
|
-
var queryParameters, headerParameters, response;
|
|
189
|
-
return __generator(this, function (
|
|
190
|
-
switch (
|
|
206
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
207
|
+
return __generator(this, function (_c) {
|
|
208
|
+
switch (_c.label) {
|
|
191
209
|
case 0:
|
|
192
|
-
if (requestParameters
|
|
193
|
-
throw new runtime.RequiredError('systemId', 'Required parameter
|
|
210
|
+
if (requestParameters['systemId'] == null) {
|
|
211
|
+
throw new runtime.RequiredError('systemId', 'Required parameter "systemId" was null or undefined when calling generateGlobusTokens().');
|
|
194
212
|
}
|
|
195
|
-
if (requestParameters
|
|
196
|
-
throw new runtime.RequiredError('userName', 'Required parameter
|
|
213
|
+
if (requestParameters['userName'] == null) {
|
|
214
|
+
throw new runtime.RequiredError('userName', 'Required parameter "userName" was null or undefined when calling generateGlobusTokens().');
|
|
197
215
|
}
|
|
198
|
-
if (requestParameters
|
|
199
|
-
throw new runtime.RequiredError('authCode', 'Required parameter
|
|
216
|
+
if (requestParameters['authCode'] == null) {
|
|
217
|
+
throw new runtime.RequiredError('authCode', 'Required parameter "authCode" was null or undefined when calling generateGlobusTokens().');
|
|
200
218
|
}
|
|
201
|
-
if (requestParameters
|
|
202
|
-
throw new runtime.RequiredError('sessionId', 'Required parameter
|
|
219
|
+
if (requestParameters['sessionId'] == null) {
|
|
220
|
+
throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling generateGlobusTokens().');
|
|
203
221
|
}
|
|
204
222
|
queryParameters = {};
|
|
205
223
|
headerParameters = {};
|
|
206
|
-
if (this.configuration && this.configuration.apiKey)
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
return [4 /*yield*/, this.
|
|
210
|
-
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))),
|
|
211
|
-
method: 'POST',
|
|
212
|
-
headers: headerParameters,
|
|
213
|
-
query: queryParameters,
|
|
214
|
-
}, initOverrides)];
|
|
224
|
+
if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
|
|
225
|
+
_a = headerParameters;
|
|
226
|
+
_b = "X-Tapis-Token";
|
|
227
|
+
return [4 /*yield*/, this.configuration.apiKey("X-Tapis-Token")];
|
|
215
228
|
case 1:
|
|
216
|
-
|
|
217
|
-
|
|
229
|
+
_a[_b] = _c.sent(); // TapisJWT authentication
|
|
230
|
+
_c.label = 2;
|
|
231
|
+
case 2: return [4 /*yield*/, this.request({
|
|
232
|
+
path: "/v3/systems/credential/{systemId}/user/{userName}/globus/tokens/{authCode}/{sessionId}".replace("{".concat("systemId", "}"), encodeURIComponent(String(requestParameters['systemId']))).replace("{".concat("userName", "}"), encodeURIComponent(String(requestParameters['userName']))).replace("{".concat("authCode", "}"), encodeURIComponent(String(requestParameters['authCode']))).replace("{".concat("sessionId", "}"), encodeURIComponent(String(requestParameters['sessionId']))),
|
|
233
|
+
method: 'POST',
|
|
234
|
+
headers: headerParameters,
|
|
235
|
+
query: queryParameters,
|
|
236
|
+
}, initOverrides)];
|
|
237
|
+
case 3:
|
|
238
|
+
response = _c.sent();
|
|
239
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.RespBasicFromJSON)(jsonValue); })];
|
|
218
240
|
}
|
|
219
241
|
});
|
|
220
242
|
});
|
|
221
243
|
};
|
|
222
244
|
/**
|
|
223
|
-
* 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. The authorization code, as per Globus documentation, is valid for 10 minutes. Please note that the Tapis installation for your site must be configured by the site administrator to support systems of type GLOBUS.
|
|
245
|
+
* Use a Globus *Native App Authorization Code* and a Tapis session Id to generate a pair of access and refresh tokens. System must be of type GLOBUS. The Systems service will use the Tapis Security Kernel to store the tokens for the given system and user. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then *{userName}* must be set to the Tapis user. Note that what we call the *Tapis user* comes from the username claim in the Tapis JWT. If the *effectiveUserId* for the system is static (i.e. not *${apiUserId}*) then *{userName}* must be set to the static *effectiveUserId*. 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. The authorization code, as per Globus documentation, is valid for 10 minutes. Please note that the Tapis installation for your site must be configured by the site administrator to support systems of type GLOBUS.
|
|
224
246
|
* Use a Globus authorization code + Tapis session Id to generate tokens
|
|
225
247
|
*/
|
|
226
248
|
CredentialsApi.prototype.generateGlobusTokens = function (requestParameters, initOverrides) {
|
|
@@ -238,38 +260,42 @@ var CredentialsApi = /** @class */ (function (_super) {
|
|
|
238
260
|
});
|
|
239
261
|
};
|
|
240
262
|
/**
|
|
241
|
-
* Retrieve a Globus URL + Session Id that can be used to generate an oauth2 authorization code associated with the given system. In Globus, the code is referred to as a *Native App Authorization Code*. The host property of the system is used as the Globus Endpoint Id or Globus Collection 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. The authorization code, as per Globus documentation, is valid for 10 minutes. Please note that the Tapis installation for your site must be configured by the site administrator to support systems of type GLOBUS.
|
|
263
|
+
* Retrieve a Globus URL + Session Id that can be used to generate an oauth2 authorization code associated with the given system. System must be of type GLOBUS. In Globus, the code is referred to as a *Native App Authorization Code*. The host property of the system is used as the Globus Endpoint Id or Globus Collection 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. The authorization code, as per Globus documentation, is valid for 10 minutes. Please note that the Tapis installation for your site must be configured by the site administrator to support systems of type GLOBUS.
|
|
242
264
|
* Retrieve a Globus URL that can be used to generate an authorization code for an OAuth2 flow.
|
|
243
265
|
*/
|
|
244
266
|
CredentialsApi.prototype.getGlobusAuthUrlRaw = function (requestParameters, initOverrides) {
|
|
245
267
|
return __awaiter(this, void 0, void 0, function () {
|
|
246
|
-
var queryParameters, headerParameters, response;
|
|
247
|
-
return __generator(this, function (
|
|
248
|
-
switch (
|
|
268
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
269
|
+
return __generator(this, function (_c) {
|
|
270
|
+
switch (_c.label) {
|
|
249
271
|
case 0:
|
|
250
|
-
if (requestParameters
|
|
251
|
-
throw new runtime.RequiredError('systemId', 'Required parameter
|
|
272
|
+
if (requestParameters['systemId'] == null) {
|
|
273
|
+
throw new runtime.RequiredError('systemId', 'Required parameter "systemId" was null or undefined when calling getGlobusAuthUrl().');
|
|
252
274
|
}
|
|
253
275
|
queryParameters = {};
|
|
254
276
|
headerParameters = {};
|
|
255
|
-
if (this.configuration && this.configuration.apiKey)
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
return [4 /*yield*/, this.
|
|
259
|
-
path: "/v3/systems/credential/{systemId}/globus/authUrl".replace("{" + "systemId" + "}", encodeURIComponent(String(requestParameters.systemId))),
|
|
260
|
-
method: 'GET',
|
|
261
|
-
headers: headerParameters,
|
|
262
|
-
query: queryParameters,
|
|
263
|
-
}, initOverrides)];
|
|
277
|
+
if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
|
|
278
|
+
_a = headerParameters;
|
|
279
|
+
_b = "X-Tapis-Token";
|
|
280
|
+
return [4 /*yield*/, this.configuration.apiKey("X-Tapis-Token")];
|
|
264
281
|
case 1:
|
|
265
|
-
|
|
266
|
-
|
|
282
|
+
_a[_b] = _c.sent(); // TapisJWT authentication
|
|
283
|
+
_c.label = 2;
|
|
284
|
+
case 2: return [4 /*yield*/, this.request({
|
|
285
|
+
path: "/v3/systems/credential/{systemId}/globus/authUrl".replace("{".concat("systemId", "}"), encodeURIComponent(String(requestParameters['systemId']))),
|
|
286
|
+
method: 'GET',
|
|
287
|
+
headers: headerParameters,
|
|
288
|
+
query: queryParameters,
|
|
289
|
+
}, initOverrides)];
|
|
290
|
+
case 3:
|
|
291
|
+
response = _c.sent();
|
|
292
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.RespGlobusAuthUrlFromJSON)(jsonValue); })];
|
|
267
293
|
}
|
|
268
294
|
});
|
|
269
295
|
});
|
|
270
296
|
};
|
|
271
297
|
/**
|
|
272
|
-
* Retrieve a Globus URL + Session Id that can be used to generate an oauth2 authorization code associated with the given system. In Globus, the code is referred to as a *Native App Authorization Code*. The host property of the system is used as the Globus Endpoint Id or Globus Collection 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. The authorization code, as per Globus documentation, is valid for 10 minutes. Please note that the Tapis installation for your site must be configured by the site administrator to support systems of type GLOBUS.
|
|
298
|
+
* Retrieve a Globus URL + Session Id that can be used to generate an oauth2 authorization code associated with the given system. System must be of type GLOBUS. In Globus, the code is referred to as a *Native App Authorization Code*. The host property of the system is used as the Globus Endpoint Id or Globus Collection 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. The authorization code, as per Globus documentation, is valid for 10 minutes. Please note that the Tapis installation for your site must be configured by the site administrator to support systems of type GLOBUS.
|
|
273
299
|
* Retrieve a Globus URL that can be used to generate an authorization code for an OAuth2 flow.
|
|
274
300
|
*/
|
|
275
301
|
CredentialsApi.prototype.getGlobusAuthUrl = function (requestParameters, initOverrides) {
|
|
@@ -287,43 +313,47 @@ var CredentialsApi = /** @class */ (function (_super) {
|
|
|
287
313
|
});
|
|
288
314
|
};
|
|
289
315
|
/**
|
|
290
|
-
* 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 there may me a mapping of the Tapis user to a host *loginUser
|
|
316
|
+
* 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 there may me a mapping of the Tapis user to a host *loginUser* and what we call the *Tapis user* comes from the username claim in the Tapis JWT. 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*. 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.
|
|
291
317
|
*/
|
|
292
318
|
CredentialsApi.prototype.getUserCredentialRaw = function (requestParameters, initOverrides) {
|
|
293
319
|
return __awaiter(this, void 0, void 0, function () {
|
|
294
|
-
var queryParameters, headerParameters, response;
|
|
295
|
-
return __generator(this, function (
|
|
296
|
-
switch (
|
|
320
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
321
|
+
return __generator(this, function (_c) {
|
|
322
|
+
switch (_c.label) {
|
|
297
323
|
case 0:
|
|
298
|
-
if (requestParameters
|
|
299
|
-
throw new runtime.RequiredError('systemId', 'Required parameter
|
|
324
|
+
if (requestParameters['systemId'] == null) {
|
|
325
|
+
throw new runtime.RequiredError('systemId', 'Required parameter "systemId" was null or undefined when calling getUserCredential().');
|
|
300
326
|
}
|
|
301
|
-
if (requestParameters
|
|
302
|
-
throw new runtime.RequiredError('userName', 'Required parameter
|
|
327
|
+
if (requestParameters['userName'] == null) {
|
|
328
|
+
throw new runtime.RequiredError('userName', 'Required parameter "userName" was null or undefined when calling getUserCredential().');
|
|
303
329
|
}
|
|
304
330
|
queryParameters = {};
|
|
305
|
-
if (requestParameters
|
|
306
|
-
queryParameters['authnMethod'] = requestParameters
|
|
331
|
+
if (requestParameters['authnMethod'] != null) {
|
|
332
|
+
queryParameters['authnMethod'] = requestParameters['authnMethod'];
|
|
307
333
|
}
|
|
308
334
|
headerParameters = {};
|
|
309
|
-
if (this.configuration && this.configuration.apiKey)
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
return [4 /*yield*/, this.
|
|
313
|
-
path: "/v3/systems/credential/{systemId}/user/{userName}".replace("{" + "systemId" + "}", encodeURIComponent(String(requestParameters.systemId))).replace("{" + "userName" + "}", encodeURIComponent(String(requestParameters.userName))),
|
|
314
|
-
method: 'GET',
|
|
315
|
-
headers: headerParameters,
|
|
316
|
-
query: queryParameters,
|
|
317
|
-
}, initOverrides)];
|
|
335
|
+
if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
|
|
336
|
+
_a = headerParameters;
|
|
337
|
+
_b = "X-Tapis-Token";
|
|
338
|
+
return [4 /*yield*/, this.configuration.apiKey("X-Tapis-Token")];
|
|
318
339
|
case 1:
|
|
319
|
-
|
|
320
|
-
|
|
340
|
+
_a[_b] = _c.sent(); // TapisJWT authentication
|
|
341
|
+
_c.label = 2;
|
|
342
|
+
case 2: return [4 /*yield*/, this.request({
|
|
343
|
+
path: "/v3/systems/credential/{systemId}/user/{userName}".replace("{".concat("systemId", "}"), encodeURIComponent(String(requestParameters['systemId']))).replace("{".concat("userName", "}"), encodeURIComponent(String(requestParameters['userName']))),
|
|
344
|
+
method: 'GET',
|
|
345
|
+
headers: headerParameters,
|
|
346
|
+
query: queryParameters,
|
|
347
|
+
}, initOverrides)];
|
|
348
|
+
case 3:
|
|
349
|
+
response = _c.sent();
|
|
350
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.RespCredentialFromJSON)(jsonValue); })];
|
|
321
351
|
}
|
|
322
352
|
});
|
|
323
353
|
});
|
|
324
354
|
};
|
|
325
355
|
/**
|
|
326
|
-
* 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 there may me a mapping of the Tapis user to a host *loginUser
|
|
356
|
+
* 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 there may me a mapping of the Tapis user to a host *loginUser* and what we call the *Tapis user* comes from the username claim in the Tapis JWT. 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*. 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.
|
|
327
357
|
*/
|
|
328
358
|
CredentialsApi.prototype.getUserCredential = function (requestParameters, initOverrides) {
|
|
329
359
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -344,30 +374,34 @@ var CredentialsApi = /** @class */ (function (_super) {
|
|
|
344
374
|
*/
|
|
345
375
|
CredentialsApi.prototype.removeUserCredentialRaw = function (requestParameters, initOverrides) {
|
|
346
376
|
return __awaiter(this, void 0, void 0, function () {
|
|
347
|
-
var queryParameters, headerParameters, response;
|
|
348
|
-
return __generator(this, function (
|
|
349
|
-
switch (
|
|
377
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
378
|
+
return __generator(this, function (_c) {
|
|
379
|
+
switch (_c.label) {
|
|
350
380
|
case 0:
|
|
351
|
-
if (requestParameters
|
|
352
|
-
throw new runtime.RequiredError('systemId', 'Required parameter
|
|
381
|
+
if (requestParameters['systemId'] == null) {
|
|
382
|
+
throw new runtime.RequiredError('systemId', 'Required parameter "systemId" was null or undefined when calling removeUserCredential().');
|
|
353
383
|
}
|
|
354
|
-
if (requestParameters
|
|
355
|
-
throw new runtime.RequiredError('userName', 'Required parameter
|
|
384
|
+
if (requestParameters['userName'] == null) {
|
|
385
|
+
throw new runtime.RequiredError('userName', 'Required parameter "userName" was null or undefined when calling removeUserCredential().');
|
|
356
386
|
}
|
|
357
387
|
queryParameters = {};
|
|
358
388
|
headerParameters = {};
|
|
359
|
-
if (this.configuration && this.configuration.apiKey)
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
return [4 /*yield*/, this.
|
|
363
|
-
path: "/v3/systems/credential/{systemId}/user/{userName}".replace("{" + "systemId" + "}", encodeURIComponent(String(requestParameters.systemId))).replace("{" + "userName" + "}", encodeURIComponent(String(requestParameters.userName))),
|
|
364
|
-
method: 'DELETE',
|
|
365
|
-
headers: headerParameters,
|
|
366
|
-
query: queryParameters,
|
|
367
|
-
}, initOverrides)];
|
|
389
|
+
if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
|
|
390
|
+
_a = headerParameters;
|
|
391
|
+
_b = "X-Tapis-Token";
|
|
392
|
+
return [4 /*yield*/, this.configuration.apiKey("X-Tapis-Token")];
|
|
368
393
|
case 1:
|
|
369
|
-
|
|
370
|
-
|
|
394
|
+
_a[_b] = _c.sent(); // TapisJWT authentication
|
|
395
|
+
_c.label = 2;
|
|
396
|
+
case 2: return [4 /*yield*/, this.request({
|
|
397
|
+
path: "/v3/systems/credential/{systemId}/user/{userName}".replace("{".concat("systemId", "}"), encodeURIComponent(String(requestParameters['systemId']))).replace("{".concat("userName", "}"), encodeURIComponent(String(requestParameters['userName']))),
|
|
398
|
+
method: 'DELETE',
|
|
399
|
+
headers: headerParameters,
|
|
400
|
+
query: queryParameters,
|
|
401
|
+
}, initOverrides)];
|
|
402
|
+
case 3:
|
|
403
|
+
response = _c.sent();
|
|
404
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.RespBasicFromJSON)(jsonValue); })];
|
|
371
405
|
}
|
|
372
406
|
});
|
|
373
407
|
});
|
|
@@ -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:
|
|
5
|
+
* The version of the OpenAPI document: 25Q4.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,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { RespBasic } from '../models';
|
|
13
|
+
import type { RespBasic } from '../models/index';
|
|
14
14
|
/**
|
|
15
15
|
*
|
|
16
16
|
*/
|
|
@@ -18,17 +18,17 @@ export declare class GeneralApi extends runtime.BaseAPI {
|
|
|
18
18
|
/**
|
|
19
19
|
* Health check. Lightweight non-authenticated check that service is alive.
|
|
20
20
|
*/
|
|
21
|
-
healthCheckRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>>;
|
|
21
|
+
healthCheckRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespBasic>>;
|
|
22
22
|
/**
|
|
23
23
|
* Health check. Lightweight non-authenticated check that service is alive.
|
|
24
24
|
*/
|
|
25
|
-
healthCheck(initOverrides?: RequestInit): Promise<RespBasic>;
|
|
25
|
+
healthCheck(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespBasic>;
|
|
26
26
|
/**
|
|
27
27
|
* Ready check. Non-authenticated check that service is ready to do work.
|
|
28
28
|
*/
|
|
29
|
-
readyCheckRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>>;
|
|
29
|
+
readyCheckRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespBasic>>;
|
|
30
30
|
/**
|
|
31
31
|
* Ready check. Non-authenticated check that service is ready to do work.
|
|
32
32
|
*/
|
|
33
|
-
readyCheck(initOverrides?: RequestInit): Promise<RespBasic>;
|
|
33
|
+
readyCheck(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespBasic>;
|
|
34
34
|
}
|