rusttwald 0.1.1

Inofficial Rust API client for the mittwald. API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367

# \SshsftpUserApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**sftp_user_create_sftp_user**](SshsftpUserApi.md#sftp_user_create_sftp_user) | **POST** /v2/projects/{projectId}/sftp-users | Create an SFTPUser for a Project.
[**sftp_user_delete_sftp_user**](SshsftpUserApi.md#sftp_user_delete_sftp_user) | **DELETE** /v2/sftp-users/{sftpUserId} | Delete an SFTPUser.
[**sftp_user_get_sftp_user**](SshsftpUserApi.md#sftp_user_get_sftp_user) | **GET** /v2/sftp-users/{sftpUserId} | Get an SFTPUser.
[**sftp_user_list_sftp_users**](SshsftpUserApi.md#sftp_user_list_sftp_users) | **GET** /v2/projects/{projectId}/sftp-users | Get all SFTPUsers for a Project.
[**sftp_user_update_sftp_user**](SshsftpUserApi.md#sftp_user_update_sftp_user) | **PATCH** /v2/sftp-users/{sftpUserId} | Update an SFTPUser.
[**ssh_user_create_ssh_user**](SshsftpUserApi.md#ssh_user_create_ssh_user) | **POST** /v2/projects/{projectId}/ssh-users | Create an SSHUser for a Project.
[**ssh_user_delete_ssh_user**](SshsftpUserApi.md#ssh_user_delete_ssh_user) | **DELETE** /v2/ssh-users/{sshUserId} | Delete an SSHUser.
[**ssh_user_get_ssh_user**](SshsftpUserApi.md#ssh_user_get_ssh_user) | **GET** /v2/ssh-users/{sshUserId} | Get an SSHUser.
[**ssh_user_list_ssh_users**](SshsftpUserApi.md#ssh_user_list_ssh_users) | **GET** /v2/projects/{projectId}/ssh-users | Get all SSHUsers for a Project.
[**ssh_user_update_ssh_user**](SshsftpUserApi.md#ssh_user_update_ssh_user) | **PATCH** /v2/ssh-users/{sshUserId} | Update an SSHUser.
[**v2_project_project_id_sftp_users_get**](SshsftpUserApi.md#v2_project_project_id_sftp_users_get) | **GET** /v2/project/{projectId}/sftp-users | Get all SFTPUsers for a Project.
[**v2_sshusers_ssh_user_id_patch**](SshsftpUserApi.md#v2_sshusers_ssh_user_id_patch) | **PATCH** /v2/sshusers/{sshUserId} | Update an SSHUser.



## sftp_user_create_sftp_user

> models::DePeriodMittwaldPeriodV1PeriodSshuserPeriodSftpUser sftp_user_create_sftp_user(project_id, sftp_user_create_sftp_user_request)
Create an SFTPUser for a Project.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | ID of the Project to create an SFTPUser for. | [required] |
**sftp_user_create_sftp_user_request** | [**SftpUserCreateSftpUserRequest**](SftpUserCreateSftpUserRequest.md) |  | [required] |

### Return type

[**models::DePeriodMittwaldPeriodV1PeriodSshuserPeriodSftpUser**](de.mittwald.v1.sshuser.SftpUser.md)

### Authorization

[de.mittwald.v1.commons.AccessToken](../README.md#de.mittwald.v1.commons.AccessToken)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## sftp_user_delete_sftp_user

> sftp_user_delete_sftp_user(sftp_user_id)
Delete an SFTPUser.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**sftp_user_id** | **String** | ID of the SFTPUser to be deleted. | [required] |

### Return type

 (empty response body)

### Authorization

[de.mittwald.v1.commons.AccessToken](../README.md#de.mittwald.v1.commons.AccessToken)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## sftp_user_get_sftp_user

> models::DePeriodMittwaldPeriodV1PeriodSshuserPeriodSftpUser sftp_user_get_sftp_user(sftp_user_id)
Get an SFTPUser.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**sftp_user_id** | **String** | ID of the SFTPUser to get. | [required] |

### Return type

[**models::DePeriodMittwaldPeriodV1PeriodSshuserPeriodSftpUser**](de.mittwald.v1.sshuser.SftpUser.md)

### Authorization

[de.mittwald.v1.commons.AccessToken](../README.md#de.mittwald.v1.commons.AccessToken)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## sftp_user_list_sftp_users

> Vec<models::DePeriodMittwaldPeriodV1PeriodSshuserPeriodSftpUser> sftp_user_list_sftp_users(project_id, limit, skip)
Get all SFTPUsers for a Project.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | ID of the Project to request SFTPUsers for. | [required] |
**limit** | Option<**i32**> |  |  |
**skip** | Option<**i32**> |  |  |

### Return type

[**Vec<models::DePeriodMittwaldPeriodV1PeriodSshuserPeriodSftpUser>**](de.mittwald.v1.sshuser.SftpUser.md)

### Authorization

[de.mittwald.v1.commons.AccessToken](../README.md#de.mittwald.v1.commons.AccessToken)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## sftp_user_update_sftp_user

> sftp_user_update_sftp_user(sftp_user_id, sftp_user_update_sftp_user_request)
Update an SFTPUser.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**sftp_user_id** | **String** | ID of the SFTPUser to be updated. | [required] |
**sftp_user_update_sftp_user_request** | Option<[**SftpUserUpdateSftpUserRequest**](SftpUserUpdateSftpUserRequest.md)> |  |  |

### Return type

 (empty response body)

### Authorization

[de.mittwald.v1.commons.AccessToken](../README.md#de.mittwald.v1.commons.AccessToken)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## ssh_user_create_ssh_user

> models::DePeriodMittwaldPeriodV1PeriodSshuserPeriodSshUser ssh_user_create_ssh_user(project_id, ssh_user_create_ssh_user_request)
Create an SSHUser for a Project.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | ID of the Project to create an SSHUser for. | [required] |
**ssh_user_create_ssh_user_request** | [**SshUserCreateSshUserRequest**](SshUserCreateSshUserRequest.md) |  | [required] |

### Return type

[**models::DePeriodMittwaldPeriodV1PeriodSshuserPeriodSshUser**](de.mittwald.v1.sshuser.SshUser.md)

### Authorization

[de.mittwald.v1.commons.AccessToken](../README.md#de.mittwald.v1.commons.AccessToken)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## ssh_user_delete_ssh_user

> ssh_user_delete_ssh_user(ssh_user_id)
Delete an SSHUser.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ssh_user_id** | **String** | ID of the SSHUser to be deleted. | [required] |

### Return type

 (empty response body)

### Authorization

[de.mittwald.v1.commons.AccessToken](../README.md#de.mittwald.v1.commons.AccessToken)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## ssh_user_get_ssh_user

> models::DePeriodMittwaldPeriodV1PeriodSshuserPeriodSshUser ssh_user_get_ssh_user(ssh_user_id)
Get an SSHUser.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ssh_user_id** | **String** | ID of the SSHUser to be retrieved. | [required] |

### Return type

[**models::DePeriodMittwaldPeriodV1PeriodSshuserPeriodSshUser**](de.mittwald.v1.sshuser.SshUser.md)

### Authorization

[de.mittwald.v1.commons.AccessToken](../README.md#de.mittwald.v1.commons.AccessToken)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## ssh_user_list_ssh_users

> Vec<models::DePeriodMittwaldPeriodV1PeriodSshuserPeriodSshUser> ssh_user_list_ssh_users(project_id, limit, skip)
Get all SSHUsers for a Project.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | ID of the Project to retrieve SSHUsers for. | [required] |
**limit** | Option<**i32**> |  |  |
**skip** | Option<**i32**> |  |  |

### Return type

[**Vec<models::DePeriodMittwaldPeriodV1PeriodSshuserPeriodSshUser>**](de.mittwald.v1.sshuser.SshUser.md)

### Authorization

[de.mittwald.v1.commons.AccessToken](../README.md#de.mittwald.v1.commons.AccessToken)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## ssh_user_update_ssh_user

> ssh_user_update_ssh_user(ssh_user_id, ssh_user_update_ssh_user_request)
Update an SSHUser.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ssh_user_id** | **String** | ID of the SSHUser to be updated. | [required] |
**ssh_user_update_ssh_user_request** | Option<[**SshUserUpdateSshUserRequest**](SshUserUpdateSshUserRequest.md)> |  |  |

### Return type

 (empty response body)

### Authorization

[de.mittwald.v1.commons.AccessToken](../README.md#de.mittwald.v1.commons.AccessToken)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## v2_project_project_id_sftp_users_get

> v2_project_project_id_sftp_users_get(project_id, limit, skip)
Get all SFTPUsers for a Project.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | ID of the Project to request SFTPUsers for. | [required] |
**limit** | Option<**i32**> |  |  |
**skip** | Option<**i32**> |  |  |

### Return type

 (empty response body)

### Authorization

[de.mittwald.v1.commons.AccessToken](../README.md#de.mittwald.v1.commons.AccessToken)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## v2_sshusers_ssh_user_id_patch

> v2_sshusers_ssh_user_id_patch(ssh_user_id, ssh_user_update_ssh_user_request)
Update an SSHUser.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ssh_user_id** | **String** | ID of the SSHUser to be updated. | [required] |
**ssh_user_update_ssh_user_request** | Option<[**SshUserUpdateSshUserRequest**](SshUserUpdateSshUserRequest.md)> |  |  |

### Return type

 (empty response body)

### Authorization

[de.mittwald.v1.commons.AccessToken](../README.md#de.mittwald.v1.commons.AccessToken)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)