misp-client-rs 0.1.0

A Rust client library for interacting with MISP (Malware Information Sharing Platform) instances via their 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

# \AuthKeysApi

All URIs are relative to *https://misp.local*

Method | HTTP request | Description
------------- | ------------- | -------------
[**add_auth_key**](AuthKeysApi.md#add_auth_key) | **POST** /auth_keys/add/{userId} | Add auth keys
[**delete_auth_key**](AuthKeysApi.md#delete_auth_key) | **DELETE** /auth_keys/delete/{authKeyId} | Delete auth key
[**edit_auth_key**](AuthKeysApi.md#edit_auth_key) | **POST** /auth_keys/edit/{authKeyId} | Edit auth key
[**get_auth_key_by_id**](AuthKeysApi.md#get_auth_key_by_id) | **GET** /auth_keys/view/{authKeyId} | View auth key
[**get_auth_keys**](AuthKeysApi.md#get_auth_keys) | **GET** /auth_keys | Get auth keys
[**search_auth_keys**](AuthKeysApi.md#search_auth_keys) | **POST** /auth_keys | Search auth keys



## add_auth_key

> models::AddAuthKey200Response add_auth_key(user_id, add_auth_key_request)
Add auth keys

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | Numeric ID of the user | [required] |
**add_auth_key_request** | Option<[**AddAuthKeyRequest**](AddAuthKeyRequest.md)> |  |  |

### Return type

[**models::AddAuthKey200Response**](addAuthKey_200_response.md)

### Authorization

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

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


## delete_auth_key

> models::DeleteAuthKey200Response delete_auth_key(auth_key_id)
Delete auth key

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**auth_key_id** | **String** | UUID or numeric ID of the auth key | [required] |

### Return type

[**models::DeleteAuthKey200Response**](deleteAuthKey_200_response.md)

### Authorization

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

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


## edit_auth_key

> models::GetAuthKeyById200Response edit_auth_key(auth_key_id, edit_auth_key_request)
Edit auth key

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**auth_key_id** | **String** | UUID or numeric ID of the auth key | [required] |
**edit_auth_key_request** | Option<[**EditAuthKeyRequest**](EditAuthKeyRequest.md)> |  |  |

### Return type

[**models::GetAuthKeyById200Response**](getAuthKeyById_200_response.md)

### Authorization

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

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

> models::GetAuthKeyById200Response get_auth_key_by_id(auth_key_id)
View auth key

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**auth_key_id** | **String** | UUID or numeric ID of the auth key | [required] |

### Return type

[**models::GetAuthKeyById200Response**](getAuthKeyById_200_response.md)

### Authorization

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

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


## get_auth_keys

> Vec<models::GetAuthKeys200ResponseInner> get_auth_keys()
Get auth keys

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::GetAuthKeys200ResponseInner>**](getAuthKeys_200_response_inner.md)

### Authorization

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

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


## search_auth_keys

> Vec<models::GetAuthKeys200ResponseInner> search_auth_keys(search_auth_keys_request)
Search auth keys

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**search_auth_keys_request** | Option<[**SearchAuthKeysRequest**](SearchAuthKeysRequest.md)> |  |  |

### Return type

[**Vec<models::GetAuthKeys200ResponseInner>**](getAuthKeys_200_response_inner.md)

### Authorization

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

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