misp_client_rs/models/
misp_setting.rs

1//!
2//! MISP Automation API
3//!
4//!  ### Getting Started  MISP API allows you to query, create, modify data models, such as [Events](https://www.circl.lu/doc/misp/GLOSSARY.html#misp-event), [Objects](https://www.circl.lu/doc/misp/misp-objects/), [Attributes](https://www.circl.lu/doc/misp/GLOSSARY.html#misp-attribute). This is extremly useful for interconnecting MISP with external tools and feeding other systems with threat intel data.  It also lets you perform administrative tasks such as creating users, organisations, altering MISP settings, and much more.  To get an API key there are several options: * **[UI]** Go to [My Profile -> Auth Keys](/auth_keys/index) section and click on `+ Add authentication key`  * **[UI]** As an admin go to the the [Administration -> List Users -> View](/admin/users/view/[id]) page of the user you want to create an auth key for and on the `Auth keys` section click on `+ Add authentication key`  * **[CLI]** Use the following command: `./app/Console/cake user change_authkey [e-mail/user_id]`  * **API** Provided you already have an admin level API key, you can create an API key for another user using the `[POST]/auth_keys/add/{{user_id}}` endpoint.  > **NOTE:** The authentication key will only be displayed once, so take note of it or store it properly in your application secrets.  #### Accept and Content-Type headers  When performing your request, depending on the type of request, you might need to explicitly specify in what content  type you want to get your results. This is done by setting one of the below `Accept` headers:      Accept: application/json     Accept: application/xml  When submitting data in a `POST`, `PUT` or `DELETE` operation you also need to specify in what content-type you encoded the payload.  This is done by setting one of the below `Content-Type` headers:      Content-Type: application/json     Content-Type: application/xml  Example: ``` curl  --header \"Authorization: YOUR_API_KEY\" \\       --header \"Accept: application/json\" \\       --header \"Content-Type: application/json\" https://<misp url>/  ```  > **NOTE**: By appending .json or .xml the content type can also be set without the need for a header.  #### Automation using PyMISP  [PyMISP](https://github.com/MISP/PyMISP) is a Python library to access MISP platforms via their REST [API](https://www.circl.lu/doc/misp/GLOSSARY.html#api). It allows you to fetch events, add or update events/attributes, add or update samples or search for attributes.  ### FAQ * [Dev FAQ](https://www.circl.lu/doc/misp/dev-faq/) * [GitHub project FAQ](https://github.com/MISP/MISP/wiki/Frequently-Asked-Questions) 
5//!
6//! The version of the OpenAPI document: 2.4
7//! 
8//! Generated by: https://openapi-generator.tech
9//! 
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct MispSetting {
16    #[serde(rename = "level", skip_serializing_if = "Option::is_none")]
17    pub level: Option<i32>,
18    #[serde(rename = "value", skip_serializing_if = "Option::is_none")]
19    pub value: Option<Box<models::MispSettingValue>>,
20    #[serde(rename = "errorMessage", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
21    pub error_message: Option<Option<String>>,
22    #[serde(rename = "test", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
23    pub test: Option<Option<Box<models::MispSettingTest>>>,
24    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
25    pub r#type: Option<Type>,
26    #[serde(rename = "null", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
27    pub null: Option<Option<bool>>,
28    #[serde(rename = "subGroup", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
29    pub sub_group: Option<Option<String>>,
30    #[serde(rename = "cli_only", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
31    pub cli_only: Option<Option<i32>>,
32    #[serde(rename = "redacted", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
33    pub redacted: Option<Option<bool>>,
34    #[serde(rename = "optionsSource", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
35    pub options_source: Option<Option<serde_json::Value>>,
36    #[serde(rename = "afterHook", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
37    pub after_hook: Option<Option<String>>,
38    #[serde(rename = "error", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
39    pub error: Option<Option<i32>>,
40    #[serde(rename = "tab", skip_serializing_if = "Option::is_none")]
41    pub tab: Option<String>,
42    #[serde(rename = "setting", skip_serializing_if = "Option::is_none")]
43    pub setting: Option<String>,
44    #[serde(rename = "options", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
45    pub options: Option<Option<Box<models::MispSettingOptions>>>,
46}
47
48impl MispSetting {
49    pub fn new() -> MispSetting {
50        MispSetting {
51            level: None,
52            value: None,
53            error_message: None,
54            test: None,
55            r#type: None,
56            null: None,
57            sub_group: None,
58            cli_only: None,
59            redacted: None,
60            options_source: None,
61            after_hook: None,
62            error: None,
63            tab: None,
64            setting: None,
65            options: None,
66        }
67    }
68}
69/// 
70#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
71pub enum Type {
72    #[serde(rename = "string")]
73    String,
74    #[serde(rename = "boolean")]
75    Boolean,
76    #[serde(rename = "numeric")]
77    Numeric,
78}
79
80impl Default for Type {
81    fn default() -> Type {
82        Self::String
83    }
84}
85
misp_client_rs/models/misp_setting.rs

misp_client_rs/models/
misp_setting.rs
