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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
use super::*;
impl<TS: KeycloakTokenSupplier> KeycloakAdmin<TS> {
// <h4>Workflows</h4>
/// List workflows
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `exact`: Boolean which defines whether the param 'search' must match exactly or not
/// - `first`: The position of the first result to be processed (pagination offset)
/// - `max`: The maximum number of results to be returned - defaults to 10
/// - `search`: A String representing the workflow name - either partial or exact
///
/// Resource: `Workflows`
///
/// `GET /admin/realms/{realm}/workflows`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_get_adminrealmsrealmworkflows>
pub async fn realm_workflows_get(
&self,
realm: &str,
exact: Option<bool>,
first: Option<i32>,
max: Option<i32>,
search: Option<String>,
) -> Result<WorkflowRepresentation, KeycloakError> {
let realm = p(realm);
let mut builder = self
.client
.get(format!("{}/admin/realms/{realm}/workflows", self.url))
.bearer_auth(self.token_supplier.get(&self.url).await?);
if let Some(v) = exact {
builder = builder.query(&[("exact", v)]);
}
if let Some(v) = first {
builder = builder.query(&[("first", v)]);
}
if let Some(v) = max {
builder = builder.query(&[("max", v)]);
}
if let Some(v) = search {
builder = builder.query(&[("search", v)]);
}
let response = builder.send().await?;
Ok(error_check(response).await?.json().await?)
}
/// Create workflow
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `body`
///
/// Returns response for future processing.
///
/// Resource: `Workflows`
///
/// `POST /admin/realms/{realm}/workflows`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_post_adminrealmsrealmworkflows>
pub async fn realm_workflows_post(
&self,
realm: &str,
body: WorkflowRepresentation,
) -> Result<DefaultResponse, KeycloakError> {
let realm = p(realm);
let builder = self
.client
.post(format!("{}/admin/realms/{realm}/workflows", self.url))
.json(&body)
.bearer_auth(self.token_supplier.get(&self.url).await?);
let response = builder.send().await?;
error_check(response).await.map(From::from)
}
/// Migrate scheduled resources from one step to another
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `from`: A String representing the id of the step to migrate from
/// - `to`: A String representing the id of the step to migrate to
///
/// Returns response for future processing.
///
/// Resource: `Workflows`
///
/// `POST /admin/realms/{realm}/workflows/migrate`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_post_adminrealmsrealmworkflowsmigrate>
pub async fn realm_workflows_migrate_post(
&self,
realm: &str,
from: Option<String>,
to: Option<String>,
) -> Result<DefaultResponse, KeycloakError> {
let realm = p(realm);
let mut builder = self
.client
.post(format!(
"{}/admin/realms/{realm}/workflows/migrate",
self.url
))
.bearer_auth(self.token_supplier.get(&self.url).await?);
if let Some(v) = from {
builder = builder.query(&[("from", v)]);
}
if let Some(v) = to {
builder = builder.query(&[("to", v)]);
}
let response = builder.send().await?;
error_check(response).await.map(From::from)
}
/// List scheduled workflows for resource
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `resource_id`: Identifier of the resource associated with the scheduled workflows
///
/// Resource: `Workflows`
///
/// `GET /admin/realms/{realm}/workflows/scheduled/{resource_id}`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_get_adminrealmsrealmworkflowsscheduledresource_id>
///
/// REST method: `GET /admin/realms/{realm}/workflows/scheduled/{resource-id}`
pub async fn realm_workflows_scheduled_with_resource_id_get(
&self,
realm: &str,
resource_id: &str,
) -> Result<WorkflowRepresentation, KeycloakError> {
let realm = p(realm);
let resource_id = p(resource_id);
let builder = self
.client
.get(format!(
"{}/admin/realms/{realm}/workflows/scheduled/{resource_id}",
self.url
))
.bearer_auth(self.token_supplier.get(&self.url).await?);
let response = builder.send().await?;
Ok(error_check(response).await?.json().await?)
}
/// Get workflow
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `id`: Workflow identifier
/// - `include_id`: Indicates whether the workflow and step ids should be included in the representation or not - defaults to true
///
/// Resource: `Workflows`
///
/// `GET /admin/realms/{realm}/workflows/{id}`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_get_adminrealmsrealmworkflowsid>
pub async fn realm_workflows_with_id_get(
&self,
realm: &str,
id: &str,
include_id: Option<bool>,
) -> Result<WorkflowRepresentation, KeycloakError> {
let realm = p(realm);
let id = p(id);
let mut builder = self
.client
.get(format!("{}/admin/realms/{realm}/workflows/{id}", self.url))
.bearer_auth(self.token_supplier.get(&self.url).await?);
if let Some(v) = include_id {
builder = builder.query(&[("includeId", v)]);
}
let response = builder.send().await?;
Ok(error_check(response).await?.json().await?)
}
/// Update workflow
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `id`: Workflow identifier
/// - `body`
///
/// Returns response for future processing.
///
/// Resource: `Workflows`
///
/// `PUT /admin/realms/{realm}/workflows/{id}`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_put_adminrealmsrealmworkflowsid>
pub async fn realm_workflows_with_id_put(
&self,
realm: &str,
id: &str,
body: WorkflowRepresentation,
) -> Result<DefaultResponse, KeycloakError> {
let realm = p(realm);
let id = p(id);
let builder = self
.client
.put(format!("{}/admin/realms/{realm}/workflows/{id}", self.url))
.json(&body)
.bearer_auth(self.token_supplier.get(&self.url).await?);
let response = builder.send().await?;
error_check(response).await.map(From::from)
}
/// Delete workflow
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `id`: Workflow identifier
///
/// Returns response for future processing.
///
/// Resource: `Workflows`
///
/// `DELETE /admin/realms/{realm}/workflows/{id}`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_delete_adminrealmsrealmworkflowsid>
pub async fn realm_workflows_with_id_delete(
&self,
realm: &str,
id: &str,
) -> Result<DefaultResponse, KeycloakError> {
let realm = p(realm);
let id = p(id);
let builder = self
.client
.delete(format!("{}/admin/realms/{realm}/workflows/{id}", self.url))
.bearer_auth(self.token_supplier.get(&self.url).await?);
let response = builder.send().await?;
error_check(response).await.map(From::from)
}
/// Activate workflow for resource
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `id`: Workflow identifier
/// - `resource_id`: Resource identifier
/// - `type_`: Resource type
/// - `not_before`: Optional value representing the time to schedule the first workflow step. The value is either an integer representing the seconds from now, an integer followed by 'ms' representing milliseconds from now, or an ISO-8601 date string.
///
/// Returns response for future processing.
///
/// Resource: `Workflows`
///
/// `POST /admin/realms/{realm}/workflows/{id}/activate/{type_}/{resource_id}`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_post_adminrealmsrealmworkflowsidactivatetyperesourceid>
///
/// REST method: `POST /admin/realms/{realm}/workflows/{id}/activate/{type}/{resourceId}`
pub async fn realm_workflows_with_id_activate_with_type_with_resource_id_post(
&self,
realm: &str,
id: &str,
resource_id: &str,
type_: &str,
not_before: Option<String>,
) -> Result<DefaultResponse, KeycloakError> {
let realm = p(realm);
let id = p(id);
let resource_id = p(resource_id);
let type_ = p(type_);
let mut builder = self
.client
.post(format!(
"{}/admin/realms/{realm}/workflows/{id}/activate/{type_}/{resource_id}",
self.url
))
.bearer_auth(self.token_supplier.get(&self.url).await?);
if let Some(v) = not_before {
builder = builder.query(&[("notBefore", v)]);
}
let response = builder.send().await?;
error_check(response).await.map(From::from)
}
/// Deactivate workflow for resource
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `id`: Workflow identifier
/// - `resource_id`: Resource identifier
/// - `type_`: Resource type
///
/// Returns response for future processing.
///
/// Resource: `Workflows`
///
/// `POST /admin/realms/{realm}/workflows/{id}/deactivate/{type_}/{resource_id}`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_post_adminrealmsrealmworkflowsiddeactivatetyperesourceid>
///
/// REST method: `POST /admin/realms/{realm}/workflows/{id}/deactivate/{type}/{resourceId}`
pub async fn realm_workflows_with_id_deactivate_with_type_with_resource_id_post(
&self,
realm: &str,
id: &str,
resource_id: &str,
type_: &str,
) -> Result<DefaultResponse, KeycloakError> {
let realm = p(realm);
let id = p(id);
let resource_id = p(resource_id);
let type_ = p(type_);
let builder = self
.client
.post(format!(
"{}/admin/realms/{realm}/workflows/{id}/deactivate/{type_}/{resource_id}",
self.url
))
.bearer_auth(self.token_supplier.get(&self.url).await?);
let response = builder.send().await?;
error_check(response).await.map(From::from)
}
}
// not all paths processed
// left 259