Skip to content

Commit c4804bc

Browse files
sguilhensguilhen
committed
Fix wrong event names in workflows documentation
Closes keycloak#45001 Signed-off-by: Stefan Guilhen <[email protected]>
1 parent 78274cc commit c4804bc

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

‎docs/documentation/server_admin/topics/workflows/defining-conditions.adoc‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
[[_workflow_conditions_]]
44
= Defining conditions
55

6-
The optional `if` setting allows you to define a condition using an expression language that must be met for the workflow to be triggered.
7-
It allows more fine-grained control over when a workflow execution should be created based on the context of the event.
6+
The optional `if` setting allows you to define the conditions the target resource must meet in order for the workflow to be triggered.
87

98
Conditions provide fine-grained control over whether a workflow execution should be created.
109
They allow you to inspect the context of the event and the state of the resource.
@@ -16,7 +15,7 @@ If the condition evaluates to `true`, the workflow execution is created. If it e
1615
the expression from the `on` setting evaluates to `true`.
1716

1817
Just like the `on` setting, the condition is written using an expression that supports a variety of checks on the realm resource associated with the event.
19-
For instance, considering a `user_group_membership_created` event, you can define a condition to trigger the workflow only if the user has a specific attribute:
18+
For instance, considering a `user_created` event, you can define a condition to trigger the workflow only if the user has a specific attribute:
2019

2120
```yaml
2221
on: user_created

‎docs/documentation/server_admin/topics/workflows/listening-workflow-events.adoc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ As you can see, events are functions in an expression and, as such, they also su
1717
For example, to trigger a workflow when a user is added to a specific group, you can use the following expression:
1818

1919
```yaml
20-
on: user_group_membership_created('/mygroup')
20+
on: user_group_membership_added('/mygroup')
2121
```
2222

23-
You can also combine multiple conditions using logical operators. For example, to trigger a workflow when a user is created or when authenticates, you can use:
23+
You can also combine multiple conditions using logical operators. For example, to trigger a workflow when a user is created or when they authenticate, you can use:
2424

2525
```yaml
2626
on: user_created or user_authenticated
@@ -47,10 +47,10 @@ At the moment, workflows support event functions for the following realm resourc
4747
| `user_created` | User is added to the realm. | None
4848
| `user_removed` | User is removed from the realm. | None
4949
| `user_authenticated` | User authenticates to the realm. | The client id of the client acting on behalf of the user when authenticating.
50-
| `user_federated_identity_created` | User is federated or when the account is linked to an identity provider. | The identity provider alias.
50+
| `user_federated_identity_added` | User is federated or when the account is linked to an identity provider. | The identity provider alias.
5151
| `user_federated_identity_removed` | User's federated identity is removed or unlinked from an identity provider. | The identity provider alias.
5252
| `user_role_granted` | A role is granted to the user. | The role name.
5353
| `user_role_revoked` | A role is revoked from the user. | The role name.
54-
| `user_group_membership_created` | User joined a group. | The group name or path
54+
| `user_group_membership_added` | User joined a group. | The group name or path
5555
| `user_group_membership_removed` | User is removed from a group. | The group name or path
5656
|===

0 commit comments

Comments
 (0)