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
use super::*;
impl<'a, TS: KeycloakTokenSupplier> KeycloakRealmAdmin<'a, TS> {
// <h4>Roles (by ID)</h4>
/// Get a specific role's representation
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `role_id`: id of role
///
/// Resource: `Roles (by ID)`
///
/// `GET /admin/realms/{realm}/roles-by-id/{role_id}`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_get_adminrealmsrealmroles_by_idrole_id>
///
/// REST method: `GET /admin/realms/{realm}/roles-by-id/{role-id}`
pub fn roles_by_id_with_role_id_get(
&'a self,
role_id: &'a str,
) -> impl Future<Output = Result<RoleRepresentation, KeycloakError>> + use<'a, TS> {
self.admin
.realm_roles_by_id_with_role_id_get(self.realm, role_id)
}
/// Update the role
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `role_id`: id of role
/// - `body`
///
/// Returns response for future processing.
///
/// Resource: `Roles (by ID)`
///
/// `PUT /admin/realms/{realm}/roles-by-id/{role_id}`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_put_adminrealmsrealmroles_by_idrole_id>
///
/// REST method: `PUT /admin/realms/{realm}/roles-by-id/{role-id}`
pub fn roles_by_id_with_role_id_put(
&'a self,
role_id: &'a str,
body: RoleRepresentation,
) -> impl Future<Output = Result<DefaultResponse, KeycloakError>> + use<'a, TS> {
self.admin
.realm_roles_by_id_with_role_id_put(self.realm, role_id, body)
}
/// Delete the role
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `role_id`: id of role
///
/// Returns response for future processing.
///
/// Resource: `Roles (by ID)`
///
/// `DELETE /admin/realms/{realm}/roles-by-id/{role_id}`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_delete_adminrealmsrealmroles_by_idrole_id>
///
/// REST method: `DELETE /admin/realms/{realm}/roles-by-id/{role-id}`
pub fn roles_by_id_with_role_id_delete(
&'a self,
role_id: &'a str,
) -> impl Future<Output = Result<DefaultResponse, KeycloakError>> + use<'a, TS> {
self.admin
.realm_roles_by_id_with_role_id_delete(self.realm, role_id)
}
/// Get role's children Returns a set of role's children provided the role is a composite.
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `role_id`
/// - `first`
/// - `max`
/// - `search`
///
/// Resource: `Roles (by ID)`
///
/// `GET /admin/realms/{realm}/roles-by-id/{role_id}/composites`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_get_adminrealmsrealmroles_by_idrole_idcomposites>
///
/// REST method: `GET /admin/realms/{realm}/roles-by-id/{role-id}/composites`
pub fn roles_by_id_with_role_id_composites_get(
&'a self,
role_id: &'a str,
) -> RealmRolesByIdWithRoleIdCompositesGet<'a, TS> {
RealmRolesByIdWithRoleIdCompositesGet {
realm_admin: self,
role_id,
}
}
/// Make the role a composite role by associating some child roles
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `role_id`
/// - `body`
///
/// Returns response for future processing.
///
/// Resource: `Roles (by ID)`
///
/// `POST /admin/realms/{realm}/roles-by-id/{role_id}/composites`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_post_adminrealmsrealmroles_by_idrole_idcomposites>
///
/// REST method: `POST /admin/realms/{realm}/roles-by-id/{role-id}/composites`
pub fn roles_by_id_with_role_id_composites_post(
&'a self,
role_id: &'a str,
body: Vec<RoleRepresentation>,
) -> impl Future<Output = Result<DefaultResponse, KeycloakError>> + use<'a, TS> {
self.admin
.realm_roles_by_id_with_role_id_composites_post(self.realm, role_id, body)
}
/// Remove a set of roles from the role's composite
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `role_id`: Role id
/// - `body`
///
/// Returns response for future processing.
///
/// Resource: `Roles (by ID)`
///
/// `DELETE /admin/realms/{realm}/roles-by-id/{role_id}/composites`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_delete_adminrealmsrealmroles_by_idrole_idcomposites>
///
/// REST method: `DELETE /admin/realms/{realm}/roles-by-id/{role-id}/composites`
pub fn roles_by_id_with_role_id_composites_delete(
&'a self,
role_id: &'a str,
body: Vec<RoleRepresentation>,
) -> impl Future<Output = Result<DefaultResponse, KeycloakError>> + use<'a, TS> {
self.admin
.realm_roles_by_id_with_role_id_composites_delete(self.realm, role_id, body)
}
/// Get client-level roles for the client that are in the role's composite
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `client_uuid`
/// - `role_id`
///
/// Resource: `Roles (by ID)`
///
/// `GET /admin/realms/{realm}/roles-by-id/{role_id}/composites/clients/{client_uuid}`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_get_adminrealmsrealmroles_by_idrole_idcompositesclientsclientuuid>
///
/// REST method: `GET /admin/realms/{realm}/roles-by-id/{role-id}/composites/clients/{clientUuid}`
pub fn roles_by_id_with_role_id_composites_clients_with_client_uuid_get(
&'a self,
client_uuid: &'a str,
role_id: &'a str,
) -> impl Future<Output = Result<TypeVec<RoleRepresentation>, KeycloakError>> + use<'a, TS>
{
self.admin
.realm_roles_by_id_with_role_id_composites_clients_with_client_uuid_get(
self.realm,
client_uuid,
role_id,
)
}
/// Get realm-level roles that are in the role's composite
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `role_id`
///
/// Resource: `Roles (by ID)`
///
/// `GET /admin/realms/{realm}/roles-by-id/{role_id}/composites/realm`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_get_adminrealmsrealmroles_by_idrole_idcompositesrealm>
///
/// REST method: `GET /admin/realms/{realm}/roles-by-id/{role-id}/composites/realm`
pub fn roles_by_id_with_role_id_composites_realm_get(
&'a self,
role_id: &'a str,
) -> impl Future<Output = Result<TypeVec<RoleRepresentation>, KeycloakError>> + use<'a, TS>
{
self.admin
.realm_roles_by_id_with_role_id_composites_realm_get(self.realm, role_id)
}
/// Return object stating whether role Authorization permissions have been initialized or not and a reference
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `role_id`
///
/// Resource: `Roles (by ID)`
///
/// `GET /admin/realms/{realm}/roles-by-id/{role_id}/management/permissions`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_get_adminrealmsrealmroles_by_idrole_idmanagementpermissions>
///
/// REST method: `GET /admin/realms/{realm}/roles-by-id/{role-id}/management/permissions`
pub fn roles_by_id_with_role_id_management_permissions_get(
&'a self,
role_id: &'a str,
) -> impl Future<Output = Result<ManagementPermissionReference, KeycloakError>> + use<'a, TS>
{
self.admin
.realm_roles_by_id_with_role_id_management_permissions_get(self.realm, role_id)
}
/// Return object stating whether role Authorization permissions have been initialized or not and a reference
///
/// Parameters:
///
/// - `realm`: realm name (not id!)
/// - `role_id`
/// - `body`
///
/// Resource: `Roles (by ID)`
///
/// `PUT /admin/realms/{realm}/roles-by-id/{role_id}/management/permissions`
///
/// Documentation: <https://www.keycloak.org/docs-api/26.6.0/rest-api/index.html#_put_adminrealmsrealmroles_by_idrole_idmanagementpermissions>
///
/// REST method: `PUT /admin/realms/{realm}/roles-by-id/{role-id}/management/permissions`
pub fn roles_by_id_with_role_id_management_permissions_put(
&'a self,
role_id: &'a str,
body: ManagementPermissionReference,
) -> impl Future<Output = Result<ManagementPermissionReference, KeycloakError>> + use<'a, TS>
{
self.admin
.realm_roles_by_id_with_role_id_management_permissions_put(self.realm, role_id, body)
}
}
// <h4>Roles (by ID)</h4>
pub struct RealmRolesByIdWithRoleIdCompositesGet<'a, TS: KeycloakTokenSupplier> {
/// Realm admin client
pub realm_admin: &'a KeycloakRealmAdmin<'a, TS>,
pub role_id: &'a str,
}
#[derive(Default)]
pub struct RealmRolesByIdWithRoleIdCompositesGetArgs {
pub first: Option<i32>,
pub max: Option<i32>,
pub search: Option<String>,
}
impl<'a, TS: KeycloakTokenSupplier + Send + Sync> KeycloakRealmAdminMethod
for RealmRolesByIdWithRoleIdCompositesGet<'a, TS>
{
type Output = TypeVec<RoleRepresentation>;
type Args = RealmRolesByIdWithRoleIdCompositesGetArgs;
fn opts(
self,
Self::Args { first, max, search }: Self::Args,
) -> impl Future<Output = Result<Self::Output, KeycloakError>> + use<'a, TS> {
self.realm_admin
.admin
.realm_roles_by_id_with_role_id_composites_get(
self.realm_admin.realm,
self.role_id,
first,
max,
search,
)
}
}
impl<'a, TS> IntoFuture for RealmRolesByIdWithRoleIdCompositesGet<'a, TS>
where
TS: KeycloakTokenSupplier + Send + Sync,
{
type Output = Result<TypeVec<RoleRepresentation>, KeycloakError>;
type IntoFuture = Pin<Box<dyn 'a + Future<Output = Self::Output> + Send>>;
fn into_future(self) -> Self::IntoFuture {
Box::pin(self.opts(Default::default()))
}
}
#[cfg(feature = "builder")]
mod builder {
use crate::builder::Builder;
use super::*;
// <h4>Roles (by ID)</h4>
impl<'a, TS> RealmRolesByIdWithRoleIdCompositesGet<'a, TS>
where
TS: KeycloakTokenSupplier + Send + Sync,
{
pub fn first(self, value: impl Into<Option<i32>>) -> Builder<'a, Self> {
self.builder().first(value)
}
pub fn max(self, value: impl Into<Option<i32>>) -> Builder<'a, Self> {
self.builder().max(value)
}
pub fn search(self, value: impl Into<Option<String>>) -> Builder<'a, Self> {
self.builder().search(value)
}
}
impl<TS> Builder<'_, RealmRolesByIdWithRoleIdCompositesGet<'_, TS>>
where
TS: KeycloakTokenSupplier + Send + Sync,
{
pub fn first(mut self, value: impl Into<Option<i32>>) -> Self {
self.args.first = value.into();
self
}
pub fn max(mut self, value: impl Into<Option<i32>>) -> Self {
self.args.max = value.into();
self
}
pub fn search(mut self, value: impl Into<Option<String>>) -> Self {
self.args.search = value.into();
self
}
}
}