artifact-keeper-client 1.1.2

Rust client for the Artifact Keeper REST 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

# \AuthApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_api_token**](AuthApi.md#create_api_token) | **POST** /api/v1/auth/tokens | Create a new API token for the current user
[**create_download_ticket**](AuthApi.md#create_download_ticket) | **POST** /api/v1/auth/ticket | Create a short-lived, single-use download/stream ticket for the current user. The ticket can be passed as a `?ticket=` query parameter on endpoints that cannot use `Authorization` headers (e.g. `<a>` downloads, `EventSource` SSE).
[**disable_totp**](AuthApi.md#disable_totp) | **POST** /api/v1/auth/totp/disable | Disable TOTP for the authenticated user (requires password and current TOTP code)
[**enable_totp**](AuthApi.md#enable_totp) | **POST** /api/v1/auth/totp/enable | Enable TOTP by verifying the initial code and generating backup codes
[**get_current_user**](AuthApi.md#get_current_user) | **GET** /api/v1/auth/me | Get current user info
[**login**](AuthApi.md#login) | **POST** /api/v1/auth/login | Login with credentials
[**logout**](AuthApi.md#logout) | **POST** /api/v1/auth/logout | Logout current session
[**refresh_token**](AuthApi.md#refresh_token) | **POST** /api/v1/auth/refresh | Refresh access token
[**revoke_api_token**](AuthApi.md#revoke_api_token) | **DELETE** /api/v1/auth/tokens/{token_id} | Revoke an API token
[**setup_status**](AuthApi.md#setup_status) | **GET** /api/v1/setup/status | Returns whether initial setup (password change) is required.
[**setup_totp**](AuthApi.md#setup_totp) | **POST** /api/v1/auth/totp/setup | Generate a new TOTP secret and QR code URL for the authenticated user
[**verify_totp**](AuthApi.md#verify_totp) | **POST** /api/v1/auth/totp/verify | Verify TOTP code during login (exchanges totp_token + code for full auth tokens)



## create_api_token

> models::CreateApiTokenResponse create_api_token(create_api_token_request)
Create a new API token for the current user

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_api_token_request** | [**CreateApiTokenRequest**](CreateApiTokenRequest.md) |  | [required] |

### Return type

[**models::CreateApiTokenResponse**](CreateApiTokenResponse.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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)


## create_download_ticket

> models::TicketResponse create_download_ticket(create_ticket_request)
Create a short-lived, single-use download/stream ticket for the current user. The ticket can be passed as a `?ticket=` query parameter on endpoints that cannot use `Authorization` headers (e.g. `<a>` downloads, `EventSource` SSE).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_ticket_request** | [**CreateTicketRequest**](CreateTicketRequest.md) |  | [required] |

### Return type

[**models::TicketResponse**](TicketResponse.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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)


## disable_totp

> disable_totp(totp_disable_request)
Disable TOTP for the authenticated user (requires password and current TOTP code)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**totp_disable_request** | [**TotpDisableRequest**](TotpDisableRequest.md) |  | [required] |

### Return type

 (empty response body)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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)


## enable_totp

> models::TotpEnableResponse enable_totp(totp_code_request)
Enable TOTP by verifying the initial code and generating backup codes

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**totp_code_request** | [**TotpCodeRequest**](TotpCodeRequest.md) |  | [required] |

### Return type

[**models::TotpEnableResponse**](TotpEnableResponse.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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)


## get_current_user

> models::UserResponse get_current_user()
Get current user info

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::UserResponse**](UserResponse.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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)


## login

> models::LoginResponse login(login_request)
Login with credentials

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**login_request** | [**LoginRequest**](LoginRequest.md) |  | [required] |

### Return type

[**models::LoginResponse**](LoginResponse.md)

### Authorization

No authorization required

### 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)


## logout

> logout()
Logout current session

### Parameters

This endpoint does not need any parameter.

### Return type

 (empty response body)

### Authorization

No authorization required

### 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)


## refresh_token

> models::LoginResponse refresh_token(refresh_token_request)
Refresh access token

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**refresh_token_request** | [**RefreshTokenRequest**](RefreshTokenRequest.md) |  | [required] |

### Return type

[**models::LoginResponse**](LoginResponse.md)

### Authorization

No authorization required

### 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)


## revoke_api_token

> revoke_api_token(token_id)
Revoke an API token

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**token_id** | **uuid::Uuid** | ID of the API token to revoke | [required] |

### Return type

 (empty response body)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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)


## setup_status

> models::SetupStatusResponse setup_status()
Returns whether initial setup (password change) is required.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::SetupStatusResponse**](SetupStatusResponse.md)

### Authorization

No authorization required

### 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)


## setup_totp

> models::TotpSetupResponse setup_totp()
Generate a new TOTP secret and QR code URL for the authenticated user

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::TotpSetupResponse**](TotpSetupResponse.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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)


## verify_totp

> models::LoginResponse verify_totp(totp_verify_request)
Verify TOTP code during login (exchanges totp_token + code for full auth tokens)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**totp_verify_request** | [**TotpVerifyRequest**](TotpVerifyRequest.md) |  | [required] |

### Return type

[**models::LoginResponse**](LoginResponse.md)

### Authorization

No authorization required

### 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)