zabbix-api 0.9.0

Zabbix API client
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

use crate::user::model::ZabbixUser;
use serde::{Deserialize, Serialize};
use serde_with::skip_serializing_none;

/// Represents the permissions for a host group or template group within a user group.
/// Corresponds to the "Permission" object in Zabbix API documentation.
#[derive(Serialize, Deserialize, Debug, Clone, Default)]
pub struct UserGroupPermission {
    /// ID of the host group or template group.
    pub id: String,
    /// Access level to the host group or template group.
    /// Possible values:
    /// 0 - access denied;
    /// 2 - read-only access;
    /// 3 - read-write access.
    pub permission: i32,
}

#[skip_serializing_none]
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct ZabbixUserGroup {
    #[serde(rename = "usrgrpid")]
    pub usrgrp_id: String,
    pub name: String,
    pub gui_access: Option<String>,
    pub users_status: Option<String>,
    pub debug_mode: Option<String>,
    pub users: Option<Vec<ZabbixUser>>,
    pub rights: Option<Vec<UserGroupPermission>>,
}

/// Represents a tag-based permission for a user group.
/// Corresponds to the "Tag-based permission" object in Zabbix API documentation.
#[derive(Serialize, Deserialize, Debug, Clone, Default)]
pub struct UserGroupTagFilter {
    /// ID of the host group to add permission to.
    pub groupid: String,
    /// Tag name.
    pub tag: String,
    /// Tag value.
    pub value: String,
}

/// Represents a user to be added to a user group.
/// Only the `userid` property is required.
#[derive(Serialize, Deserialize, Debug, Clone, Default)]
pub struct UserGroupUser {
    #[serde(rename = "userid")]
    pub user_id: String,
}

/// Parameters for the `usergroup.create` API method.
/// See: https://www.zabbix.com/documentation/current/en/manual/api/reference/usergroup/create
#[skip_serializing_none]
#[derive(Serialize, Deserialize, Debug, Clone, Default)]
pub struct CreateUserGroupRequest {
    /// Name of the user group.
    pub name: String,

    /// (optional) Whether debug mode is enabled or disabled.
    /// 0 - (default) disabled;
    /// 1 - enabled.
    pub debug_mode: i32,

    /// (optional) Frontend authentication method of the users in the group.
    /// 0 - (default) use the system default authentication method;
    /// 1 - use internal authentication;
    /// 2 - use LDAP authentication;
    /// 3 - disable access to the frontend.
    pub gui_access: Option<i32>,

    /// (optional) Whether the user group is enabled or disabled.
    /// 0 - (default) enabled;
    /// 1 - disabled.
    pub users_status: Option<i32>,

    /// (optional) Host group permissions to assign to the user group.
    pub hostgroup_rights: Option<Vec<UserGroupPermission>>,

    /// (optional) Template group permissions to assign to the user group.
    pub templategroup_rights: Option<Vec<UserGroupPermission>>,

    /// (optional) Tag-based permissions to assign to the user group.
    pub tag_filters: Option<Vec<UserGroupTagFilter>>,

    /// (optional) Users to add to the user group.
    pub users: Option<Vec<UserGroupUser>>,
}

/// Response structure for the `usergroup.create` API method.
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct CreateUserGroupResponse {
    #[serde(rename = "usrgrpids")]
    pub user_group_ids: Vec<String>,
}