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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
use super::*;
impl<TS: KeycloakTokenSupplier> KeycloakAdmin<TS> {
// <h4>Groups</h4>
/// Get group hierarchy. Only `name` and `id` are returned. `subGroups` are only returned when using the `search` or `q` parameter. If none of these parameters is provided, the top-level groups are returned without `subGroups` being filled.
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `brief_representation`
/// - `exact`
/// - `first`
/// - `max`
/// - `populate_hierarchy`
/// - `q`
/// - `search`
/// - `sub_groups_count`: Boolean which defines whether to return the count of subgroups for each group (default: true
///
/// Resource: `Groups`
///
/// `GET /admin/realms/{realm}/groups`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_get_adminrealmsrealmgroups>
#[allow(clippy::too_many_arguments)]
pub async fn realm_groups_get(
&self,
realm: &str,
brief_representation: Option<bool>,
exact: Option<bool>,
first: Option<i32>,
max: Option<i32>,
populate_hierarchy: Option<bool>,
q: Option<String>,
search: Option<String>,
sub_groups_count: Option<bool>,
) -> Result<TypeVec<GroupRepresentation>, KeycloakError> {
let realm = p(realm);
let mut builder = self
.client
.get(format!("{}/admin/realms/{realm}/groups", self.url))
.bearer_auth(self.token_supplier.get(&self.url).await?);
if let Some(v) = brief_representation {
builder = builder.query(&[("briefRepresentation", v)]);
}
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) = populate_hierarchy {
builder = builder.query(&[("populateHierarchy", v)]);
}
if let Some(v) = q {
builder = builder.query(&[("q", v)]);
}
if let Some(v) = search {
builder = builder.query(&[("search", v)]);
}
if let Some(v) = sub_groups_count {
builder = builder.query(&[("subGroupsCount", v)]);
}
let response = builder.send().await?;
Ok(error_check(response).await?.json().await?)
}
/// create or add a top level realm groupSet or create child.
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `body`
///
/// Returns response for future processing.
///
/// Resource: `Groups`
///
/// `POST /admin/realms/{realm}/groups`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_post_adminrealmsrealmgroups>
pub async fn realm_groups_post(
&self,
realm: &str,
body: GroupRepresentation,
) -> Result<DefaultResponse, KeycloakError> {
let realm = p(realm);
let builder = self
.client
.post(format!("{}/admin/realms/{realm}/groups", 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)
}
/// Returns the groups counts.
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `search`
/// - `top`
///
/// Resource: `Groups`
///
/// `GET /admin/realms/{realm}/groups/count`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_get_adminrealmsrealmgroupscount>
pub async fn realm_groups_count_get(
&self,
realm: &str,
search: Option<String>,
top: Option<bool>,
) -> Result<TypeMap<String, i64>, KeycloakError> {
let realm = p(realm);
let mut builder = self
.client
.get(format!("{}/admin/realms/{realm}/groups/count", self.url))
.bearer_auth(self.token_supplier.get(&self.url).await?);
if let Some(v) = search {
builder = builder.query(&[("search", v)]);
}
if let Some(v) = top {
builder = builder.query(&[("top", v)]);
}
let response = builder.send().await?;
Ok(error_check(response).await?.json().await?)
}
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `group_id`
///
/// Resource: `Groups`
///
/// `GET /admin/realms/{realm}/groups/{group_id}`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_get_adminrealmsrealmgroupsgroup_id>
///
/// REST method: `GET /admin/realms/{realm}/groups/{group-id}`
pub async fn realm_groups_with_group_id_get(
&self,
realm: &str,
group_id: &str,
) -> Result<GroupRepresentation, KeycloakError> {
let realm = p(realm);
let group_id = p(group_id);
let builder = self
.client
.get(format!(
"{}/admin/realms/{realm}/groups/{group_id}",
self.url
))
.bearer_auth(self.token_supplier.get(&self.url).await?);
let response = builder.send().await?;
Ok(error_check(response).await?.json().await?)
}
/// Update group, ignores subgroups.
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `group_id`
/// - `body`
///
/// Returns response for future processing.
///
/// Resource: `Groups`
///
/// `PUT /admin/realms/{realm}/groups/{group_id}`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_put_adminrealmsrealmgroupsgroup_id>
///
/// REST method: `PUT /admin/realms/{realm}/groups/{group-id}`
pub async fn realm_groups_with_group_id_put(
&self,
realm: &str,
group_id: &str,
body: GroupRepresentation,
) -> Result<DefaultResponse, KeycloakError> {
let realm = p(realm);
let group_id = p(group_id);
let builder = self
.client
.put(format!(
"{}/admin/realms/{realm}/groups/{group_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)
}
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `group_id`
///
/// Returns response for future processing.
///
/// Resource: `Groups`
///
/// `DELETE /admin/realms/{realm}/groups/{group_id}`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_delete_adminrealmsrealmgroupsgroup_id>
///
/// REST method: `DELETE /admin/realms/{realm}/groups/{group-id}`
pub async fn realm_groups_with_group_id_delete(
&self,
realm: &str,
group_id: &str,
) -> Result<DefaultResponse, KeycloakError> {
let realm = p(realm);
let group_id = p(group_id);
let builder = self
.client
.delete(format!(
"{}/admin/realms/{realm}/groups/{group_id}",
self.url
))
.bearer_auth(self.token_supplier.get(&self.url).await?);
let response = builder.send().await?;
error_check(response).await.map(From::from)
}
/// Return a paginated list of subgroups that have a parent group corresponding to the group on the URL
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `group_id`
/// - `brief_representation`: Boolean which defines whether brief groups representations are returned or not (default: false)
/// - `exact`: Boolean which defines whether the params "search" must match exactly or not
/// - `first`: The position of the first result to be returned (pagination offset).
/// - `max`: The maximum number of results that are to be returned. Defaults to 10
/// - `search`: A String representing either an exact group name or a partial name, defaults to prefix search.
/// - `sub_groups_count`: Boolean which defines whether to return the count of subgroups for each subgroup of this group (default: true)
///
/// Resource: `Groups`
///
/// `GET /admin/realms/{realm}/groups/{group_id}/children`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_get_adminrealmsrealmgroupsgroup_idchildren>
///
/// REST method: `GET /admin/realms/{realm}/groups/{group-id}/children`
#[allow(clippy::too_many_arguments)]
pub async fn realm_groups_with_group_id_children_get(
&self,
realm: &str,
group_id: &str,
brief_representation: Option<bool>,
exact: Option<bool>,
first: Option<i32>,
max: Option<i32>,
search: Option<String>,
sub_groups_count: Option<bool>,
) -> Result<TypeVec<GroupRepresentation>, KeycloakError> {
let realm = p(realm);
let group_id = p(group_id);
let mut builder = self
.client
.get(format!(
"{}/admin/realms/{realm}/groups/{group_id}/children",
self.url
))
.bearer_auth(self.token_supplier.get(&self.url).await?);
if let Some(v) = brief_representation {
builder = builder.query(&[("briefRepresentation", v)]);
}
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)]);
}
if let Some(v) = sub_groups_count {
builder = builder.query(&[("subGroupsCount", v)]);
}
let response = builder.send().await?;
Ok(error_check(response).await?.json().await?)
}
/// Set or create child.
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `group_id`
/// - `body`
///
/// Returns response for future processing.
///
/// Resource: `Groups`
///
/// `POST /admin/realms/{realm}/groups/{group_id}/children`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_post_adminrealmsrealmgroupsgroup_idchildren>
///
/// REST method: `POST /admin/realms/{realm}/groups/{group-id}/children`
pub async fn realm_groups_with_group_id_children_post(
&self,
realm: &str,
group_id: &str,
body: GroupRepresentation,
) -> Result<DefaultResponse, KeycloakError> {
let realm = p(realm);
let group_id = p(group_id);
let builder = self
.client
.post(format!(
"{}/admin/realms/{realm}/groups/{group_id}/children",
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)
}
/// Return object stating whether client Authorization permissions have been initialized or not and a reference
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `group_id`
///
/// Resource: `Groups`
///
/// `GET /admin/realms/{realm}/groups/{group_id}/management/permissions`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_get_adminrealmsrealmgroupsgroup_idmanagementpermissions>
///
/// REST method: `GET /admin/realms/{realm}/groups/{group-id}/management/permissions`
pub async fn realm_groups_with_group_id_management_permissions_get(
&self,
realm: &str,
group_id: &str,
) -> Result<ManagementPermissionReference, KeycloakError> {
let realm = p(realm);
let group_id = p(group_id);
let builder = self
.client
.get(format!(
"{}/admin/realms/{realm}/groups/{group_id}/management/permissions",
self.url
))
.bearer_auth(self.token_supplier.get(&self.url).await?);
let response = builder.send().await?;
Ok(error_check(response).await?.json().await?)
}
/// Return object stating whether client Authorization permissions have been initialized or not and a reference
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `group_id`
/// - `body`
///
/// Resource: `Groups`
///
/// `PUT /admin/realms/{realm}/groups/{group_id}/management/permissions`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_put_adminrealmsrealmgroupsgroup_idmanagementpermissions>
///
/// REST method: `PUT /admin/realms/{realm}/groups/{group-id}/management/permissions`
pub async fn realm_groups_with_group_id_management_permissions_put(
&self,
realm: &str,
group_id: &str,
body: ManagementPermissionReference,
) -> Result<ManagementPermissionReference, KeycloakError> {
let realm = p(realm);
let group_id = p(group_id);
let builder = self
.client
.put(format!(
"{}/admin/realms/{realm}/groups/{group_id}/management/permissions",
self.url
))
.json(&body)
.bearer_auth(self.token_supplier.get(&self.url).await?);
let response = builder.send().await?;
Ok(error_check(response).await?.json().await?)
}
/// Get users Returns a stream of users, filtered according to query parameters
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `group_id`
/// - `brief_representation`: Only return basic information (only guaranteed to return id, username, created, first and last name, email, enabled state, email verification state, federation link, and access. Note that it means that namely user attributes, required actions, and not before are not returned.)
/// - `first`: Pagination offset
/// - `max`: Maximum results size (defaults to 100)
///
/// Resource: `Groups`
///
/// `GET /admin/realms/{realm}/groups/{group_id}/members`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_get_adminrealmsrealmgroupsgroup_idmembers>
///
/// REST method: `GET /admin/realms/{realm}/groups/{group-id}/members`
pub async fn realm_groups_with_group_id_members_get(
&self,
realm: &str,
group_id: &str,
brief_representation: Option<bool>,
first: Option<i32>,
max: Option<i32>,
) -> Result<TypeVec<UserRepresentation>, KeycloakError> {
let realm = p(realm);
let group_id = p(group_id);
let mut builder = self
.client
.get(format!(
"{}/admin/realms/{realm}/groups/{group_id}/members",
self.url
))
.bearer_auth(self.token_supplier.get(&self.url).await?);
if let Some(v) = brief_representation {
builder = builder.query(&[("briefRepresentation", v)]);
}
if let Some(v) = first {
builder = builder.query(&[("first", v)]);
}
if let Some(v) = max {
builder = builder.query(&[("max", v)]);
}
let response = builder.send().await?;
Ok(error_check(response).await?.json().await?)
}
}
// not all paths processed
// left 259