Keycloak

Manage Keycloak instances via Admin API.

Metadata

Property	Value
Scheme	`keycloak`
Support Level	Stable
Labels	security,management
Version	4.20.0 (CEQ 3.36.0)

Maven Dependency

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-keycloak</artifactId>
    <version>4.20.0 (CEQ 3.36.0)</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`label`	string	✓		Logical name
`accessToken`	string			Pre-obtained access token for authentication. When provided, this token will be used directly instead of obtaining one through username/password or client credentials flow.
`authClient`	string			Filter admin events by authentication client ID
`authIpAddress`	string			Filter admin events by authentication IP address
`authRealm`	string		`master`	Keycloak realm to authenticate against. If not specified, the realm parameter is used for authentication. This is useful when you want to authenticate against one realm (e.g., master) but perform operations on another realm.
`authRealmFilter`	string			Filter admin events by authentication realm
`authUser`	string			Filter admin events by authentication user ID
`client`	string			Filter events by client ID
`clientId`	string			Keycloak client ID
`clientSecret`	string			Keycloak client secret
`dateFrom`	string			Filter events by start date/time in milliseconds since epoch
`dateTo`	string			Filter events by end date/time in milliseconds since epoch
`eventType`	string		`events`	Type of events to consume: events or admin-events
`first`	integer		`0`	Offset for pagination (first result index)
`introspectionCacheEnabled`	boolean		`true`	Enable caching of token introspection results to reduce API calls to Keycloak
`introspectionCacheTtl`	integer		`60`	Time-to-live for cached introspection results in seconds
`ipAddress`	string			Filter events by IP address
`keycloakClient`	object			To use an existing configured Keycloak admin client
`maxResults`	integer		`100`	Maximum number of events to retrieve per poll
`operation`	enum			The operation to perform
`operationTypes`	string			Filter admin events by operation types (comma-separated list, e.g., CREATE,UPDATE,DELETE)
`password`	string			Keycloak password
`pojoRequest`	boolean		`false`	If we want to use a POJO request as body or not
`realm`	string		`master`	Keycloak realm, the default is master because usually all the operations are done starting from the master realm
`resourcePath`	string			Filter admin events by resource path
`serverUrl`	string			Keycloak server URL
`types`	string			Filter events by event types (comma-separated list, e.g., LOGIN,LOGOUT)
`user`	string			Filter events by user ID
`username`	string			Keycloak username
`useTokenIntrospection`	boolean		`false`	Enable OAuth 2.0 token introspection for real-time token validation. When enabled, tokens are validated by calling Keycloak's introspection endpoint instead of local JWT parsing. This allows detecting revoked tokens before expiration.
`sendEmptyMessageWhenIdle`	boolean		`false`	If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
`bridgeErrorHandler`	boolean		`false`	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.
`exceptionHandler`	object			To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.
`exchangePattern`	enum			Sets the exchange pattern when the consumer creates an exchange.
`pollStrategy`	object			A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
`lazyStartProducer`	boolean		`false`	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.
`backoffErrorThreshold`	integer			The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`backoffIdleThreshold`	integer			The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`backoffMultiplier`	integer			To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
`delay`	integer		`500`	Milliseconds before the next poll.
`greedy`	boolean		`false`	If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`initialDelay`	integer		`1000`	Milliseconds before the first poll starts.
`repeatCount`	integer		`0`	Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.
`runLoggingLevel`	enum		`TRACE`	The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
`scheduledExecutorService`	object			Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
`scheduler`	object		`none`	To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler
`schedulerProperties`	object			To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. This is a multi-value option with prefix: scheduler.
`startScheduler`	boolean		`true`	Whether the scheduler should be auto started.
`timeUnit`	enum		`MILLISECONDS`	Time unit for initialDelay and delay options.
`useFixedDelay`	boolean		`true`	Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.