Workflows

Use workflows when you want Keycloak 26.5+ to react automatically to realm events. They are a good fit for onboarding notifications, password-policy enforcement, or custom event-driven logic when users are created, updated, or perform specific actions. Key fields are name, enabled, on for the trigger event, step for the ordered actions, and realmRef for the target realm.

API Reference

Kind	API Group	Terraform	CRD Explorer
`Workflow`	`workflow.keycloak.crossplane.io/v1alpha1`	`keycloak_workflow`	View CRD Schema

Working YAML examples

Workflow

apiVersion: workflow.keycloak.crossplane.io/v1alpha1
kind: Workflow
metadata:
  name: onboarding
spec:
  deletionPolicy: Delete
  forProvider:
    enabled: true
    name: onboarding-new-users
    "on": user_created
    realmRef:
      name: "dev"
      policy:
        resolve: Always
    step:
      - config:
          message: "Welcome to ${realm.displayName}!"
        uses: notify-user
  providerConfigRef:
    name: "keycloak-provider-config"

Related Resources

Users