about summary refs log tree commit diff stats
path: root/crates/rocie-client/docs/ApiSetNoAuthUserApi.md
blob: 4cfc846575bed0bed8cba6f0c690a5549f2a261c (plain) (blame)
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
# \\ApiSetNoAuthUserApi

All URIs are relative to _http://localhost_

| Method                                            | HTTP request        | Description               |
| ------------------------------------------------- | ------------------- | ------------------------- |
| [**login**](ApiSetNoAuthUserApi.md#login)         | **POST** /login     | Log in as a specific user |
| [**logout**](ApiSetNoAuthUserApi.md#logout)       | **POST** /logout    | Log the current user out  |
| [**provision**](ApiSetNoAuthUserApi.md#provision) | **POST** /provision | Provision this instance.  |

## login

> login(login_info) Log in as a specific user

### Parameters

| Name           | Type                          | Description | Required   | Notes |
| -------------- | ----------------------------- | ----------- | ---------- | ----- |
| **login_info** | [**LoginInfo**](LoginInfo.md) |             | [required] |

### Return type

(empty response body)

### Authorization

No authorization required

### HTTP request headers

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

[[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() Log the current user out

### 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**: text/plain

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

## provision

> models::UserId provision(user_stub) Provision this instance.

This only works, if no users exist yet.

### Parameters

| Name          | Type                        | Description | Required   | Notes |
| ------------- | --------------------------- | ----------- | ---------- | ----- |
| **user_stub** | [**UserStub**](UserStub.md) |             | [required] |

### Return type

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

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, text/plain

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