zap_api 0.0.2

The Rust implementation to access the OWASP ZAP 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

/* Zed Attack Proxy (ZAP) and its related class files.
 *
 * ZAP is an HTTP/HTTPS proxy for assessing web application security.
 *
 * Copyright 2019 the ZAP development team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use super::ZapApiError;
use super::ZapService;
use serde_json::Value;
use std::collections::HashMap;

/**
 * This file was automatically generated.
 */
/**
 * Gets a list of users that belong to the context with the given ID, or all users if none provided.
*/
pub fn users_list(service: &ZapService, contextid: String) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("contextId".to_string(), contextid);
    super::call(service, "users", "view", "usersList", params)
}

/**
 * Gets the data of the user with the given ID that belongs to the context with the given ID.
*/
pub fn get_user_by_id(
    service: &ZapService,
    contextid: String,
    userid: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("contextId".to_string(), contextid);
    params.insert("userId".to_string(), userid);
    super::call(service, "users", "view", "getUserById", params)
}

/**
 * Gets the configuration parameters for the credentials of the context with the given ID.
*/
pub fn get_authentication_credentials_config_params(
    service: &ZapService,
    contextid: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("contextId".to_string(), contextid);
    super::call(
        service,
        "users",
        "view",
        "getAuthenticationCredentialsConfigParams",
        params,
    )
}

/**
 * Gets the authentication credentials of the user with given ID that belongs to the context with the given ID.
*/
pub fn get_authentication_credentials(
    service: &ZapService,
    contextid: String,
    userid: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("contextId".to_string(), contextid);
    params.insert("userId".to_string(), userid);
    super::call(
        service,
        "users",
        "view",
        "getAuthenticationCredentials",
        params,
    )
}

/**
 * Creates a new user with the given name for the context with the given ID.
*/
pub fn new_user(
    service: &ZapService,
    contextid: String,
    name: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("contextId".to_string(), contextid);
    params.insert("name".to_string(), name);
    super::call(service, "users", "action", "newUser", params)
}

/**
 * Removes the user with the given ID that belongs to the context with the given ID.
*/
pub fn remove_user(
    service: &ZapService,
    contextid: String,
    userid: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("contextId".to_string(), contextid);
    params.insert("userId".to_string(), userid);
    super::call(service, "users", "action", "removeUser", params)
}

/**
 * Sets whether or not the user, with the given ID that belongs to the context with the given ID, should be enabled.
*/
pub fn set_user_enabled(
    service: &ZapService,
    contextid: String,
    userid: String,
    enabled: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("contextId".to_string(), contextid);
    params.insert("userId".to_string(), userid);
    params.insert("enabled".to_string(), enabled);
    super::call(service, "users", "action", "setUserEnabled", params)
}

/**
 * Renames the user with the given ID that belongs to the context with the given ID.
*/
pub fn set_user_name(
    service: &ZapService,
    contextid: String,
    userid: String,
    name: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("contextId".to_string(), contextid);
    params.insert("userId".to_string(), userid);
    params.insert("name".to_string(), name);
    super::call(service, "users", "action", "setUserName", params)
}

/**
 * Sets the authentication credentials for the user with the given ID that belongs to the context with the given ID.
*/
pub fn set_authentication_credentials(
    service: &ZapService,
    contextid: String,
    userid: String,
    authcredentialsconfigparams: String,
) -> Result<Value, ZapApiError> {
    let mut params = HashMap::new();
    params.insert("contextId".to_string(), contextid);
    params.insert("userId".to_string(), userid);
    params.insert(
        "authCredentialsConfigParams".to_string(),
        authcredentialsconfigparams,
    );
    super::call(
        service,
        "users",
        "action",
        "setAuthenticationCredentials",
        params,
    )
}