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

# \OrganisationsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**add_organisation**](OrganisationsApi.md#add_organisation) | **POST** /admin/organisations/add | Add organisation
[**delete_organisation**](OrganisationsApi.md#delete_organisation) | **DELETE** /admin/organisations/delete/{organisationId} | Delete organisation
[**edit_organisation**](OrganisationsApi.md#edit_organisation) | **PUT** /admin/organisations/edit/{organisationId} | Edit organisation
[**get_organisation_by_id**](OrganisationsApi.md#get_organisation_by_id) | **GET** /organisations/view/{organisationId} | Get organisation by ID
[**get_organisations**](OrganisationsApi.md#get_organisations) | **GET** /organisations | Get organisations



## add_organisation

> models::Organisation add_organisation(organisation_no_id)
Add organisation

### Parameters


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

### Return type

[**models::Organisation**](Organisation.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_organisation

> models::DeleteOrganisation200Response delete_organisation(organisation_id)
Delete organisation

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**organisation_id** | **String** | UUID or numeric ID of the organisation | [required] |

### Return type

[**models::DeleteOrganisation200Response**](deleteOrganisation_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_organisation

> models::Organisation edit_organisation(organisation_id, edit_organisation_request)
Edit organisation

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**organisation_id** | **String** | UUID or numeric ID of the organisation | [required] |
**edit_organisation_request** | Option<[**EditOrganisationRequest**](EditOrganisationRequest.md)> |  |  |

### Return type

[**models::Organisation**](Organisation.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_organisation_by_id

> models::Organisation get_organisation_by_id(organisation_id)
Get organisation by ID

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**organisation_id** | **String** | UUID or numeric ID of the organisation | [required] |

### Return type

[**models::Organisation**](Organisation.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_organisations

> Vec<models::OrganisationListItem> get_organisations()
Get organisations

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::OrganisationListItem>**](OrganisationListItem.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)