@tapis/tapis-typescript-systems 0.0.2 → 0.0.4
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 +19 -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 +51 -15
- package/dist/apis/CredentialsApi.js +170 -16
- package/dist/apis/GeneralApi.d.ts +5 -5
- package/dist/apis/GeneralApi.js +5 -11
- 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 +36 -46
- package/dist/apis/SystemsApi.js +89 -49
- 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/KeyValueInputModeEnum.d.ts +25 -0
- package/dist/models/KeyValueInputModeEnum.js +39 -0
- package/dist/models/KeyValuePair.d.ts +20 -1
- package/dist/models/KeyValuePair.js +8 -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 +18 -18
- package/dist/models/ReqPatchSystem.js +7 -7
- 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/ReqPostSystem.d.ts +220 -0
- package/dist/models/{ReqCreateSystem.js → ReqPostSystem.js} +16 -18
- package/dist/models/ReqPutSystem.d.ts +21 -21
- package/dist/models/ReqPutSystem.js +9 -9
- 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 +39 -0
- package/dist/models/ResultGlobusAuthUrl.js +45 -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 +3 -2
- package/dist/models/RuntimeTypeEnum.js +2 -1
- package/dist/models/SchedulerHiddenOptionEnum.d.ts +1 -1
- package/dist/models/SchedulerHiddenOptionEnum.js +1 -1
- package/dist/models/SchedulerProfile.d.ts +5 -11
- 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 +2 -2
- package/dist/models/SystemTypeEnum.js +2 -2
- package/dist/models/TapisSystem.d.ts +38 -26
- package/dist/models/TapisSystem.js +15 -11
- package/dist/models/index.d.ts +17 -3
- package/dist/models/index.js +17 -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 +160 -20
- package/src/apis/GeneralApi.ts +5 -13
- 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 +106 -55
- 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/KeyValueInputModeEnum.ts +38 -0
- package/src/models/KeyValuePair.ts +32 -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 +24 -24
- 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} +21 -25
- package/src/models/{ReqCreateSystem.ts → ReqPostSystem.ts} +77 -85
- package/src/models/ReqPutSystem.ts +32 -32
- 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 +72 -0
- package/src/models/ResultNameArray.ts +1 -1
- package/src/models/ResultResourceUrl.ts +1 -1
- package/src/models/RuntimeTypeEnum.ts +3 -2
- package/src/models/SchedulerHiddenOptionEnum.ts +1 -1
- package/src/models/SchedulerProfile.ts +10 -14
- 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 +2 -2
- package/src/models/TapisSystem.ts +52 -36
- package/src/models/index.ts +17 -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/ReqCreateSystem.d.ts +0 -226
|
@@ -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.6.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,44 @@
|
|
|
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
|
+
|
|
52
|
+
export interface GetGlobusAuthUrlRequest {
|
|
53
|
+
systemId: string;
|
|
54
|
+
}
|
|
55
|
+
|
|
36
56
|
export interface GetUserCredentialRequest {
|
|
37
57
|
systemId: string;
|
|
38
58
|
userName: string;
|
|
@@ -50,8 +70,49 @@ export interface RemoveUserCredentialRequest {
|
|
|
50
70
|
export class CredentialsApi extends runtime.BaseAPI {
|
|
51
71
|
|
|
52
72
|
/**
|
|
53
|
-
*
|
|
54
|
-
|
|
73
|
+
* 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.
|
|
74
|
+
*/
|
|
75
|
+
async checkUserCredentialRaw(requestParameters: CheckUserCredentialRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>> {
|
|
76
|
+
if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
|
|
77
|
+
throw new runtime.RequiredError('systemId','Required parameter requestParameters.systemId was null or undefined when calling checkUserCredential.');
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
if (requestParameters.userName === null || requestParameters.userName === undefined) {
|
|
81
|
+
throw new runtime.RequiredError('userName','Required parameter requestParameters.userName was null or undefined when calling checkUserCredential.');
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
const queryParameters: any = {};
|
|
85
|
+
|
|
86
|
+
if (requestParameters.authnMethod !== undefined) {
|
|
87
|
+
queryParameters['authnMethod'] = requestParameters.authnMethod;
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
91
|
+
|
|
92
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
93
|
+
headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
const response = await this.request({
|
|
97
|
+
path: `/v3/systems/credential/{systemId}/user/{userName}/check`.replace(`{${"systemId"}}`, encodeURIComponent(String(requestParameters.systemId))).replace(`{${"userName"}}`, encodeURIComponent(String(requestParameters.userName))),
|
|
98
|
+
method: 'POST',
|
|
99
|
+
headers: headerParameters,
|
|
100
|
+
query: queryParameters,
|
|
101
|
+
}, initOverrides);
|
|
102
|
+
|
|
103
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => RespBasicFromJSON(jsonValue));
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
/**
|
|
107
|
+
* 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.
|
|
108
|
+
*/
|
|
109
|
+
async checkUserCredential(requestParameters: CheckUserCredentialRequest, initOverrides?: RequestInit): Promise<RespBasic> {
|
|
110
|
+
const response = await this.checkUserCredentialRaw(requestParameters, initOverrides);
|
|
111
|
+
return await response.value();
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
/**
|
|
115
|
+
* 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.
|
|
55
116
|
*/
|
|
56
117
|
async createUserCredentialRaw(requestParameters: CreateUserCredentialRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>> {
|
|
57
118
|
if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
|
|
@@ -62,8 +123,8 @@ export class CredentialsApi extends runtime.BaseAPI {
|
|
|
62
123
|
throw new runtime.RequiredError('userName','Required parameter requestParameters.userName was null or undefined when calling createUserCredential.');
|
|
63
124
|
}
|
|
64
125
|
|
|
65
|
-
if (requestParameters.
|
|
66
|
-
throw new runtime.RequiredError('
|
|
126
|
+
if (requestParameters.reqUpdateCredential === null || requestParameters.reqUpdateCredential === undefined) {
|
|
127
|
+
throw new runtime.RequiredError('reqUpdateCredential','Required parameter requestParameters.reqUpdateCredential was null or undefined when calling createUserCredential.');
|
|
67
128
|
}
|
|
68
129
|
|
|
69
130
|
const queryParameters: any = {};
|
|
@@ -85,15 +146,14 @@ export class CredentialsApi extends runtime.BaseAPI {
|
|
|
85
146
|
method: 'POST',
|
|
86
147
|
headers: headerParameters,
|
|
87
148
|
query: queryParameters,
|
|
88
|
-
body:
|
|
149
|
+
body: ReqUpdateCredentialToJSON(requestParameters.reqUpdateCredential),
|
|
89
150
|
}, initOverrides);
|
|
90
151
|
|
|
91
152
|
return new runtime.JSONApiResponse(response, (jsonValue) => RespBasicFromJSON(jsonValue));
|
|
92
153
|
}
|
|
93
154
|
|
|
94
155
|
/**
|
|
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
|
|
156
|
+
* 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.
|
|
97
157
|
*/
|
|
98
158
|
async createUserCredential(requestParameters: CreateUserCredentialRequest, initOverrides?: RequestInit): Promise<RespBasic> {
|
|
99
159
|
const response = await this.createUserCredentialRaw(requestParameters, initOverrides);
|
|
@@ -101,8 +161,91 @@ export class CredentialsApi extends runtime.BaseAPI {
|
|
|
101
161
|
}
|
|
102
162
|
|
|
103
163
|
/**
|
|
104
|
-
*
|
|
105
|
-
*
|
|
164
|
+
* 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.
|
|
165
|
+
* Use a Globus authorization code + Tapis session Id to generate tokens
|
|
166
|
+
*/
|
|
167
|
+
async generateGlobusTokensRaw(requestParameters: GenerateGlobusTokensRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>> {
|
|
168
|
+
if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
|
|
169
|
+
throw new runtime.RequiredError('systemId','Required parameter requestParameters.systemId was null or undefined when calling generateGlobusTokens.');
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
if (requestParameters.userName === null || requestParameters.userName === undefined) {
|
|
173
|
+
throw new runtime.RequiredError('userName','Required parameter requestParameters.userName was null or undefined when calling generateGlobusTokens.');
|
|
174
|
+
}
|
|
175
|
+
|
|
176
|
+
if (requestParameters.authCode === null || requestParameters.authCode === undefined) {
|
|
177
|
+
throw new runtime.RequiredError('authCode','Required parameter requestParameters.authCode was null or undefined when calling generateGlobusTokens.');
|
|
178
|
+
}
|
|
179
|
+
|
|
180
|
+
if (requestParameters.sessionId === null || requestParameters.sessionId === undefined) {
|
|
181
|
+
throw new runtime.RequiredError('sessionId','Required parameter requestParameters.sessionId was null or undefined when calling generateGlobusTokens.');
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
const queryParameters: any = {};
|
|
185
|
+
|
|
186
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
187
|
+
|
|
188
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
189
|
+
headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
const response = await this.request({
|
|
193
|
+
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))),
|
|
194
|
+
method: 'POST',
|
|
195
|
+
headers: headerParameters,
|
|
196
|
+
query: queryParameters,
|
|
197
|
+
}, initOverrides);
|
|
198
|
+
|
|
199
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => RespBasicFromJSON(jsonValue));
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
/**
|
|
203
|
+
* 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.
|
|
204
|
+
* Use a Globus authorization code + Tapis session Id to generate tokens
|
|
205
|
+
*/
|
|
206
|
+
async generateGlobusTokens(requestParameters: GenerateGlobusTokensRequest, initOverrides?: RequestInit): Promise<RespBasic> {
|
|
207
|
+
const response = await this.generateGlobusTokensRaw(requestParameters, initOverrides);
|
|
208
|
+
return await response.value();
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
/**
|
|
212
|
+
* 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.
|
|
213
|
+
* Retrieve a Globus URL that can be used to generate an authorization code for an OAuth2 flow.
|
|
214
|
+
*/
|
|
215
|
+
async getGlobusAuthUrlRaw(requestParameters: GetGlobusAuthUrlRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespGlobusAuthUrl>> {
|
|
216
|
+
if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
|
|
217
|
+
throw new runtime.RequiredError('systemId','Required parameter requestParameters.systemId was null or undefined when calling getGlobusAuthUrl.');
|
|
218
|
+
}
|
|
219
|
+
|
|
220
|
+
const queryParameters: any = {};
|
|
221
|
+
|
|
222
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
223
|
+
|
|
224
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
225
|
+
headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
const response = await this.request({
|
|
229
|
+
path: `/v3/systems/credential/{systemId}/globus/authUrl`.replace(`{${"systemId"}}`, encodeURIComponent(String(requestParameters.systemId))),
|
|
230
|
+
method: 'GET',
|
|
231
|
+
headers: headerParameters,
|
|
232
|
+
query: queryParameters,
|
|
233
|
+
}, initOverrides);
|
|
234
|
+
|
|
235
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => RespGlobusAuthUrlFromJSON(jsonValue));
|
|
236
|
+
}
|
|
237
|
+
|
|
238
|
+
/**
|
|
239
|
+
* 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.
|
|
240
|
+
* Retrieve a Globus URL that can be used to generate an authorization code for an OAuth2 flow.
|
|
241
|
+
*/
|
|
242
|
+
async getGlobusAuthUrl(requestParameters: GetGlobusAuthUrlRequest, initOverrides?: RequestInit): Promise<RespGlobusAuthUrl> {
|
|
243
|
+
const response = await this.getGlobusAuthUrlRaw(requestParameters, initOverrides);
|
|
244
|
+
return await response.value();
|
|
245
|
+
}
|
|
246
|
+
|
|
247
|
+
/**
|
|
248
|
+
* 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*. 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.
|
|
106
249
|
*/
|
|
107
250
|
async getUserCredentialRaw(requestParameters: GetUserCredentialRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespCredential>> {
|
|
108
251
|
if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
|
|
@@ -136,8 +279,7 @@ export class CredentialsApi extends runtime.BaseAPI {
|
|
|
136
279
|
}
|
|
137
280
|
|
|
138
281
|
/**
|
|
139
|
-
*
|
|
140
|
-
* Retrieve user credentials for a system and target user
|
|
282
|
+
* 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*. 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.
|
|
141
283
|
*/
|
|
142
284
|
async getUserCredential(requestParameters: GetUserCredentialRequest, initOverrides?: RequestInit): Promise<RespCredential> {
|
|
143
285
|
const response = await this.getUserCredentialRaw(requestParameters, initOverrides);
|
|
@@ -145,8 +287,7 @@ export class CredentialsApi extends runtime.BaseAPI {
|
|
|
145
287
|
}
|
|
146
288
|
|
|
147
289
|
/**
|
|
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
|
|
290
|
+
* Remove credentials from the Security Kernel for given system and *target user*. Requester must be owner of the system. 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.
|
|
150
291
|
*/
|
|
151
292
|
async removeUserCredentialRaw(requestParameters: RemoveUserCredentialRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>> {
|
|
152
293
|
if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
|
|
@@ -176,8 +317,7 @@ export class CredentialsApi extends runtime.BaseAPI {
|
|
|
176
317
|
}
|
|
177
318
|
|
|
178
319
|
/**
|
|
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
|
|
320
|
+
* Remove credentials from the Security Kernel for given system and *target user*. Requester must be owner of the system. 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.
|
|
181
321
|
*/
|
|
182
322
|
async removeUserCredential(requestParameters: RemoveUserCredentialRequest, initOverrides?: RequestInit): Promise<RespBasic> {
|
|
183
323
|
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.6.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,17 +26,13 @@ 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 = {};
|
|
33
33
|
|
|
34
34
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
35
35
|
|
|
36
|
-
if (this.configuration && this.configuration.apiKey) {
|
|
37
|
-
headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
|
|
38
|
-
}
|
|
39
|
-
|
|
40
36
|
const response = await this.request({
|
|
41
37
|
path: `/v3/systems/healthcheck`,
|
|
42
38
|
method: 'GET',
|
|
@@ -48,7 +44,7 @@ export class GeneralApi extends runtime.BaseAPI {
|
|
|
48
44
|
}
|
|
49
45
|
|
|
50
46
|
/**
|
|
51
|
-
* Health check.
|
|
47
|
+
* Health check. Lightweight non-authenticated check that service is alive.
|
|
52
48
|
*/
|
|
53
49
|
async healthCheck(initOverrides?: RequestInit): Promise<RespBasic> {
|
|
54
50
|
const response = await this.healthCheckRaw(initOverrides);
|
|
@@ -56,17 +52,13 @@ export class GeneralApi extends runtime.BaseAPI {
|
|
|
56
52
|
}
|
|
57
53
|
|
|
58
54
|
/**
|
|
59
|
-
* Ready check.
|
|
55
|
+
* Ready check. Non-authenticated check that service is ready to do work.
|
|
60
56
|
*/
|
|
61
57
|
async readyCheckRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>> {
|
|
62
58
|
const queryParameters: any = {};
|
|
63
59
|
|
|
64
60
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
65
61
|
|
|
66
|
-
if (this.configuration && this.configuration.apiKey) {
|
|
67
|
-
headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
|
|
68
|
-
}
|
|
69
|
-
|
|
70
62
|
const response = await this.request({
|
|
71
63
|
path: `/v3/systems/readycheck`,
|
|
72
64
|
method: 'GET',
|
|
@@ -78,7 +70,7 @@ export class GeneralApi extends runtime.BaseAPI {
|
|
|
78
70
|
}
|
|
79
71
|
|
|
80
72
|
/**
|
|
81
|
-
* Ready check.
|
|
73
|
+
* Ready check. Non-authenticated check that service is ready to do work.
|
|
82
74
|
*/
|
|
83
75
|
async readyCheck(initOverrides?: RequestInit): Promise<RespBasic> {
|
|
84
76
|
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.6.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);
|
|
@@ -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.6.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,9 +15,9 @@
|
|
|
15
15
|
|
|
16
16
|
import * as runtime from '../runtime';
|
|
17
17
|
import {
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
18
|
+
ReqPostSchedulerProfile,
|
|
19
|
+
ReqPostSchedulerProfileFromJSON,
|
|
20
|
+
ReqPostSchedulerProfileToJSON,
|
|
21
21
|
RespBasic,
|
|
22
22
|
RespBasicFromJSON,
|
|
23
23
|
RespBasicToJSON,
|
|
@@ -36,7 +36,7 @@ import {
|
|
|
36
36
|
} from '../models';
|
|
37
37
|
|
|
38
38
|
export interface CreateSchedulerProfileRequest {
|
|
39
|
-
|
|
39
|
+
reqPostSchedulerProfile: ReqPostSchedulerProfile;
|
|
40
40
|
}
|
|
41
41
|
|
|
42
42
|
export interface DeleteSchedulerProfileRequest {
|
|
@@ -53,12 +53,11 @@ export interface GetSchedulerProfileRequest {
|
|
|
53
53
|
export class SchedulerProfilesApi extends runtime.BaseAPI {
|
|
54
54
|
|
|
55
55
|
/**
|
|
56
|
-
* Create a scheduler profile using a request body. Name must be unique within a tenant and can be composed of alphanumeric characters and the following special characters [-._~]. Name must begin with an alphabetic character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters. Note that certain attributes (such as tenant) are allowed but ignored so that the JSON result returned by a GET may be modified and used when making a POST request to create a profile. The attributes that are allowed but ignored are - tenant - uuid - created - updated
|
|
57
|
-
* Create a scheduler profile
|
|
56
|
+
* Create a scheduler profile using a request body. Name must be unique within a tenant and can be composed of alphanumeric characters and the following special characters [-._~]. Name must begin with an alphabetic character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters. Note that certain attributes (such as *tenant*) are allowed but ignored so that the JSON result returned by a GET may be modified and used when making a POST request to create a profile. The attributes that are allowed but ignored are - tenant - uuid - created - updated
|
|
58
57
|
*/
|
|
59
58
|
async createSchedulerProfileRaw(requestParameters: CreateSchedulerProfileRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespResourceUrl>> {
|
|
60
|
-
if (requestParameters.
|
|
61
|
-
throw new runtime.RequiredError('
|
|
59
|
+
if (requestParameters.reqPostSchedulerProfile === null || requestParameters.reqPostSchedulerProfile === undefined) {
|
|
60
|
+
throw new runtime.RequiredError('reqPostSchedulerProfile','Required parameter requestParameters.reqPostSchedulerProfile was null or undefined when calling createSchedulerProfile.');
|
|
62
61
|
}
|
|
63
62
|
|
|
64
63
|
const queryParameters: any = {};
|
|
@@ -76,15 +75,14 @@ export class SchedulerProfilesApi extends runtime.BaseAPI {
|
|
|
76
75
|
method: 'POST',
|
|
77
76
|
headers: headerParameters,
|
|
78
77
|
query: queryParameters,
|
|
79
|
-
body:
|
|
78
|
+
body: ReqPostSchedulerProfileToJSON(requestParameters.reqPostSchedulerProfile),
|
|
80
79
|
}, initOverrides);
|
|
81
80
|
|
|
82
81
|
return new runtime.JSONApiResponse(response, (jsonValue) => RespResourceUrlFromJSON(jsonValue));
|
|
83
82
|
}
|
|
84
83
|
|
|
85
84
|
/**
|
|
86
|
-
* Create a scheduler profile using a request body. Name must be unique within a tenant and can be composed of alphanumeric characters and the following special characters [-._~]. Name must begin with an alphabetic character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters. Note that certain attributes (such as tenant) are allowed but ignored so that the JSON result returned by a GET may be modified and used when making a POST request to create a profile. The attributes that are allowed but ignored are - tenant - uuid - created - updated
|
|
87
|
-
* Create a scheduler profile
|
|
85
|
+
* Create a scheduler profile using a request body. Name must be unique within a tenant and can be composed of alphanumeric characters and the following special characters [-._~]. Name must begin with an alphabetic character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters. Note that certain attributes (such as *tenant*) are allowed but ignored so that the JSON result returned by a GET may be modified and used when making a POST request to create a profile. The attributes that are allowed but ignored are - tenant - uuid - created - updated
|
|
88
86
|
*/
|
|
89
87
|
async createSchedulerProfile(requestParameters: CreateSchedulerProfileRequest, initOverrides?: RequestInit): Promise<RespResourceUrl> {
|
|
90
88
|
const response = await this.createSchedulerProfileRaw(requestParameters, initOverrides);
|
|
@@ -93,7 +91,6 @@ export class SchedulerProfilesApi extends runtime.BaseAPI {
|
|
|
93
91
|
|
|
94
92
|
/**
|
|
95
93
|
* Remove a scheduler profile given the profile name. Requester must be owner of the profile.
|
|
96
|
-
* Delete a scheduler profile
|
|
97
94
|
*/
|
|
98
95
|
async deleteSchedulerProfileRaw(requestParameters: DeleteSchedulerProfileRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>> {
|
|
99
96
|
if (requestParameters.name === null || requestParameters.name === undefined) {
|
|
@@ -120,7 +117,6 @@ export class SchedulerProfilesApi extends runtime.BaseAPI {
|
|
|
120
117
|
|
|
121
118
|
/**
|
|
122
119
|
* Remove a scheduler profile given the profile name. Requester must be owner of the profile.
|
|
123
|
-
* Delete a scheduler profile
|
|
124
120
|
*/
|
|
125
121
|
async deleteSchedulerProfile(requestParameters: DeleteSchedulerProfileRequest, initOverrides?: RequestInit): Promise<RespChangeCount> {
|
|
126
122
|
const response = await this.deleteSchedulerProfileRaw(requestParameters, initOverrides);
|
|
@@ -129,7 +125,6 @@ export class SchedulerProfilesApi extends runtime.BaseAPI {
|
|
|
129
125
|
|
|
130
126
|
/**
|
|
131
127
|
* Retrieve information for a scheduler profile given the profile name.
|
|
132
|
-
* Retrieve a scheduler profile
|
|
133
128
|
*/
|
|
134
129
|
async getSchedulerProfileRaw(requestParameters: GetSchedulerProfileRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSchedulerProfile>> {
|
|
135
130
|
if (requestParameters.name === null || requestParameters.name === undefined) {
|
|
@@ -156,7 +151,6 @@ export class SchedulerProfilesApi extends runtime.BaseAPI {
|
|
|
156
151
|
|
|
157
152
|
/**
|
|
158
153
|
* Retrieve information for a scheduler profile given the profile name.
|
|
159
|
-
* Retrieve a scheduler profile
|
|
160
154
|
*/
|
|
161
155
|
async getSchedulerProfile(requestParameters: GetSchedulerProfileRequest, initOverrides?: RequestInit): Promise<RespSchedulerProfile> {
|
|
162
156
|
const response = await this.getSchedulerProfileRaw(requestParameters, initOverrides);
|
|
@@ -165,7 +159,6 @@ export class SchedulerProfilesApi extends runtime.BaseAPI {
|
|
|
165
159
|
|
|
166
160
|
/**
|
|
167
161
|
* Retrieve list of scheduler profiles.
|
|
168
|
-
* Retrieve scheduler profiles
|
|
169
162
|
*/
|
|
170
163
|
async getSchedulerProfilesRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSchedulerProfiles>> {
|
|
171
164
|
const queryParameters: any = {};
|
|
@@ -188,7 +181,6 @@ export class SchedulerProfilesApi extends runtime.BaseAPI {
|
|
|
188
181
|
|
|
189
182
|
/**
|
|
190
183
|
* Retrieve list of scheduler profiles.
|
|
191
|
-
* Retrieve scheduler profiles
|
|
192
184
|
*/
|
|
193
185
|
async getSchedulerProfiles(initOverrides?: RequestInit): Promise<RespSchedulerProfiles> {
|
|
194
186
|
const response = await this.getSchedulerProfilesRaw(initOverrides);
|