keycloak-api-manager 1.0.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -10,6 +10,13 @@
10
10
  <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
11
11
  <option name="LAST_RESOLUTION" value="IGNORE" />
12
12
  </component>
13
+ <component name="FileTemplateManagerImpl">
14
+ <option name="RECENT_TEMPLATES">
15
+ <list>
16
+ <option value="JavaScript File" />
17
+ </list>
18
+ </option>
19
+ </component>
13
20
  <component name="Git.Settings">
14
21
  <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
15
22
  </component>
@@ -37,15 +44,25 @@
37
44
  &quot;keyToString&quot;: {
38
45
  &quot;RunOnceActivity.ShowReadmeOnStart&quot;: &quot;true&quot;,
39
46
  &quot;git-widget-placeholder&quot;: &quot;main&quot;,
40
- &quot;last_opened_file_path&quot;: &quot;/Users/Alessandro/Src/WorkSpace/WorkspaceDemo/Idealia/Keyclock/keycloak-api-manager&quot;,
47
+ &quot;last_opened_file_path&quot;: &quot;/Users/Alessandro/Src/WorkSpace/WorkspaceDemo/Idealia/Keyclock/keycloak-api-manager/Handlers&quot;,
41
48
  &quot;node.js.detected.package.eslint&quot;: &quot;true&quot;,
42
49
  &quot;node.js.detected.package.tslint&quot;: &quot;true&quot;,
43
50
  &quot;node.js.selected.package.eslint&quot;: &quot;(autodetect)&quot;,
44
51
  &quot;node.js.selected.package.tslint&quot;: &quot;(autodetect)&quot;,
45
52
  &quot;nodejs_package_manager_path&quot;: &quot;npm&quot;,
53
+ &quot;ts.external.directory.path&quot;: &quot;/Applications/WebStorm.app/Contents/plugins/javascript-plugin/jsLanguageServicesImpl/external&quot;,
46
54
  &quot;vue.rearranger.settings.migration&quot;: &quot;true&quot;
47
55
  }
48
56
  }</component>
57
+ <component name="RecentsManager">
58
+ <key name="CopyFile.RECENT_KEYS">
59
+ <recent name="$PROJECT_DIR$/Handlers" />
60
+ <recent name="$PROJECT_DIR$" />
61
+ </key>
62
+ <key name="MoveFile.RECENT_KEYS">
63
+ <recent name="$PROJECT_DIR$/Handlers" />
64
+ </key>
65
+ </component>
49
66
  <component name="SharedIndexes">
50
67
  <attachedChunks>
51
68
  <set>
@@ -62,7 +79,7 @@
62
79
  <option name="presentableId" value="Default" />
63
80
  <updated>1759849149064</updated>
64
81
  <workItem from="1759849150239" duration="1214000" />
65
- <workItem from="1759917554117" duration="2085000" />
82
+ <workItem from="1759917554117" duration="42060000" />
66
83
  </task>
67
84
  <servers />
68
85
  </component>
@@ -0,0 +1,602 @@
1
+ /**
2
+ * **************************************************************************************************
3
+ * **************************************************************************************************
4
+ * The authenticationManagement entity provides methods to manage authentication flows, executions,
5
+ * and related settings within a Keycloak realm. These operations let you:
6
+ * - Create and manage authentication flows (e.g., browser flow, direct grant flow).
7
+ * - Add and configure executions (authenticators, forms, conditions).
8
+ * - Update execution requirements (e.g., REQUIRED, ALTERNATIVE, DISABLED).
9
+ * - Handle form providers and authenticator configuration.
10
+ * - Manage bindings (set a realm’s browser flow, direct grant flow, etc.).
11
+ *
12
+ * Common Use Cases:
13
+ * - Defining custom login flows.
14
+ * - Adding 2FA authenticators (e.g., OTP, WebAuthn) to flows.
15
+ * - Configuring conditional executions (e.g., "only if user has role X").
16
+ * - Assigning authentication flows to realm bindings (browser, reset credentials, etc.).
17
+ * **************************************************************************************************
18
+ * **************************************************************************************************
19
+ */
20
+ let kcAdminClientHandler=null;
21
+ exports.setKcAdminClient=function(kcAdminClient){
22
+ kcAdminClientHandler=kcAdminClient;
23
+ }
24
+
25
+
26
+ /**
27
+ * ***************************** - deleteRequiredAction - *******************************
28
+ * The method deletes a required action from a Keycloak realm.
29
+ * Required actions are tasks that users must complete after login, such as:
30
+ * - Updating their password
31
+ * - Verifying their email
32
+ * - Configuring OTP
33
+ * - Accepting terms and conditions
34
+ *
35
+ * By deleting a required action, it will no longer be available for assignment to users.
36
+ *
37
+ * @parameters:
38
+ * - filter: parameter provided as a JSON object that accepts the following filter:
39
+ * - alias: [required] The unique alias of the required action to delete (e.g., "UPDATE_PASSWORD").
40
+ */
41
+ exports.deleteRequiredAction=function(filter){
42
+ return (kcAdminClientHandler.authenticationManagement.deleteRequiredAction(filter));
43
+ }
44
+
45
+
46
+
47
+ /**
48
+ * ***************************** - registerRequiredAction - *******************************
49
+ * The method registers a new required action in a Keycloak realm.
50
+ * Required actions are tasks that users may be forced to perform during authentication (e.g., verify email, update password, configure OTP, or a custom scripted action).
51
+ * This method is typically used after checking available actions via getUnregisteredRequiredActions.
52
+ *
53
+ * @parameters:
54
+ * - actionRepresentation: The representation of the required action to register.
55
+ * - providerId: [required] Unique ID of the required action (e.g., "terms_and_conditions").
56
+ * - name: [required] Display name of the required action.
57
+ * - description : [optional] Human-readable description of the action.
58
+ * - defaultAction: [optional] Whether the action should be enabled by default.
59
+ * - enabled: [optional] Whether the action is active.
60
+ * - priority: [optional] Determines the execution order among required actions.
61
+ * - config: [optional] Extra configuration options (usually empty for built-in actions).
62
+ */
63
+ exports.registerRequiredAction=function(actionRepresentation){
64
+ return (kcAdminClientHandler.authenticationManagement.registerRequiredAction(actionRepresentation));
65
+ }
66
+
67
+
68
+ /**
69
+ * ***************************** - getUnregisteredRequiredActions - *******************************
70
+ * The method retrieves all available required actions that exist in Keycloak but are not
71
+ * yet registered in a given realm. This is useful if you want to see which built-in or custom
72
+ * required actions can still be added to the realm (e.g., custom scripts, OTP setup, email verification).
73
+ */
74
+ exports.getUnregisteredRequiredActions=function(){
75
+ return (kcAdminClientHandler.authenticationManagement.getUnregisteredRequiredActions());
76
+ }
77
+
78
+
79
+ /**
80
+ * ***************************** - getRequiredActions - *******************************
81
+ * The method retrieves all required actions that are currently registered and available in a given Keycloak realm.
82
+ * Required actions are tasks that users may be required to perform during authentication, such as:
83
+ * - Updating password
84
+ * - Verifying email
85
+ * - Configuring OTP
86
+ * - Accepting terms and conditions
87
+ * - {other fields}
88
+ */
89
+ exports.getRequiredActions=function(){
90
+ return (kcAdminClientHandler.authenticationManagement.getRequiredActions());
91
+ }
92
+
93
+
94
+
95
+ /**
96
+ * ***************************** - getRequiredActionForAlias - *******************************
97
+ * The method retrieves a single required action in a Keycloak realm by its alias.
98
+ * Required actions are tasks that users may be forced to complete during authentication,
99
+ * such as update password, verify email, or configure OTP.
100
+ * This method is useful when you want details about a specific required action without listing all actions.
101
+ *
102
+ * @parameters:
103
+ * - filter: parameter provided as a JSON object that accepts the following filter:
104
+ * - alias: [required] The unique alias of the required action to retrieve (e.g., "UPDATE_PASSWORD").
105
+ */
106
+ exports.getRequiredActionForAlias=function(filter){
107
+ return (kcAdminClientHandler.authenticationManagement.getRequiredActionForAlias(filter));
108
+ }
109
+
110
+
111
+ /**
112
+ * ***************************** - lowerRequiredActionPriority - *******************************
113
+ * The method lowers the priority of a registered required action in a Keycloak realm.
114
+ * Priority determines the order in which required actions are executed for a user during authentication. Lowering the priority moves the action further down the execution order.
115
+ *
116
+ * @parameters:
117
+ * - filter: parameter provided as a JSON object that accepts the following filter:
118
+ * - alias: [required] The alias (providerId) of the required action to modify.
119
+ */
120
+ exports.lowerRequiredActionPriority=function(filter){
121
+ return (kcAdminClientHandler.authenticationManagement.lowerRequiredActionPriority(filter));
122
+ }
123
+
124
+
125
+ /**
126
+ * ***************************** - raiseRequiredActionPriority - *******************************
127
+ * The method raises the priority of a registered required action in a Keycloak realm.
128
+ * Priority determines the order in which required actions are executed for a user during authentication.
129
+ * Raising the priority moves the action higher in the execution order, meaning it will be executed sooner.
130
+ *
131
+ * @parameters:
132
+ * - filter: parameter provided as a JSON object that accepts the following filter:
133
+ * - alias: [required] The alias (providerId) of the required action to modify.
134
+ */
135
+ exports.raiseRequiredActionPriority=function(filter){
136
+ return (kcAdminClientHandler.authenticationManagement.raiseRequiredActionPriority(filter));
137
+ }
138
+
139
+
140
+ /**
141
+ * ***************************** - getRequiredActionConfigDescription - *******************************
142
+ * The method retrieves the configuration description for a specific required action in a Keycloak realm.
143
+ * This includes details about the configurable options available for that required action, such as which fields can be set, their types, and any default values.
144
+ *
145
+ * @parameters:
146
+ * - filter: parameter provided as a JSON object that accepts the following filter:
147
+ * - alias: [required] The alias (providerId) of the required action.
148
+ */
149
+ exports.getRequiredActionConfigDescription=function(filter){
150
+ return (kcAdminClientHandler.authenticationManagement.getRequiredActionConfigDescription(filter));
151
+ }
152
+
153
+
154
+ /**
155
+ * ***************************** - getRequiredActionConfig - *******************************
156
+ * The method retrieves the current configuration for a specific required action in a Keycloak realm.
157
+ * This allows you to see the settings that have been applied to a required action, such as OTP policies, password requirements, or any custom configurations.
158
+ *
159
+ * @parameters:
160
+ * - filter: parameter provided as a JSON object that accepts the following filter:
161
+ * - alias: [required] The alias (providerId) of the required action.
162
+ */
163
+ exports.getRequiredActionConfig=function(filter){
164
+ return (kcAdminClientHandler.authenticationManagement.getRequiredActionConfig(filter));
165
+ }
166
+
167
+
168
+
169
+ /**
170
+ * ***************************** - removeRequiredActionConfig - *******************************
171
+ * The method deletes the configuration of a specific required action in a Keycloak realm.
172
+ * This removes any customized settings for the action, effectively resetting it to its default behavior.
173
+ *
174
+ * @parameters:
175
+ * - filter: parameter provided as a JSON object that accepts the following filter:
176
+ * - alias: [required] The alias (providerId) of the required action.
177
+ */
178
+ exports.removeRequiredActionConfig=function(filter){
179
+ return (kcAdminClientHandler.authenticationManagement.removeRequiredActionConfig(filter));
180
+ }
181
+
182
+
183
+
184
+ /**
185
+ * ***************************** - updateRequiredAction - *******************************
186
+ * The method updates an existing required action in a Keycloak realm.
187
+ * Required actions are tasks that users may be required to perform during authentication, such as:
188
+ * - Updating password
189
+ * - Verifying email
190
+ * - Configuring OTP
191
+ * - Accepting terms and conditions
192
+ *
193
+ *
194
+ * This method allows you to modify attributes such as enabled, defaultAction, priority, or configuration of a required action.
195
+ *
196
+ * @parameters:
197
+ * - filter: parameter provided as a JSON object that accepts the following filter:
198
+ * - alias: [required] The alias (providerId) of the required action to update.
199
+ * - actionRepresentation: The updated representation of the required action.
200
+ * - providerId: [required] Unique ID of the required action (alias).
201
+ * - name: [required] Display name of the action.
202
+ * - description: [optional] Human-readable description.
203
+ * - enabled: [optional] Whether the action is active.
204
+ * - defaultAction: [optional] Whether the action is assigned to new users by default.
205
+ * - priority: [optional] Execution order among required actions.
206
+ * - config: [optional] Extra configuration.
207
+ */
208
+ exports.updateRequiredAction=function(filter,actionRepresentation){
209
+ return (kcAdminClientHandler.authenticationManagement.updateRequiredAction(filter,actionRepresentation));
210
+ }
211
+
212
+
213
+ /**
214
+ * ***************************** - updateRequiredActionConfig - *******************************
215
+ * The method updates the configuration of a specific required action in a Keycloak realm.
216
+ * This allows you to modify settings such as OTP policies, password requirements, or other parameters of built-in or custom required actions.
217
+ *
218
+ * @parameters:
219
+ * - filter: parameter provided as a JSON object that accepts the following filter:
220
+ * - alias: [required] The alias (providerId) of the required action to update.
221
+ * - actionRepresentation: The configuration object to update.
222
+ */
223
+ exports.updateRequiredActionConfig=function(filter, actionConfigRepresentation){
224
+ return (kcAdminClientHandler.authenticationManagement.updateRequiredActionConfig(filter,actionConfigRepresentation));
225
+ }
226
+
227
+
228
+ /**
229
+ * ***************************** - getClientAuthenticatorProviders - *******************************
230
+ * The method retrieves all client authenticator providers available in a Keycloak realm.
231
+ * Client authenticators are used to verify clients during authentication, such as:
232
+ * - Client ID and secret authentication
233
+ * - JWT or X.509 certificate authentication
234
+ * - Custom client authenticators
235
+ *
236
+ * This method is useful for configuring client authentication flows and assigning authenticators to specific clients.
237
+ */
238
+ exports.getClientAuthenticatorProviders=function(){
239
+ return (kcAdminClientHandler.authenticationManagement.getClientAuthenticatorProviders());
240
+ }
241
+
242
+
243
+
244
+ /**
245
+ * ***************************** - getFormActionProviders - *******************************
246
+ * The method retrieves all form action providers available in a Keycloak realm.
247
+ * Form action providers are used during authentication flows to perform specific actions in forms, such as:
248
+ * - OTP validation
249
+ * - Password update
250
+ * - Terms and conditions acceptance
251
+ * - Custom scripted form actions
252
+ *
253
+ * This method is useful for configuring authentication flows that require specific user interactions.
254
+ */
255
+ exports.getFormActionProviders=function(){
256
+ return (kcAdminClientHandler.authenticationManagement.getFormActionProviders());
257
+ }
258
+
259
+
260
+
261
+ /**
262
+ * ***************************** - getAuthenticatorProviders - *******************************
263
+ * The method retrieves all authenticator providers available in a Keycloak realm.
264
+ * Authenticators are used in authentication flows to verify users or perform specific steps during login, such as:
265
+ * - Username/password verification
266
+ * - OTP verification
267
+ * - WebAuthn authentication
268
+ * - Custom authenticators
269
+ *
270
+ * This method is useful for configuring authentication flows and adding or replacing authenticators.
271
+ */
272
+ exports.getAuthenticatorProviders=function(){
273
+ return (kcAdminClientHandler.authenticationManagement.getAuthenticatorProviders());
274
+ }
275
+
276
+
277
+ /**
278
+ * ***************************** - getFormProviders - *******************************
279
+ * The method retrieves all form providers available in a Keycloak realm.
280
+ * Form providers are used in authentication flows to render or handle user-facing forms, such as:
281
+ * - Login forms
282
+ * - Registration forms
283
+ * - OTP input forms
284
+ * - Terms and conditions acceptance
285
+ *
286
+ * This method is useful for configuring authentication flows that require user interaction through forms.
287
+ */
288
+ exports.getFormProviders=function(){
289
+ return (kcAdminClientHandler.authenticationManagement.getFormProviders());
290
+ }
291
+
292
+
293
+ /**
294
+ * ***************************** - getFlows - *******************************
295
+ * The method retrieves all authentication flows in a Keycloak realm.
296
+ * Authentication flows define the sequence of authenticators and required
297
+ * actions that users must complete during login or other authentication events.
298
+ *
299
+ * This method allows you to inspect existing flows, including built-in flows like browser,
300
+ * direct grant, or registration, as well as custom flows.
301
+ */
302
+ exports.getFlows=function(){
303
+ return (kcAdminClientHandler.authenticationManagement.getFlows());
304
+ }
305
+
306
+
307
+
308
+ /**
309
+ * ***************************** - createFlow - *******************************
310
+ * The method retrieves a specific authentication flow in a Keycloak realm by its id.
311
+ * Authentication flows define the sequence of authenticators and required actions that users must complete during login or other authentication events.
312
+ * This method is useful for inspecting or modifying a particular flow.
313
+ *
314
+ * @parameters:
315
+ * - flowRepresentation: The representation of the new flow. A typical AuthenticationFlowRepresentation includes:
316
+ * - alias : [required] Human-readable alias for the flow.
317
+ * - providerId: [required] Type of flow ("basic-flow", "client-flow", etc.).
318
+ * - description: [optional] Description of the flow.
319
+ * - topLevel: [optional] Whether this is a top-level flow (default: true).
320
+ * - builtIn: [optional] Whether this is a built-in flow (default: false).
321
+ * - authenticationExecutions: [optional] Executions to include in the flow.
322
+ */
323
+ exports.createFlow=function(flowRepresentation){
324
+ return (kcAdminClientHandler.authenticationManagement.createFlow(flowRepresentation));
325
+ }
326
+
327
+
328
+
329
+ /**
330
+ * ***************************** - updateFlow - *******************************
331
+ * The method updates an existing authentication flow in a Keycloak realm.
332
+ * This allows you to modify attributes such as the flow’s description, alias, top-level status, or other properties.
333
+ *
334
+ * @parameters:
335
+ * filter: Parameter provided as a JSON object that accepts the following filter:
336
+ * - flowId: [required] The id of the source flow to update.
337
+ * - flowRepresentation: The representation of the flow to update. A typical AuthenticationFlowRepresentation includes:
338
+ * - alias : [required] Human-readable alias for the flow.
339
+ * - providerId: [required] Type of flow ("basic-flow", "client-flow", etc.).
340
+ * - description: [optional] Description of the flow.
341
+ * - topLevel: [optional] Whether this is a top-level flow (default: true).
342
+ * - builtIn: [optional] Whether this is a built-in flow (default: false).
343
+ * - authenticationExecutions: [optional] Executions to include in the flow.
344
+ */
345
+ exports.updateFlow=function(filter, flowRepresentation){
346
+ return (kcAdminClientHandler.authenticationManagement.updateFlow(filter, flowRepresentation));
347
+ }
348
+
349
+
350
+ /**
351
+ * ***************************** - deleteFlow - *******************************
352
+ * The method deletes an existing authentication flow in a Keycloak realm.
353
+ * Deleting a flow removes it completely, including all its executions and subflows.
354
+ * This is typically used to remove custom flows that are no longer needed.
355
+ *
356
+ * @parameters:
357
+ * filter: Parameter provided as a JSON object that accepts the following filter:
358
+ * - flowId: [required] The id of the source flow to update.
359
+ */
360
+ exports.deleteFlow=function(filter){
361
+ return (kcAdminClientHandler.authenticationManagement.deleteFlow(filter));
362
+ }
363
+
364
+
365
+
366
+ /**
367
+ * ***************************** - copyFlow - *******************************
368
+ * The method duplicates an existing authentication flow in a Keycloak realm.
369
+ * This is useful for creating a custom flow based on an existing built-in or custom flow, preserving all executions and subflows.
370
+ *
371
+ * @parameters:
372
+ * - filter: Parameter provided as a JSON object that accepts the following filter:
373
+ * - flow: [required] The alias of the source flow to copy.
374
+ * - newName: [required] The alias of the new copied flow.
375
+ */
376
+ exports.copyFlow=function(filter){
377
+ return (kcAdminClientHandler.authenticationManagement.copyFlow(filter));
378
+ }
379
+
380
+
381
+ /**
382
+ * ***************************** - getFlow - *******************************
383
+ * The method retrieves a specific authentication flow in a Keycloak realm by its id.
384
+ * Authentication flows define the sequence of authenticators and required actions that users must complete during login or other authentication events.
385
+ * This method is useful for inspecting or modifying a particular flow.
386
+ *
387
+ * @parameters:
388
+ * - filter: parameter provided as a JSON object that accepts the following filter:
389
+ * - flowId: [required] The id of the authentication flow to retrieve
390
+ */
391
+ exports.getFlow=function(filter){
392
+ return (kcAdminClientHandler.authenticationManagement.getFlow(filter));
393
+ }
394
+
395
+
396
+ /**
397
+ * ***************************** - getExecutions - *******************************
398
+ * The method retrieves all authentication executions for a specific authentication flow in a Keycloak realm.
399
+ * Executions define the individual steps or actions within a flow, such as:
400
+ * - Username/password verification
401
+ * - OTP validation
402
+ * - Terms acceptance
403
+ * - Subflows
404
+ *
405
+ * This method is useful to inspect or modify the steps of a flow.
406
+ *
407
+ * @parameters:
408
+ * - filter: parameter provided as a JSON object that accepts the following filter:
409
+ * - flow: [required] The alias of the authentication flow whose executions you want to retrieve.
410
+ */
411
+ exports.getExecutions=function(filter){
412
+ return (kcAdminClientHandler.authenticationManagement.getExecutions(filter));
413
+ }
414
+
415
+
416
+
417
+ /**
418
+ * ***************************** - addExecutionToFlow - *******************************
419
+ * The method adds a new execution (step) to an existing authentication flow in a Keycloak realm.
420
+ * Executions define the individual actions or authenticators in a flow, such as username/password verification, OTP validation, or custom authenticators.
421
+ * This method allows you to extend a flow with additional steps or subflows.
422
+ *
423
+ * @parameters:
424
+ * - filter: parameter provided as a JSON object that accepts the following filter:
425
+ * - flow: [required] The alias of the authentication flow to which the execution will be added.
426
+ * - provider: [required] The authenticator or subflow to add (e.g., "auth-otp-form").
427
+ * - requirement: [optional] "REQUIRED" | "ALTERNATIVE" | "DISABLED"
428
+ * - priority: [optional] Number representing the execution order
429
+ * - authenticatorFlow: [optional] Boolean indicating if the execution is a nested flow
430
+ */
431
+ exports.addExecutionToFlow=function(filter){
432
+ return (kcAdminClientHandler.authenticationManagement.addExecutionToFlow(filter));
433
+ }
434
+
435
+
436
+
437
+ /**
438
+ * ***************************** - addFlowToFlow - *******************************
439
+ * The method adds an existing authentication flow as a subflow to another authentication flow in a Keycloak realm.
440
+ * This allows you to nest flows, creating complex authentication sequences where one flow can call another as a step.
441
+ *
442
+ * @parameters:
443
+ * - filter: parameter provided as a JSON object that accepts the following filter:
444
+ * - flow: [required] The alias of the parent authentication flow.
445
+ * - alias: [required] The alias (name) of the new subflow.
446
+ * - type: [required] Type of the flow (e.g., "basic-flow", "client-flow").
447
+ * - provider: [required] The provider ID of the flow (e.g., "registration-page-form").
448
+ * - description: [optional] A human-readable description of the subflow.
449
+ */
450
+ exports.addFlowToFlow=function(filter){
451
+ return (kcAdminClientHandler.authenticationManagement.addFlowToFlow(filter));
452
+ }
453
+
454
+
455
+
456
+ /**
457
+ * ***************************** - updateExecution - *******************************
458
+ * The method updates an existing execution (step) within an authentication flow in a Keycloak realm.
459
+ * Executions are individual authenticators or subflows within a flow, and this method allows you to modify their requirement, priority, or other settings.
460
+ *
461
+ * @parameters:
462
+ * - filter: parameter provided as a JSON object that accepts the following filter:
463
+ * - flow: [required] The alias of the authentication flow containing the execution.
464
+ * - executionRepresentation: The updated execution object. Typical fields in AuthenticationExecutionInfoRepresentation:
465
+ * - id: [required] The ID of the execution.
466
+ * - requirement: [optional] "REQUIRED" | "ALTERNATIVE" | "DISABLED"
467
+ * - priority: [optional] Execution order within the flow
468
+ * - authenticator: [optional] Authenticator ID (if changing the execution type)
469
+ * - authenticatorFlow: [optional] Whether the execution is a nested flow
470
+ */
471
+ exports.updateExecution=function(filter, executionRepresentation){
472
+ return (kcAdminClientHandler.authenticationManagement.updateExecution(filter,executionRepresentation));
473
+ }
474
+
475
+
476
+
477
+ /**
478
+ * ***************************** - delExecution - *******************************
479
+ * The method deletes an existing execution (step) from an authentication flow in a Keycloak realm.
480
+ * Executions are individual authenticators or subflows within a flow, and this method removes them completely from the flow.
481
+ *
482
+ * @parameters:
483
+ * - filter: parameter provided as a JSON object that accepts the following filter:
484
+ * - id: [required] The ID of the execution to delete.
485
+ */
486
+ exports.delExecution=function(filter){
487
+ return (kcAdminClientHandler.authenticationManagement.delExecution(filter));
488
+ }
489
+
490
+
491
+ /**
492
+ * ***************************** - raisePriorityExecution - *******************************
493
+ * The method increases the priority of an execution within an authentication flow in a Keycloak realm.
494
+ * Increasing the priority moves the execution earlier in the flow sequence, affecting the order
495
+ * in which authenticators or subflows are executed.
496
+ *
497
+ * @parameters:
498
+ * - filter: parameter provided as a JSON object that accepts the following filter:
499
+ * - id: [required] he ID of the execution whose priority will be raised.
500
+ */
501
+ exports.raisePriorityExecution=function(filter){
502
+ return (kcAdminClientHandler.authenticationManagement.raisePriorityExecution(filter));
503
+ }
504
+
505
+
506
+ /**
507
+ * ***************************** - lowerPriorityExecution - *******************************
508
+ * The method decreases the priority of an execution within an authentication flow in a Keycloak realm.
509
+ * Lowering the priority moves the execution later in the flow sequence, affecting the order in which authenticators or subflows are executed.
510
+ *
511
+ * @parameters:
512
+ * - filter: parameter provided as a JSON object that accepts the following filter:
513
+ * - id: [required] he ID of the execution whose priority will be lowered.
514
+ */
515
+ exports.lowerPriorityExecution=function(filter){
516
+ return (kcAdminClientHandler.authenticationManagement.lowerPriorityExecution(filter));
517
+ }
518
+
519
+
520
+
521
+ /**
522
+ * ***************************** - createConfig - *******************************
523
+ * The method creates a configuration for a specific execution (step) within an authentication flow in a Keycloak realm.
524
+ * Configurations allow you to customize the behavior of an authenticator or required action,
525
+ * such as OTP policies, password requirements, or custom parameters.
526
+ *
527
+ * @parameters:
528
+ * - filter: parameter provided as a JSON object that accepts the following filter:
529
+ * - id: [required] The ID of the execution or required action to configure.
530
+ * - alias: [required] The alias (name) of the configuration.
531
+ * - config: [optional] The payload can also include a config object with key-value pairs for configuration parameters.
532
+ */
533
+ exports.createConfig=function(filter){
534
+ return (kcAdminClientHandler.authenticationManagement.createConfig(filter));
535
+ }
536
+
537
+
538
+ /**
539
+ * ***************************** - getConfig - *******************************
540
+ * The method retrieves the configuration of a specific required action or execution within an authentication flow in a Keycloak realm.
541
+ * Configurations define additional settings for authenticators or required actions, such as OTP policies, password rules, or custom parameters.
542
+ *
543
+ * @parameters:
544
+ * - filter: parameter provided as a JSON object that accepts the following filter:
545
+ * - id: [required] The ID of the execution or required action whose configuration you want to retrieve.
546
+ */
547
+ exports.getConfig=function(filter){
548
+ return (kcAdminClientHandler.authenticationManagement.getConfig(filter));
549
+ }
550
+
551
+
552
+ /**
553
+ * ***************************** - updateConfig - *******************************
554
+ * The method updates the configuration of a specific required action or execution within an authentication
555
+ * flow in a Keycloak realm. This allows you to modify existing settings, such as OTP policies,
556
+ * password rules, or any custom parameters, without creating a new configuration.
557
+ *
558
+ * @parameters:
559
+ * - filter: parameter provided as a JSON object that accepts the following filter:
560
+ * - id: [required] The ID of the existing configuration.
561
+ * - config: [required] Key-value pairs representing the new configuration parameters.
562
+ */
563
+ exports.updateConfig=function(filter){
564
+ return (kcAdminClientHandler.authenticationManagement.updateConfig(filter));
565
+ }
566
+
567
+
568
+
569
+
570
+
571
+ /**
572
+ * ***************************** - delConfig - *******************************
573
+ * The method deletes a configuration associated with a specific required action or execution within an authentication flow in a Keycloak realm.
574
+ * This is useful for removing obsolete or unwanted settings from a required action or execution.
575
+ *
576
+ * @parameters:
577
+ * - filter: parameter provided as a JSON object that accepts the following filter:
578
+ * - id: [required] The ID of the existing configuration.
579
+ */
580
+ exports.delConfig=function(filter){
581
+ return (kcAdminClientHandler.authenticationManagement.delConfig(filter));
582
+ }
583
+
584
+
585
+ /**
586
+ * ***************************** - getConfigDescription - *******************************
587
+ * The method retrieves the configuration description for a specific authenticator or required action in a Keycloak realm.
588
+ * This provides metadata and guidance about the configuration options available for the authenticator, such as:
589
+ * - Names of configuration properties
590
+ * - Types (string, boolean, list, etc.)
591
+ * - Default values
592
+ * - Help texts or descriptions
593
+ *
594
+ * This is useful for dynamically generating forms for configuring required actions or authenticators.
595
+ *
596
+ * @parameters:
597
+ * - filter: parameter provided as a JSON object that accepts the following filter:
598
+ * - providerId: [required] The ID of the authenticator or required action whose configuration description you want to retrieve.
599
+ */
600
+ exports.getConfigDescription=function(filter){
601
+ return (kcAdminClientHandler.authenticationManagement.getConfigDescription(filter));
602
+ }