mirror of
https://github.com/keycloak/keycloak.git
synced 2026-01-10 15:32:05 -03:30
c834e7473c
* Deprecate `displayTest` Closes #40786 Signed-off-by: Alexis Rico <sferadev@gmail.com> Signed-off-by: Alexander Schwartz <aschwart@redhat.com> Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
63 lines
3.2 KiB
Plaintext
63 lines
3.2 KiB
Plaintext
// ------------------------ Breaking changes ------------------------ //
|
|
== Breaking changes
|
|
|
|
Breaking changes are identified as requiring changes from existing users to their configurations.
|
|
In minor or patch releases we will only do breaking changes to fix bugs.
|
|
|
|
=== <TODO>
|
|
|
|
// ------------------------ Notable changes ------------------------ //
|
|
== Notable changes
|
|
|
|
Notable changes where an internal behavior changed to prevent common misconfigurations, fix bugs or simplify running {project_name}.
|
|
|
|
=== Usage of the `exact` request parameter when searching users by attributes
|
|
|
|
If you are querying users by attributes through the User API where you want to fetch users that match a specific attribute key (regardless the value),
|
|
you should consider setting the `exact` request parameter to `false` when invoking the `+/admin/realms/{realm}/users+` using
|
|
the `GET` method.
|
|
|
|
For instance, searching for all users with the attribute `myattribute` set should be done as follows:
|
|
|
|
[source]
|
|
----
|
|
GET /admin/realms/{realm}/users?exact=false&q=myattribute:
|
|
----
|
|
|
|
The {project_name} Admin Client is also updated with a new method to search users by attribute using the `exact` request parameter.
|
|
|
|
=== Automatic database connection properties for the PostgreSQL driver
|
|
|
|
When running PostgreSQL reader and writer instances, {project_name} needs to always connect to the writer instance to do its work.
|
|
|
|
Starting with this release, and when using the original PostgreSQL driver, {project_name} sets the `targetServerType` property of the PostgreSQL JDBC driver to `primary` to ensure that it always connects to a writable primary instance and never connects to a secondary reader instance in failover or switchover scenarios.
|
|
|
|
You can override this behavior by setting your own value for `targetServerType` in the DB URL or additional properties.
|
|
|
|
=== JGroups system properties replaced with CLI options
|
|
|
|
Until now it was necessary to configure JGroups network addresses and ports using the `+jgroups.bind.*+` and `+jgroups.external_*+`
|
|
system properties. In this release we have introduced the following CLI options to allow these addresses and ports to be
|
|
configured directly via {project_name}: `cache-embedded-network-bind-address`, `cache-embedded-network-bind-port`,
|
|
`cache-embedded-network-external-address`, `cache-embedded-network-external-port`. Configuring ports using the old
|
|
properties will still function as before, but we recommend to change to the CLI options as this may change in the future.
|
|
|
|
// ------------------------ Deprecated features ------------------------ //
|
|
== Deprecated features
|
|
|
|
The following sections provide details on deprecated features.
|
|
|
|
=== Deprecated `displayTest` field in `ConsentScopeRepresentation`
|
|
|
|
The `displayTest` field in the `ConsentScopeRepresentation` class returned by the Account REST service has been deprecated due to a typo in its name.
|
|
A new field `displayText` with the correct spelling has been added to replace it. The old field will be removed in {project_name} 27.0.
|
|
The Typescript code `ConsentScopeRepresentation` for the Account Console already contains only the new field.
|
|
|
|
// ------------------------ Removed features ------------------------ //
|
|
== Removed features
|
|
|
|
The following features have been removed from this release.
|
|
|
|
=== <TODO>
|
|
|